-
Notifications
You must be signed in to change notification settings - Fork 19
Document the ingame debug commands #58
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
Document the ingame debug commands #58
Conversation
b7e7149
to
35cd870
Compare
I tried to come up with categories to split the commands into and put them into tabular format. If you like the format you can update the last 2 columns with accurate information and have them link to the respective videos Dev Command HotkeysThis section lists special hotkeys that are only enabled in developer builds of Generals and Zero Hour.
Cheat & Gameplay Hotkeys
Audio & Music Hotkeys
Rendering & Visual Debug Hotkeys
Camera Hotkeys
Benchmarking Hotkeys
Debug Hotkeys
Data Dump Hotkeys
Script Hotkeys
Miscellaneous/Other Hotkeys
|
SourceCode/Debug/files/ingame_debugs_media/debug_drawable_id_performance.mkv
Outdated
Show resolved
Hide resolved
The hotkey tables look useful. |
This looks really nice. I'm gonna see if I can incorporate it into my PR. Thanks! |
b30b75c
to
678bbcc
Compare
678bbcc
to
1ee94e7
Compare
3004665
to
5736977
Compare
5736977
to
416dc4c
Compare
@Jaredl-Code do you want a review from xezon or aliendroid as well, or are you happy as is? |
I wanted a review from xezon as he specifically requested having the in-game debugs documented. However, it can always be merged and updated if needed. I don't wish to take away time from him that he could be spending on the games source code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think how to use the hotkeys is common know for anyone who who'd consider using them but if you're going to including that section then it probably makes more sense for it to come before rather than after the commands
I think it's better to refer to them as dev commands and dev builds since we plan to decouple dev tools like these from code DEBUG only stuff
This is purely a subjective preference but I'd prefer if the tables were set to open so that the start out expanded but can be collapsed. Otherwise it gives the impression that the page is barren and not maintained even though it's got a lot of up to date information here
I put the how to guide at the end so it would be out of the way as much as possible but so people could at least glance at it since the categories are collapsed by default. I plan on updating them keeping up to date with what there gonna be called in the future. I'm just trying to be consistent with the codebase currently. For the tables, do you mean like the primary categories, or also the secondary? I feel like with markdown I'm very limited in terms of making it look good or organizing it, so I collapsed them by default so there out of the way. I actually think it would look good if there were no collapsible lists and you used the sidebar to jump between categories. |
This pull request adds a new page to the Wiki that extensively documents the in-game debug commands that are available in debug builds.
What's left to do still: