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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Added missing debug hotkeys #4068

Merged
merged 3 commits into from
Feb 14, 2025
Merged

[DOCS] Added missing debug hotkeys #4068

merged 3 commits into from
Feb 14, 2025

Conversation

MidyGamy
Copy link
Contributor

After checking the docs and MainMenuState.hx, I noticed only one of the 7 hotkeys is listed, so there is the list updated

@github-actions github-actions bot added size: small A small pull request with 10 or fewer changes. status: pending triage Awaiting review. pr: documentation PR modifies documentation or README files. and removed status: pending triage Awaiting review. size: small A small pull request with 10 or fewer changes. labels Jan 31, 2025
@AbnormalPoof AbnormalPoof added type: documentation Involves improvements or additions to documentation. status: pending triage Awaiting review. size: small A small pull request with 10 or fewer changes. labels Jan 31, 2025
Hundrec
Hundrec suggested changes Jan 31, 2025
View reviewed changes
Copy link
Collaborator

@Hundrec Hundrec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I edited a few things to make the formatting consistent!
Please also see DUMP SAVE DATA for my comment requesting more information.
(I personally don't know what dumping save data means)

docs/Funkin' Debug Hotkeys.md Outdated
@@ -29,3 +29,9 @@ Most of this functionality is only available on debug builds of the game!
## **Main Menu**
- `~`: ***DEBUG***: Opens a menu to access the Chart Editor and other work-in-progress editors. Rebindable in the options menu.
- `CTRL-ALT-SHIFT-W`: ***ALL ACCESS***: Unlocks all songs in Freeplay. Only available on debug builds.
- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Locks back songs in Freeplay (those unloked by default aren't locked. Only available on debug builds.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Locks back songs in Freeplay (those unloked by default aren't locked. Only available on debug builds.
- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Re-locks all songs in Freeplay except those unlocked by default. Only available on debug builds.

docs/Funkin' Debug Hotkeys.md Outdated
@@ -29,3 +29,9 @@ Most of this functionality is only available on debug builds of the game!
## **Main Menu**
- `~`: ***DEBUG***: Opens a menu to access the Chart Editor and other work-in-progress editors. Rebindable in the options menu.
- `CTRL-ALT-SHIFT-W`: ***ALL ACCESS***: Unlocks all songs in Freeplay. Only available on debug builds.
- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Locks back songs in Freeplay (those unloked by default aren't locked. Only available on debug builds.
- `CTRL-ALT-SHIFT-R`: ***GREAT SCORE?***: Give the user a hypothetical overridden score, and see if we can maintain that golden P rank. Only available on debug builds.
- `Ctrl-Alt-Shift-P`: ***Character Unlock screen***: Froce the character select screen to play Pico being unlocked. Only available on debug builds.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `Ctrl-Alt-Shift-P`: ***Character Unlock screen***: Froce the character select screen to play Pico being unlocked. Only available on debug builds.
- `CTRL-ALT-SHIFT-P`: ***CHARACTER UNLOCK SCREEN***: Forces the Character Select screen to play Pico's unlocking animation. Only available on debug builds.

docs/Funkin' Debug Hotkeys.md Outdated
- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Locks back songs in Freeplay (those unloked by default aren't locked. Only available on debug builds.
- `CTRL-ALT-SHIFT-R`: ***GREAT SCORE?***: Give the user a hypothetical overridden score, and see if we can maintain that golden P rank. Only available on debug builds.
- `Ctrl-Alt-Shift-P`: ***Character Unlock screen***: Froce the character select screen to play Pico being unlocked. Only available on debug builds.
- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds.
- `CTRL-ALT-SHIFT-N`: ***CHARACTER NOT SEEN***: Marks all characters as not seen and enables BF's new character unlocked animation in Freeplay. Only available on debug builds.

docs/Funkin' Debug Hotkeys.md Outdated
- `CTRL-ALT-SHIFT-R`: ***GREAT SCORE?***: Give the user a hypothetical overridden score, and see if we can maintain that golden P rank. Only available on debug builds.
- `Ctrl-Alt-Shift-P`: ***Character Unlock screen***: Froce the character select screen to play Pico being unlocked. Only available on debug builds.
- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds.
- `Ctrl-Alt-Shift-E`: ***Dump save data***: Self explainatory. Only available on debug builds.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `Ctrl-Alt-Shift-E`: ***Dump save data***: Self explainatory. Only available on debug builds.
- `CTRL-ALT-SHIFT-E`: ***DUMP SAVE DATA***: [This should be given an explanation]. Only available on debug builds.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the description to:

Prompts the user to save their save data as a JSON file, so its contents can be viewed.

docs/Funkin' Debug Hotkeys.md Outdated
- `Ctrl-Alt-Shift-P`: ***Character Unlock screen***: Froce the character select screen to play Pico being unlocked. Only available on debug builds.
- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds.
- `Ctrl-Alt-Shift-E`: ***Dump save data***: Self explainatory. Only available on debug builds.
- `Ctrl-Alt-Shift-L`: ***Force crash***: Force crash and create a log dump. Only available on debug builds.
Copy link
Collaborator

@Hundrec Hundrec Jan 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `Ctrl-Alt-Shift-L`: ***Force crash***: Force crash and create a log dump. Only available on debug builds.
- `CTRL-ALT-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace. Only available on debug builds.

NotHyper-474
NotHyper-474 reviewed Jan 31, 2025
View reviewed changes
docs/Funkin' Debug Hotkeys.md Outdated
- `Ctrl-Alt-Shift-P`: ***Character Unlock screen***: Froce the character select screen to play Pico being unlocked. Only available on debug builds.
- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds.
- `Ctrl-Alt-Shift-E`: ***Dump save data***: Self explainatory. Only available on debug builds.
- `Ctrl-Alt-Shift-L`: ***Force crash***: Force crash and create a log dump. Only available on debug builds.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is actually already documented at line 10, although the hot key is currently incorrect (missing the ALT key) which my PR #4010 corrects. But I wouldn't mind closing my PR and you including the correction in this one instead.

Copy link
Collaborator

@Hundrec Hundrec Jan 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just edited my suggestion comment to use your (Eric's) detailed wording.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well just checked, it only works on the main menu, not any state.

Copy link
Contributor

@NotHyper-474 NotHyper-474 Jan 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure? From my testing it works in pretty much any state.

Only available on debug builds.

It also works on Release so that's a bit misleading.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh my bad, it's only in the main menu for debug, works everywhere on released (why though? no idea...)

@Hundrec
Copy link
Collaborator

Hundrec commented Feb 1, 2025

If Force Crashing really is available in any state, Line 10 should be kept and the duplicate mention should be removed. Please also ensure that the information about debug builds is accurate!

@Hundrec Hundrec added status: needs revision Cannot be approved because it is awaiting some work by the contributor. and removed status: pending triage Awaiting review. labels Feb 1, 2025
@MidyGamy
Copy link
Contributor Author

MidyGamy commented Feb 1, 2025

Alright, done

@NotHyper-474 NotHyper-474 mentioned this pull request Feb 1, 2025
Closed
@Hundrec Hundrec added status: pending triage Awaiting review. and removed status: needs revision Cannot be approved because it is awaiting some work by the contributor. labels Feb 1, 2025
@EliteMasterEric EliteMasterEric merged commit 33f943a into FunkinCrew:main Feb 14, 2025
4 checks passed
@AbnormalPoof AbnormalPoof added status: accepted PR was approved for contribution. If it's not already merged, it may be merged on a private branch. and removed status: pending triage Awaiting review. labels Feb 14, 2025
@AbnormalPoof AbnormalPoof added this to the 0.6.0 (Pit Stop 2) milestone Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EliteMasterEric EliteMasterEric EliteMasterEric left review comments

@NotHyper-474 NotHyper-474 NotHyper-474 left review comments

@Hundrec Hundrec Hundrec requested changes

Assignees
No one assigned
Labels
pr: documentation PR modifies documentation or README files. size: small A small pull request with 10 or fewer changes. status: accepted PR was approved for contribution. If it's not already merged, it may be merged on a private branch. type: documentation Involves improvements or additions to documentation.
Projects
None yet
Milestone
0.6.0 (Pit Stop 2)
Development

Successfully merging this pull request may close these issues.
5 participants
@MidyGamy @Hundrec @EliteMasterEric @NotHyper-474 @AbnormalPoof