Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 3.18 KB

README.md

File metadata and controls

52 lines (38 loc) · 3.18 KB
Raw

header

A complete decompilation of Retro Engine v5 and v5Ultimate.

SUPPORT THE DEVELOPERS OF THE RETRO ENGINE

We do not own the Retro Engine in any way, shape or form, and this project would not have been possible had they not developed RSDKv5(U) in the first place. Retro Engine is currently owned by Evening Star; we highly urge you to follow & support their projects if you enjoyed this project of ours!

DO NOT USE THIS DECOMPILATION PROJECT AS A MEANS TO PIRATE SONIC MANIA OR ANY OTHER RSDKv5(U) GAMES.

We do not condone using this project as a means for piracy in any form. This project was made with love and care for the source material and was created for purely educational purposes.

Additional Tweaks

  • Added a built-in mod loader and API allowing to easily create and play mods with features such as save file redirection and XML asset loading, supported by all sub-versions of v5U.
  • Added a built-in shader compiler for backends/platforms that support it.
  • Added various other backends to windows aside from the usual DirectX 9 backends

How to Build

Get the source code

  • Clone the repo recursively, using: git clone --recursive https://github.com/Rubberduckycooly/RSDKv5-Decompilation.git or if you've already cloned the repo, run inside: git submodule update --init

Follow the build steps

Other Platforms

Currently, the only officially supported platforms are the ones listed above. However, the backend is very modular, so the codebase is very multiplatform.

However, since release, there have been a multitude of forks made by the community (keep in mind that many of these ports are still a WIP!:)

FAQ

You can find the FAQ here.

Special Thanks

  • st×tic for leading ModAPI development, porting to other platforms, general decompilation assistance, 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 making v5 and v5U assets with st×tic such as the header and icons
  • 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.