Skip to content

Add more debug keybinds and slightly polish Debugging page #48

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

Open
MrOinky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add more debug keybinds and slightly polish Debugging page #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions app/wiki/debugging/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,46 +28,45 @@ Go to Kristal's options menu and head over to the Keyboard Controls. Scroll down

<>![image](/wiki/debug_controls.png)</>

These are the default binds for the other debug tools we'll be using.

Be mindful of the `` ` `` (backtick) some of these binds use. It looks close to an `` ' `` (apostrophe), even if it isn't. **Make sure not to mix them up!**
These are the keybinds for the debug tools we'll be using. Beware the backtick (`` ` ``) key in particular, as it can easily be mistaken for the apostrophe (`` ' ``). **Make sure not to mix them up!**
</Box>

<Box>
## Debug Hotkeys

Debug Hotkeys are fairly straightforward. Press some keys, and something happens.
That something is generally going to help your testing go faster, like giving full heals, TP restoration, or, quite literally, speeding up the game.
Debug Hotkeys are a quick and simple tool we can use to mess with the game state or toggle certain debugging features.

To use them, all we need to do is press some keys, and then something will happen.

Here's the full list of the debug keys and what they do:
These hotkeys are as follows:

- `Ctrl+R` quicksaves the game and then reloads your project. You'll load back to whatever world/map and state you were in previously.
- `Ctrl+Shift+R` reloads the game without quicksaving. You'll load in from when you last saved.
- `Ctrl+Alt+R` reloads the game from a new file.
- `Ctrl+Alt+Shift+R` hard resets the engine. Use this if any behaviour seems to unexpectedly persist between reloads.
- `Ctrl+M` pauses/resumes the in-game music.
- `Ctrl+N` toggles noclip.
- `Ctrl+G` (Fast Forward Keybind) toggles fast-forward.
- `Ctrl+H` heals your party to full.
- `Ctrl+K` fully restores TP.
- `Ctrl+B` kills you instantly.

These two hotkeys only have functionality in battle:
- `Ctrl+F` ends all active waves.
- `Ctrl+Y` wins the battle immediately.

These hotkeys use function keys - on some devices, you'll need to use `Ctrl` or `Fn` with these for Kristal to see the input.
- `Ctrl+I` grants you incvincibility.
- `Ctrl+F` ends all active waves. (Battle only)
- `Ctrl+Y` wins the battle immediately. (Battle only)
- `F2` toggles fast-forward.
- `F3` opens this website!
- `F4` enables fullscreen.
- `F6` enables Debug Rendering.

(On some devices, using the function (`F`) keys may also require pressing `Ctrl` or `Fn` to override other behaviour attached to them.)
</Box>

<Box>
## The Debug Menu

Here's where the fun part of Debugging begins!

Press `` Ctrl+` `` (or your Debug Menu keybind) to open up the debug menu. It should appear as an overlay on the game window:
Press the Debug Menu keybind (Defaults to `` Shift+` ``) to open the Debug Menu:

<>![image](/wiki/debug_menu.png)</>

Expand Down