The prerequisites you will need are having Xcode, the Xcode command line tools, Homebrew, and CMake. The command line tools can be installed by running xcode-select --install after installing Xcode itself, and CMake
can be installed through Homebrew by running brew install cmake.
Previously I had you clone Sappharad's fork of the Mania decompilation for you to do this. However, that hasn't been updated in a while, and I don't feel like bothering him enough to update it. Therefore, you can use my fork instead!
git clone --recursive https://github.com/MarioMastr/Sonic-Mania-Decompilation
There is currently a new version of the modding API being worked on, so if you are an aspiring modder and want to tinker around with them before they're ready, add -b modapi-v3 to the command before the --recursive.
The resulting folder will be found as Sonic-Mania-Decompilation in whatever working directory you were in when running the command.
Go into the RSDKv5 dependency ($(pwd)/Sonic-Mania-Decompilation/dependencies/RSDKv5).
Checkout the "improved" branch by using git checkout improved. If you want to use modapi-v3, you can merge that branch that into this one and fix the one conflict that is present. I will assume you can already use Git well enough to do that.
To choose between RSDK revisions, append -DRETRO_REVISION=*number* to the cmake -B build command below. A revision of 2 means you are building RSDKv5, the version used for Sonic Mania and the only choice if building Mania with ModAPI 3. A revision of 3, however, means you are building RSDKv5U, the version used for Sonic Origins.
Install libogg and libtheora through Homebrew.
brew install libogg theora
macOS has 4 subsystems to choose from: OGL, VK, SDL2, and SDL3. To use each one, run these following commands to install the necessary dependencies and append -DRETRO_SUBSYSTEM=*name* to the cmake -B build command below.
OGL: brew install glfw glew
VK: brew install glfw mesa
SDL2: brew install sdl2
SDL3: brew install sdl3
Run the command cmake -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo *appendings* && cmake --build build. The resulting app should be placed in build/dependencies/RSDKv5.
Create a folder somewhere where you can then copy the app into.
Obtain a Data.rsdk file of Sonic Mania Plus. I'm legally required to tell you that you should buy the game from Steam in order to access this. There's always Steam keys if you really want to save cash. Once you do, copy it into that folder.
Then simply run the app!
If you want mods, you need to:
- Run the app at least once.
- Open Settings.ini and add
devMenu=yto it under[Game]. - Create a folder named
mods. - Go here and download all the wonderful mods you want.
- Add them to the mods folder.
- Open the game again, press escape to open the Dev Menu, scroll down to Mods, and then enable all the mods you want.
Might I recommend also checking out my mod manager if you extra like mods? wink wink nudge nudge
If you want to run the other RSDK games, obtain their Data.rsdk files using Sonic Origins and then follow this handy-dandy tutorial by MegAmi which should get you up and running.
If you are experiencing any issues, comment on this gist and I'll try to get around to them when I can.
Excellent tutorial, thank you for making this!