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

Suggestion: "help" command redesign #461

Closed
lolbot-iichan opened this issue Dec 12, 2017 · 2 comments
Closed

Suggestion: "help" command redesign #461

lolbot-iichan opened this issue Dec 12, 2017 · 2 comments

Comments

@lolbot-iichan
Copy link

lolbot-iichan commented Dec 12, 2017

First thing you see in TIC-80 is message "type help for help". However, help message does not fit screen, as there is already too many commands to list both command names, args and descriptions. Commands are currently not sorted properly, some arguments are not documented and there is not enough space in one line to document them all for comands like "export" anyway. And user don't even realize that command window is scrollable and there is no way to scroll it with keyboard.

I suggest to completely change what help command is doing:

  1. "help" without arguments prints just a list of avaliable commands, several commands per line, and recomendation to start "surf" if user wants to go to GUI mode, press ESC to go to developer GUI mode, or continue learning about commands with "help " to learn more about given command. Basic help output should fit the screen and mention the fact that screen is scrollable with a mouse.

  2. "help " is like a man page. It contains information on possible arguments and interesting cases, like, when using "import" command with"map" argument, a file of size 32kb or smaller should be provided, and in later case extra bytes are zeroed. "help help" is a valid command as well.

@lolbot-iichan
Copy link
Author

  1. (Optional) In addition to commands, some other topics may be added for "help " command, like "help ram", "help metatags", "help hotkeys", etc. Even API functions may be documented with "help" command. If extra topics are added, "help" should list all those existing topics or mention about a way to collect a list (like "help commands" to get commands list, "help api" to get api functions list, "help help" to see other few topics).

@lolbot-iichan
Copy link
Author

Closed as duplicate, as optional part is similar to #154.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant