Setting Up the RSDKv5 & Sonic Mania Decompilations

Prerequisites

• A build of the RSDKv5 Decompilation for the target platform. You can get one by:
  • Building the source code (Recommended)
  • Downloading the latest release (Mania/Origins Plus DLC will not be accessible)
  • Downloading an autobuild (Must be signed into GitHub to download, Mania/Origins Plus DLC will not be accessible)
• A build of the Sonic Mania Decompilation for the target platform. You can get one by:
  • Building the source code (Recommended)
  • Downloading the latest release
  • Downloading an autobuild (Must be signed into GitHub to download)
• A datapack (Data.rsdk) for Sonic Mania
  • The decompilations are not compatible with datapacks from the Netflix Games releases of the game.
• Visual C++ Redistributables (Windows only)

Setup

WindowsLinuxNintendo SwitchAndroid

Tip

It's highly recommended to enable file extensions in File Explorer to reduce the chance of a file being named incorrectly.

Place the decompilation EXE file (and any included DLL files) in the target directory.

Warning

DO NOT place the decompilation in the directory of an official Mania release. Doing this is known to cause issues.

Place the Data.rsdk and Game.dll files in this directory.

Tip

If you're not using either DirectX subsystem, it's highly recommended to install the custom shaders mod.

TODO

TODO

TODO

Troubleshooting

The game runs faster than it's supposed to

All of the Retro Engine's logic is tied to the framerate, meaning that the speed of the game will be faster or slower depending on your device/monitor's refresh rate. You can fix this by turning off V-Sync in settings.ini or by changing your device's refresh rate, if possible.

Non-Xbox controllers not working on Windows

By default, Windows builds of the decompilation use DirectX 9, which only supports XInput controllers (i.e. Xbox controllers). To use other types of controllers, you will need to build the decompilation with the OpenGL backend by setting the RETRO_SUBSYSTEM build flag to OGL. It's also recommended to download a gamecontrollerdb.txt file and place it next to the executable file.

Various issues related to using the Origins games

See this guide for fixing several Origins related issues.

FAQ

What's the difference between RSDKv5 and RSDKv5U?

RSDKv5U adds compatibility for playing RSDKv3 (i.e. Sonic CD) and RSDKv4 (i.e. Sonic 1 & 2) games, including support for local multiplayer. The v5 side of the engine also recieves minor changes, such as altered collision and additional functionality.

How do I change the username?

In the Game category of settings.ini, add a tag called username and enter the desired username in it, like so:

; Retro Engine Config File

[Game]
username=MyUsername ; (1)!
language=0

...

1. The setting names in settings.ini are case-sensitive; the username setting will not apply if the capitalization is incorrect.