README.md

About

Orbinaut Framework is a classic Sonic framework created for GameMaker. Built entirely from scratch, it is designed with extreme accuracy in mind, replicating the original games’ core logic and gameplay loop. The project is aimed at developers with prior GameMaker experience and is not intended as an entry-level tool for beginners

Although primarily designed for creating classic Sonic games, it is also suitable for entirely original projects

Orbinaut Framework is intended to work with the latest LTS (Long-Term Stable) release of GameMaker. Compatibility with other versions is neither supported nor guaranteed

Sonic Features

• All gameplay objects in the framework provided by default are accurate to their Sonic 2 presentation, both code and animation-wise
• Character physics, character-to-object, and object-to-terrain collisions are faithfully recreated, delivering behaviour identical to the original games, making OF one of the most accurate classic Sonic frameworks ever made
• Four playable characters: Sonic, Tails, Knuckles, and Amy (with her Origins abilities)
• Support for multiple player objects, which can be set up to be controlled by either a CPU or a real person
• Up to 8 player splitscreen support (separate screens for CPUs that can be taken under control)
• The ability to customise gameplay by toggling various differences between the four classic titles
• The framework offers various graphical effects you can see in the classic games, including layer deformation and palette-based fade in/out

Documentation

Documentation, answers to frequently asked questions and initial framework setup are available on the Wiki

Updates & Support

The framework is complete, with all features working as intended and ready for use. Small updates may occasionally be pushed to the repository to address minor oversights, bugs, inconsistencies, and other issues discovered over time. If you have any questions about the framework, feel free to use the Discussions tab. Please, do not use it for bug reports

Terms of Use

• For fangames: non-profitable, as always
• For original IPs: MIT License

Please credit us as Team Orbinaut

Even though the license does not prohibit it, we'd like to ask that you do not distribute modified versions of the framework. Thank you!

Credits

• Project Leads: Triangly, Michael Gallinago
• Programming: Triangly, Michael Gallinago, techncolour
• Boss Design & Programming: techncolour
• Branding & Sprite Editing: Natufox
• Trailer Production: Lapper
• Tech Stadium Zone Art: Enrico Cartmanuel
• Level Design: FieryN8
• Neko Presence Plugin: nkrapivin
• Special Thanks: Lapper, Mercury, NicoCW, thevaleev, Noah N. Copeland, The Sonic 1, 2 and 3 Disassembly Community, and our Twitter followers