Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Web based debug interface #493

Closed
TristanCacqueray opened this issue Jun 26, 2022 · 4 comments
Closed

Web based debug interface #493

TristanCacqueray opened this issue Jun 26, 2022 · 4 comments
Labels
S-Moderate The fix or feature would substantially improve user experience. T-Web Involves the web interface - generally communicating with Swarm via ports. Z-Feature A new feature to be added to the game.

Comments

@TristanCacqueray
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
Being able to debug complex issue, such as the one described in #490 might become tricky to do with the ncurses based interface.

Describe the solution you'd like
The game starts a wai application that can be used to query the current game state. Initially the interface provides a simple /export endpoint to dump the state. But the interface could also serve a little web ui to display the state through a web browser.

Describe alternatives you've considered
With #50, we might be able to inspect the save file for debug purpose too. Though the web service might be more convenient to debug live situations.

Additional context
The web service could also receive REPL commands so that the IDE could directly interact with the game, without having to switch focus and use the run command.

It also open the possibility of a new web base interface for the game. Though that is a subject for another discussion, the purpose of this issue is purely for adding a debug capability.

@TristanCacqueray TristanCacqueray added Z-Feature A new feature to be added to the game. S-Nice to have The bug fix or feature would be nice but doesn't currently have much negative impact. S-Moderate The fix or feature would substantially improve user experience. labels Jun 26, 2022
@TristanCacqueray
Copy link
Collaborator Author

Note that we can mostly avoid adding javascript and html to the project by using lucid and htmx.

@xsebek
Copy link
Member

xsebek commented Jun 26, 2022

Another great improvement from separating UI and state would be the possibility to open game windows (entity description, goal, robot list,...) in a separate terminal. I think that Dwarf fortress has something like that.

Once the TUI application can communicate with a separate state-holding application you almost have a multiplayer game! 🚀

@xsebek xsebek removed the S-Nice to have The bug fix or feature would be nice but doesn't currently have much negative impact. label Sep 12, 2022
@byorgey byorgey added the T-Web Involves the web interface - generally communicating with Swarm via ports. label Oct 1, 2022
@byorgey
Copy link
Member

byorgey commented Feb 24, 2023

So we definitely have a very simple version of this now. I'm wondering what other features people want in this vein, or if we can close this issue.

@byorgey
Copy link
Member

byorgey commented Jan 12, 2024

I think I'm going to close this issue now, since we do indeed have a simple web debugging interface, with new features being added to it regularly. If there are specific features anyone would like to see added to the web UI we can of course open specific issues to track those features.

@byorgey byorgey closed this as completed Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-Moderate The fix or feature would substantially improve user experience. T-Web Involves the web interface - generally communicating with Swarm via ports. Z-Feature A new feature to be added to the game.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants