Skip to content

Commit

Permalink
Add RSDKv4 Dev Menu screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
MegAmi24 committed Sep 21, 2024
1 parent d3799eb commit d0a5d17
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 12 deletions.
16 changes: 8 additions & 8 deletions docs/Guides/RSDKv5/Decompilation/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,14 +203,14 @@ git submodule update --init --recursive
| **VK** | Vulkan |

### Sonic Mania
| Flag | Description | Value Type | Default Value |
| ----------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ----------------------------------------------------------------- |
| **WITH_RSDK** | Builds RSDKv5 alongside Sonic Mania. | Boolean | `on` |
| **GAME_STATIC** | Builds both RSDKv5 and Sonic Mania into one executable. Has no effect if `WITH_RSDK` is disabled. | Boolean | `off` on Windows or Unix-based platforms, `on` on other platforms |
| **MANIA_FIRST_RELEASE** | Builds the initial console release of Sonic Mania. | Boolean | `off` |
| **MANIA_PRE_PLUS** | Builds the last release of Sonic Mania before the Plus update. | Boolean | `off` |
| **GAME_INCLUDE_EDITOR** | Includes code for use in editors such as [RetroED](/Tools/RetroED/README.md). | Boolean | `on` |
| **GAME_VERSION** | The version of the game to build. Has no effect if `MANIA_FIRST_RELEASE` or `MANIA_PRE_PLUS` are enabled. | Integer (See [Game Versions](#game-versions)) | `6` |
| Flag | Description | Value Type | Default Value |
| ----------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -------------------------------------------------- |
| **WITH_RSDK** | Builds RSDKv5 alongside Sonic Mania. | Boolean | `on` |
| **GAME_STATIC** | Builds both RSDKv5 and Sonic Mania into one executable. Has no effect if `WITH_RSDK` is disabled. | Boolean | `off` on Windows or Linux, `on` on other platforms |
| **MANIA_FIRST_RELEASE** | Builds the initial console release of Sonic Mania. | Boolean | `off` |
| **MANIA_PRE_PLUS** | Builds the last release of Sonic Mania before the Plus update. | Boolean | `off` |
| **GAME_INCLUDE_EDITOR** | Includes code for use in editors such as [RetroED](/Tools/RetroED/README.md). | Boolean | `on` |
| **GAME_VERSION** | The version of the game to build. Has no effect if `MANIA_FIRST_RELEASE` or `MANIA_PRE_PLUS` are enabled. | Integer (See [Game Versions](#game-versions)) | `6` |

#### Game Versions
| Flag Value | Game Version |
Expand Down
2 changes: 1 addition & 1 deletion docs/RSDKv3/Overview/DevMenu.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The Dev Menu is a debug menu included with [RSDKv3](../README.md), disabled by d
| ++f1++ | Loads the first scene in the Presentation stage list. |
| ++f2++ | Loads the previous scene in the scene list. If pressed in the first scene, it will load the last one. |
| ++f3++ | Loads the next scene in the scene list. If pressed in the last scene, it will load the first one. |
| ++f5++ | Reloads the current scene. Holding ++control++ while pressing this will also reload all active mods. |
| ++f5++ | Reloads the current scene. |
| ++f8++ | Toggles visualizing active touchscreen hitboxes. |
| ++f9++ | Toggles visualizing active hitboxes. |
| ++f10++ | Toggles displaying the currently loaded palettes. |
Expand Down
5 changes: 2 additions & 3 deletions docs/RSDKv4/Overview/DevMenu.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Dev Menu

![Dev Menu](/assets/images/SonicMania/DevMenu/MainMenu.png){ align=right , width="50%" }
![Dev Menu](/assets/images/Sonic1/DevMenu/MainMenu-Mobile.png){ align=right , width="30%" }

The Dev Menu is a debug menu included with [RSDKv4](../README.md), disabled by default. The menu includes several features useful for debugging games in the engine.
TODO: Get a proper screenshot, preferably from an official build if possible

## Enabling
The Dev Menu is normally inaccessible, however in the [RSDKv4 Decompilation](../Decompilation.md), it can be enabled by setting `DevMenu` to `true` in the settings.ini file, like so:
Expand Down Expand Up @@ -36,7 +35,7 @@ TxtScripts=false
| ++f1++ | Loads the first scene in the Presentation stage list. |
| ++f2++ | Loads the previous scene in the scene list. If pressed in the first scene, it will load the last one. |
| ++f3++ | Loads the next scene in the scene list. If pressed in the last scene, it will load the first one. |
| ++f5++ | Reloads the current scene. Holding ++control++ while pressing this will also reload all active mods. |
| ++f5++ | Reloads the current scene. |
| ++f8++ | Toggles visualizing active touchscreen hitboxes. |
| ++f9++ | Toggles visualizing active hitboxes. |
| ++f10++ | Toggles displaying the currently loaded palettes. |
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d0a5d17

Please sign in to comment.