SUPPORT THE OFFICIAL RELEASE OF SONIC 1 & 2

December 6, 2021 ยท View on GitHub

Nintendo Switch

A Full Decompilation of Sonic 1 & 2 (2013). Ported to the Switch.

SUPPORT THE OFFICIAL RELEASE OF SONIC 1 & 2

Even if your platform isn't supported by the official releases, you must buy or officially download it for the assets (you don't need to run the official release, you just need the game assets)

If you want to transfer your save from the official mobile versions, the Android pre-forever file path is Android/data/com.sega.sonic1 or 2/SGame.bin (other versions may have different file paths). Copy that file to the SData.bin in the EXE folder.

Installation Instructions

You can find downloads in releases.

  1. Make sure your Switch can run homebrew.
  2. Extract the contents of the zip to the root of your SD card.
  3. Copy Data.rsdk to /switch/s12013 or /switch/s22013 on your Switch's SD card. You can get it from the "assets" folder of the APK. (Which you can open using 7-zip.)
    • If you find "Data.rsdk.xmf" instead, just rename it to "Data.rsdk".
  4. Start Sonic 1/2 via hbmenu (or whatever method you prefer).

NOTE: It is recommended to give the game full RAM access. This means you shouldn't launch hbmenu from the album applet when running this. With the latest Atmosphere build and its default config, you can hold R while starting any game to open hbmenu with full RAM access. If you have any issues make sure the game has full RAM access before reporting them; launching as an applet will not be supported.

Sections below are lifted directly from the source repository.

Additional Tweaks

  • Added a built in script compiler. Similar to the one found in RSDKv3, but tweaked up to match the new syntax for the scripts used in RSDKv4.
  • Added a built in mod loader and API allowing to easily create and play mods with features such as save file redirection, custom achievements and XML GameConfig data.
  • Custom menu and networking system for Sonic 2 multiplayer, allowing anyone to host and join servers and play 2P VS.
  • There is now a settings.ini file that the game uses to load all settings, similar to Sonic Mania.
  • Dev menu can now be accessed from anywhere by pressing the ESC key if enabled in the config.
  • The F12 pause, F11 step over & fast forward debug features from Sonic Mania have all been ported and are enabled if devMenu is enabled in the config.
  • If devMenu is enabled in the config, pressing F9 will visualize hitboxes, and F10 will activate a palette overlay that shows the game's 8 internal palettes in real time.
  • Added the idle screen dimming feature from Sonic Mania Plus, as well as allowing the user to disable it or set how long it takes for the screen to dim.

How to build

Windows

  • Clone the repo, then follow the instructions in the depencencies readme for Windows to setup dependencies, then build via the visual studio solution (or grab a prebuilt executable from the releases section.)

Windows via MSYS2 (64-bit Only)

Decompilation

  • Download the newest version of the MSYS2 installer from here and install it
  • Run the MINGW64 prompt (from the windows Start Menu/MSYS2 64-bit/MSYS2 MinGW 64-bit), when the program starts enter pacman -Syuu in the prompt and hit Enter
  • Press Y when it asks if you want to update packages. If it asks you to close the prompt, do so, then restart it and run the same command again. This updates the packages to their latest versions.
  • Install the dependencies with the following command: pacman -S pkg-config make git mingw-w64-i686-gcc mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2 mingw-w64-x86_64-libogg mingw-w64-x86_64-libvorbis mingw-w64-x86_64-glew mingw-w64-x86_64-tinyxml2 mingw-w64-x86_64-asio mingw-w64-x86_64-stb
  • Clone the repo with the following command: git clone https://github.com/Rubberduckycooly/Sonic-1-2-2013-Decompilation.git
  • Go into the repo you just cloned with cd Sonic-1-2-2013-Decompilation
  • Run make -f Makefile.msys2 CXX=x86_64-w64-mingw32-g++ CXXFLAGS=-static -j4
    • -j switch is optional, but will make building faster by running it parallel on multiple cores (8 cores would be -j9)

Server (Only required to host Sonic 2 multiplayer servers)

  • Go into the Server directory by running cd Server when in the root of the decompilation source folder
  • Run make -f Makefile.msys2 CXXFLAGS=-static -j4
    • -j switch is optional, but will make building faster by running it parallel on multiple cores (8 cores would be -j9)

Windows UWP (Phone, Xbox, etc.)

  • Clone the repo, then follow the instructions in the depencencies readme for Windows and depencencies readme for UWP to setup dependencies, copy your Data.rsdk folder into Sonic1Decomp.UWP or Sonic2Decomp.UWP depending on the game, then build and deploy via Sonic12Decomp.UWP.sln
  • You may also need to generate visual assets, to do so, open the Package.appxmanifest file in the designer, under the Visual Assets tab, select an image of your choice and click generate.

Linux

Decompilation

  • To setup your build enviroment and library dependecies run the following commands:
    • Ubuntu (Mint, Pop!_OS, etc...): sudo apt install build-essential git libsdl2-dev libvorbis-dev libogg-dev libglew-dev libasio-dev libtinyxml2-dev
      • If you're using Debian, add libgbm-dev and libdrm-dev
    • Fedora Linux: sudo rpm install g++ SDL2-devel libvorbis-devel libogg-devel glew-devel asio-devel tinyxml2-devel
    • Arch Linux: sudo pacman -S base-devel git sdl2 libvorbis libogg glew asio tinyxml2
  • Clone the repo with the following command: git clone https://github.com/Rubberduckycooly/Sonic-1-2-2013-Decompilation.git
  • Go into the repo you just cloned with cd Sonic-1-2-2013-Decompilation
  • Clone the stb-image repo with the following command: git clone https://github.com/nothings/stb.git ./dependencies/all/stb-image
  • Run make -j5
    • If your distro is using gcc 8.x.x, then add the argument LIBS=-lstdc++fs
    • -j switch is optional, but will make building faster by running it parallel on multiple cores (8 cores would be -j9)

Server (Only required to host Sonic 2 multiplayer servers)

  • Go into the Server directory by running cd Server when in the root of the decompilation source folder
  • Run make -j5
    • If your distro is using gcc 8.x.x, then add the argument LIBS=-lstdc++fs
    • -j switch is optional, but will make building faster by running it parallel on multiple cores (8 cores would be -j9)

Mac

  • Clone the repo, follow the instructions in the depencencies readme for Mac to setup dependencies, then build via the Xcode project.
  • A Mac build of v1.3.0 by Sappharad can be found here.

Android

  • Clone the repo, then follow the instructions in the depencencies readme for Android.
  • Ensure the symbolic links in android/app/jni are correct. If not, fix them with the following on Windows:
    • mklink /D src ..\..\..
    • mklink /D SDL ..\..\..\dependencies\android\SDL
  • Open android/ in Android Studio, install the NDK and everything else that it asks for, and build.

Unofficial Branches

Follow the installation instructions in the readme of each branch.

Because these branches are unofficial, we can't provide support for them and they may not be up-to-date.

Other Platforms

Currently the only supported platforms are the ones listed above, however the backend uses libogg, libvorbis & SDL2 to power it, so the codebase is very multiplatform. If you're able to, you can clone this repo and port it to a platform not on the list.

FAQ

Q: The screen is tearing, how do I fix it?

A: Try turning on VSync in settings.ini.

Q: I found a bug!

A: Submit an issue in the issues tab and we might fix it in the main branch. Don't expect any future releases, however.

Q: Will you do a decompilation for Sonic CD (2011)?

A: I already have! You can find it here.

Q: Will you do a decompilation for Sonic Mania?

A: No. Sonic Mania is much bigger and requires that I'd decompile not only how the (far more complex) RSDKv5 works, but also all 600+ objects work.

Special Thanks

  • Lulu for helping me fix bugs, tweaking up my sometimes sloppy code and generally being really helpful and fun to work with on this project
  • The Weigman for creating the header you see up here along with similar assets
  • Everyone in the Retro Engine Modding Server for being supportive of me and for giving me a place to show off these things that I've found

Contact:

Join the Retro Engine Modding Discord Server for any extra questions you may need to know about the decompilation or modding it.