Sonic Mania Decompilation
Source code reconstructed from the original game's compiled binary, so the game can be understood, rebuilt and ported.
Based on Sonic Mania
compare all 2 clones
Original game imageAbout
A decompilation of Sonic Mania (Plus) that can be built for the RSDKv5 or RSDKv5U engine. Without assets from the official releases, the decompilation will not run, and the README says you must buy the game for its assets even if your platform has no official release. The Netflix Games version is not supported. It would not exist without the work of Sega, Headcannon and Evening Star.
How it differs from the original
Adds a built-in mod loader and API calls for modding, support for targeting RSDKv5U rather than standalone RSDKv5, and support for building almost all released versions: 1.00 (console initial release), 1.03 (PC initial release) and 1.06 (Plus update). Bugs that exist in official releases will most likely not be fixed here.
Getting started
Clone the repository recursively with Git rather than downloading the ZIP, since the submodules are required. Then run cmake -B build and cmake --build build --config release. To transfer a save from the official PC versions, copy the save data into the folder containing the decompilation.
Known issues & limitations
- Bugs present in official releases will most likely not be fixed in this project.
What you need to run it
Features
- The project includes a built-in mod loader and API calls for modding.
- You can transfer savedata from the official PC versions by copying it into the project folder.
Summarised from the project's README.
Additional notes
- Faq other decomps
- The author says Sonic CD and Sonic 1/2 decompilations already exist as separate projects, and that no further decompilations are planned.
- Gl shaders
- Videos and filters under GL need a separate GLShaders mod, with setup steps given in the FAQ.
FAQ
- What is Sonic Mania Decompilation?
- Sonic Mania Decompilation is an open-source decompilation of Sonic Mania. Source code reconstructed from the original game's compiled binary, so the game can be understood, rebuilt and ported.
- Do I need the original game files to run Sonic Mania Decompilation?
- Yes. The project does not include the original game's assets, so you need your own copy.
- I found a bug!
- Submit an issue in the Issues tab; the project might look into it. Bugs in official releases will most likely not be fixed here.
More like Sonic Mania Decompilation
Original game image