Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 5.12 KB

README.md

File metadata and controls

107 lines (68 loc) · 5.12 KB
Raw

Build Process

To build the project, ensure that all necessary project files are present in the repository. If you encounter the error MSB1009: Project file does not exist, verify the project file paths in the build scripts and ensure all required files are included.

Run the build command from the project's root directory.

Sonic RSDK + Oxygen Engine (Help Needed)

Aims to mix different Sonic the Hedgehog games into a single big game. Acts as a legal but cheaper version of Sonic Origins for fans that dont want to get scammed.

Sonic 1 in Sonic 2

How it's gonna work.

Instead of mixing 3 AIR'S Engine (called Oxygen) with the RSDK/Retro engine, or compiling rsdk and 3 air as seperate EXEs to be laucnhed in one window which is what this project gets confused as, the project will have 3 (main) working parts:

Sonic 3 AIR/Oxygen.

Sonic Hybrid RSDK plus RSDKV4/RSDKV3 (and maybe RSDKV5U).

And a custom script runner/executor.

When sonic 2 ends the Hybrid RSDK entity will send a message to the custom script executing entity which in turn stops running the RSDK stuff & starts running the main script of 3 air

Completion Status:

Hybrid-RSDK Debugging/Additons ?% (Hybrid-RSDK is still broken)

Sonic 3 AIR (Oxygen) Integration 50% (All the source code is in the repo, but we havent done the neccessary changes yet) Integration with Hybrid RSDK is in progress, focusing on resolving loading issues and graphical corruption.

Custom Client 0% (debugging Hybrid RSDK is the priority)

WARNING: DOES NOT WORK YET!

Start from here:

This guide is useful if you never downloaded the project or if you want to start from scratch.

  1. Download the latest release

  2. Unpack the zip file

  3. Paste in the directory rsdk-source-data the following files:

    • Data.rsdk from Sonic CD as soniccd.rsdk
    • Data.rsdk from Sonic 1 as sonic1.rsdk
    • Data.rsdk from Sonic 2 as sonic2.rsdk
    • Rom.bin from Sonic 3&K as sonic3.bin (I doubt this will be addable as Sonic 3 is a ROM unlike the rest which is a RSDK)

  4. Install .NET 6

  5. Open a terminal and run the command dotnet run --project SonicHybridRsdk.Build

  6. Put the RSDKv4 engine in the sonic-hybrid folder (still havent decided)

  7. Compile/run the executable and have fun!

Perform an update

This guide is useful if you previously played Sonic Hybrid but you want to perform an update. Please look at the commit list to know more info about the changelog through each update.

  1. Download the latest release

  2. Unpack the zip file and overwrite all the existing files

  3. Open a terminal and run the command dotnet run --project SonicHybridRsdk.Build

  4. Run the executable and have fun!

Features

  • Play Sonic 1, Sonic CD, Sonic 2 and Sonic 3&k a single big game.
  • Star Posts in Sonic the Hedgehog 1 and CD will bring you to the Sonic the Hedgehog 2 special stages.
  • Completing Sonic the Hedgehog 1's Final Zone will bring you to Palmtree Panic Zone.
  • Completing Sonic the Hedgehog CD's Metallic Madness Act 3 will bring you to Emerald Hill Zone.
  • Completing Death Egg Zone in Sonic the Hedgehog 2 will bring you to Angel Island Zone.
  • The Stage Select in the debug menu will report all the implemented level names.
  • Sonic CD stages correctly transitions as the original game.
  • Metal Sonic is now a playable character.
  • Sonic 3 will be included.

Known issues

  • It runs, but when you load a level it only loads the background
  • No Sonic 3 yet.
  • Sonic 1 Special Stages are working from the Stage Select, but the graphics is corrupted.
  • The main menu of RSDK will report the wrong stage names.
  • The Giant Ring from Sonic the Hedgehog 1 will teleport to the Sonic the Hedgehog 2 special stages.
  • Collision Chaos and Stardust Speedway are half-implemented.
  • Tidal Tempest, Quartz Quadrant, Wacky Workbench and Metallic Madness are barely implemented.
  • In Palmtree Panic Zone, the spinner will softlock the player.
  • Some Sonic CD's enemies and gimmicks might have the wrong palette.
  • Playable Metal Sonic has a "rolling" bugging collision.

Resources

Xeeynamo has written some notes on how to convert RSDKv3 scripts to RSDKv4 scripts without modifying the RSDKv4 engine.

Everything contained in rsdk/Scripts is a modified version of Rubberduckycooly's Sonic 1/2 script decompilation. This project would not exist without it.

The function SonicHybridRsdk.Unpack12/DecryptData was written by Giuseppe Gatta (nextvolume) from its Retrun.

Credits

  • Decompilation by Rubberduckycooly.
  • Hybrid-RSDK by Xeeynamo.
  • Sonic 3 AIR by Eukaryot.
  • Conceived by Chaphidoesstuff aka @CCIGAMES.
  • Main Development By Pixel-1 Games, SomeRandomPerson_, twanvanb1, FGSOFTWARE1 and more.