Setting Up the RSDKv4 Decompilation¶

Prerequisites¶

A build of the RSDKv4 Decompilation for the target platform. You can get one by:
- Building the source code (Recommended)
- Downloading the latest release (Origins Plus DLC will not be accessible)
- Downloading an autobuild (Must be signed into GitHub to download, Origins Plus DLC will not be accessible)
A datapack (Data.rsdk) for Sonic 1 or 2
Visual C++ Redistributables (Windows only)

Setup¶

WindowsLinuxAndroid

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 a Windows user directory. This includes folders such as Documents, Downloads, and the Desktop. These directories are known to cause issues with the decomp, such as crashes or mods not working. It's recommended to instead place the decomp somewhere in a Games folder located in the root of C drive, or another drive entirely if possible.

Place the Data.rsdk file in this directory.

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.

The player character softlocks or dies at the end of certain acts¶

Sonic 1 and 2 weren't fully optimized for ultrawide, so issues like these will occur. You can install the decompiled scripts to fix this.

Pausing is mapped to B instead of Start when using the mobile versions¶

This is an intentional change (made for unknown reasons) in the mobile versions of the games. You can install the decompiled scripts to fix this.

Life counter defaults to 1 instead of 3 when using the mobile versions¶

This is an intentional change made in the mobile versions of the games. You can install the decompiled scripts to fix this in most cases.

Various issues related to using the Origins versions¶

See this guide for fixing several Origins related issues.