SUPPORT THE OFFICIAL RELEASE OF SONIC 1 & 2

• Without assets from the official releases, this decompilation will not run.

• For tutorials on how to find the game assets from your legally obtained copy of the game(s), see either one of these tutorials for Android, or this tutorial for iOS.

• You can get the official releases of Sonic 1 & Sonic 2 from:

  • Sonic 1 (iOS, Via the App Store)
  • Sonic 2 (iOS, Via the App Store)
  • Sonic 1 (Android, Via Google Play)
  • Sonic 2 (Android, Via Google Play)
  • Sonic 1 (Android, Via Amazon)
  • Sonic 2 (Android, Via Amazon)

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(s) from the official mobile version(s), 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 into the decompilation's folder with the name SData.bin.

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.
• The 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.
• A number of additional dev menu debug features have been added:
  • F1 will load the first scene in the Presentation stage list (usually the title screen).
  • F2 and F3 will load the previous and next scene in the current stage list.
  • F5 will reload the current scene, as well as all assets and scripts.
  • F8 and F9 will visualize touch screen and object hitboxes.
  • 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

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 libtheora-dev
    • If you're using Debian, add libgbm-dev and libdrm-dev.
  • Arch Linux: sudo pacman -S base-devel git sdl2 libvorbis libogg glew libtheora
  • Clone the repo and its other dependencies with the following command: git clone --recursive https://github.com/c0des1ayr/RSDKvForever-1.3.git
  • Go into the repo you just cloned with cd RSDKvForever-1.3.
  • 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

The multiplayer server requires Python 3.8 or later. You can download Python here. To use the server, open Command Prompt in the folder Server.py is located in, then run the command py -3 Server.py [local IPv4 address] [port] debug. You can find your local IPv4 address using the command ipconfig.

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 I might fix it in the main branch. Don't expect any future releases, however.

Contact:

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