Skip to content

ultra0000/RSDKv5-Decompilation

 
 

Repository files navigation

About this fork

This fork contains a PlayStation 3 port of the game. To compile it, you need ps3toolchain and the SDL2 port. Once you're done installing them, go to RSDKv5.ps3, export PKG_CONFIG_PATH to /usr/local/ps3dev/portlibs/ppu/lib/pkgconfig/ and run the Makefile. After you're done compiling it, put the game data in a folder called SonicMania on a USB drive (At the moment I can't get a normal Data.rsdk file to work so you'll have to extract it to a folder simply called Data), then plug it in to your PS3's right USB port. If you have more than 2 USB ports, I do not know which one is dev_usb000 so you'll have to look in MultiMan which one is it. Speaking of MultiMan, you might want to use it to run the .self executable.

TODOs

  • Make Data.rsdk files actually work instead of having to extract them manually.
  • Fix audio so that it doesn't break your ears.
  • Properly fix input, it currently uses a workaround.
  • Try to get better performance on special stages.
  • Make the game not crash the console when quitting out.
  • For some reason, the game starts to lag really badly after running for a while. FIXED.

Original README below.

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

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

A: Try turning on VSync in settings.ini.

Q: I found a bug/I have a feature request!

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

Q: Is there a decompilation for RSDKv3 and/or RSDKv4 alone?

A: There is! You can find RSDKv3 here and RSDKv4 here.

Q: Are there anymore decompilation projects in the works, such as other RSDK versions?

A: Absolutely not. This project took about 1 and a half years to do, and between the last two and this one, we're done with decompiling, at least for the time being. Please do not expect any more decompilations from us, Sonic or otherwise!

Special Thanks

  • Chuli 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 creating the asset bases such as the header and icons (originally made for RSDKv3 and v4, modified by Chuli)
  • 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.

About

A complete decompilation of Retro Engine (v5)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 95.9%
  • HLSL 1.3%
  • Java 1.1%
  • GLSL 1.0%
  • Makefile 0.6%
  • CMake 0.1%