From 4eed8569b34f9dab2cd5ac7f36b2f07fda360224 Mon Sep 17 00:00:00 2001 From: PkR Date: Tue, 26 Oct 2021 21:45:33 +0900 Subject: [PATCH 1/2] Update README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b8a4144..617812b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # SADX Debug Mode by PkR -Debug Mode is a mod for Sonic Adventure DX PC (2004) that displays various debug information on screen. +Debug Mode is a mod for Sonic Adventure DX PC (2004) that adds various debug features to the game. **Using the mod** 1) Press the Z button on the controller or the B key on the keyboard to toggle between different debug information screens. Alternatively, press 1-9 on the keyboard to show a specific screen. -2) If you press the Z button (or the B key on the keyboard) while also holding the A button (or its keyboard counterpart), vanilla debug mode will be enabled. To disable it, press the same button/key combination again. +2) If you press the Z button on the controller (or the B key on the keyboard) while also holding the A button (or its keyboard counterpart - X key by default), vanilla debug mode will be enabled. To disable it, press the same button/key combination again. 3) Press P on the keyboard to enable Crash Log. This will log each texture list and object code change to the SADX Mod Loader log/console. 4) Press Pause/Break on the keyboard the freeze and unfreeze the game. Press Insert to advance one frame forward. 5) In the Sound Queue screen, press H on the keyboard to toggle between decimal, hexadecimal and soundbank representations of sound IDs. In the LS Palette and Stage Lights screens, press H on the keyboard to toggle between multiple LS Palette Data and Stage Light Data entries for the current stage. @@ -32,18 +32,19 @@ When the free camera mode is enabled, you can use the mouse to move the camera a This is SADX' built-in debug mode (what's left of it). Collision objects are visible in this mode. When this mode is enabled, you can move the character freely through any obstacles. Use the analog stick to position the character on the X and Z plane. Hold the X button to move the character up and down. -Notes: -1) Vanilla debug mode is unavailable for Gamma. -2) For Tails and Big it will display collision objects but free movement will not be available. -3) The information in LS Palette and Stage Lights screens is irrelevant when using Lantern Engine. -4) Some transparent objects may flicker when using frame advance. -5) Some debug text may not display properly when using frame advance. -6) Pressing (as opposed to holding) buttons may not work correctly when using freeze frame/frame advance. +**Notes and known issues** +1) The information in LS Palette and Stage Lights screens is irrelevant when using Lantern Engine. +2) Some transparent objects may flicker when using frame advance. +3) Some debug text may not display properly when using frame advance. +4) Pressing (as opposed to holding) buttons may not work correctly when using freeze frame/frame advance. +5) The speed hack may not always work reliably, especially in cutscenes. **Credits** [Speeps](https://twitter.com/SPEEPSHighway) for providing the original free camera code that was adapted for this mod +[Sora](https://github.com/Sora-yx) for reimplementing vanilla Debug Mode for Tails, Big and Gamma + **Related mods/tools** SADX Mod Installer: https://sadxmodinstaller.unreliable.network From 75fb1ee850bd206efcdfbc097b50012686f24ab6 Mon Sep 17 00:00:00 2001 From: PkR Date: Fri, 5 Nov 2021 12:51:53 +0900 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 617812b..4630484 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Debug Mode is a mod for Sonic Adventure DX PC (2004) that adds various debug fea 2) If you press the Z button on the controller (or the B key on the keyboard) while also holding the A button (or its keyboard counterpart - X key by default), vanilla debug mode will be enabled. To disable it, press the same button/key combination again. 3) Press P on the keyboard to enable Crash Log. This will log each texture list and object code change to the SADX Mod Loader log/console. 4) Press Pause/Break on the keyboard the freeze and unfreeze the game. Press Insert to advance one frame forward. -5) In the Sound Queue screen, press H on the keyboard to toggle between decimal, hexadecimal and soundbank representations of sound IDs. In the LS Palette and Stage Lights screens, press H on the keyboard to toggle between multiple LS Palette Data and Stage Light Data entries for the current stage. +5) In the Player and Camera screens, press H on the keyboard to display angles as hexadecimal values. In the Sound Queue screen, press H on the keyboard to toggle between decimal, hexadecimal and soundbank representations of sound IDs. In the LS Palette and Stage Lights screens, press H on the keyboard to toggle between multiple LS Palette Data and Stage Light Data entries for the current stage. 6) Press the C button on the controller or the C key on the keyboard to enable or disable collision data display. 7) Press T to toggle textures. 8) Press F to toggle fog.