Skip to content

Building the RSDKv2 Decompilation

The RSDKv2 Decompilation uses CMake, a versatile building system that supports many different compilers and platforms

Read before proceeding

This guide requires basic knowledge of how to use the appropriate terminal for your OS, such as Command Prompt for Windows. If you aren't familiar with doing basic actions with terminals, such as opening one in specific directories, look up a tutorial online.

In addition, refer to these warnings depending on the platform you are compiling for:

Warning

Make sure to use Command Prompt when typing commands instead of PowerShell, as PowerShell is known to cause issues.

Notice for Steam Deck users

Due to how SteamOS handles packages, building the decompilation on the Steam Deck is highly difficult and not recommended. Instead, consider building it on another Arch Linux device and using that build on the Steam Deck.

Get the source code

DO NOT download the source code ZIP archive from GitHub, as issues may occur while building with it.

Instead, you will need to clone the repository using Git, which you can get here.

Clone the repo by running this command in the target directory:

git clone https://github.com/RSDKModding/RSDKv2-Decompilation

Warning

DO NOT clone the repository in a Windows user directory. This includes folders such as Documents, Downloads, and the Desktop. These directories are known to cause issues when building. It's recommended to instead clone the repo somewhere in a GitHub folder located in the root of the C drive, or another drive entirely if possible.

If you'd ever like to update the cloned repository, you can do so by running this command in it:

git pull

Getting dependencies

Install CMake. Make sure to enable the feature to add CMake to the system PATH during the installation.

To handle dependencies, you'll need to install Visual Studio Community with the Desktop development with C++ workload. If you already have Visual Studio installed, you can manage your installed workloads by opening Visual Studio Installer from the Start Menu and clicking the Modify button next to your Visual Studio installation.

Warning

An installation of Visual Studio with the Desktop development with C++ workload uses around 8 GB of storage space. Make sure you have the necessary space on your drive before proceeding.

You will also need to set up vcpkg. You only need to follow 1 - Set up vcpkg in the guide.

Tip

It's recommended to clone vcpkg into a short path such as C:/src to avoid potential file path issues.

Run the following command in the vcpkg repository:

vcpkg.exe install sdl2 libogg libvorbis --triplet=x64-windows-static
vcpkg.exe install sdl2 libogg libvorbis --triplet=x86-windows-static

Then, add vcpkg to your environment variables by running the following commands in the vcpkg repository:

set VCPKG_ROOT="%CD%"
setx VCPKG_ROOT %VCPKG_ROOT%

Run the following command in the terminal:

sudo pacman -S base-devel cmake sdl2 libogg libvorbis
sudo apt install build-essential cmake libsdl2-dev libogg-dev libvorbis-dev
sudo dnf install gcc cmake SDL2-devel libogg-devel libvorbis-devel zlib-devel
sudo apk add build-base cmake sdl2-dev libogg-dev libvorbis-dev
sudo xbps-install make cmake pkg-config SDL2-devel libogg-devel libvorbis-devel zlib-devel

Compiling

Enter the following commands in the RSDKv2 decompilation repository directory:

cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE="%VCPKG_ROOT%/scripts/buildsystems/vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x64-windows-static -DCMAKE_PREFIX_PATH="%VCPKG_ROOT%/installed/x64-windows-static/"
cmake --build build --config release
cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE="%VCPKG_ROOT%/scripts/buildsystems/vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x86-windows-static -DCMAKE_PREFIX_PATH="%VCPKG_ROOT%/installed/x86-windows-static/" -A Win32
cmake --build build --config release

The resulting build will be located somewhere in build/ depending on your system.

You can set build flags by adding -D[flag-name]=[value] to the end of the first command.

Enter the following commands in the RSDKv2 decompilation repository directory:

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config release

The resulting build will be located somewhere in build/ depending on your system.

You can set build flags by adding -D[flag-name]=[value] to the end of the first command.

Build Flags

Warning

These build flags modify certain aspects of the decomp; only use these if you know what you're doing!

Flag Description Value Type Default Value
FORCE_CASE_INSENSITIVE Forces case insensivity when loading files. Boolean off
RETRO_MOD_LOADER Enables the ability the load mods and certain features related to them. Boolean on
RETRO_SDL_VERSION Switches between using SDL 1.2 or SDL 2. Integer 2