v26.08

This release marks the completion of a long-running effort to fully document the Sonic 1 disassembly.

Over the past months, nearly every corner of the codebase has been revisited, with thousands of comments added or rewritten to explain engine behavior, object logic, hardware interactions, and implementation detail. This brings the project to a point where every major engine component and object has received comprehensive documentation.

Full Changelog: v26.05...v26.08

Thanks to all contributors for this massive update: @AlexField442, @noobguy57, @IsoKilo, @kirisamemofo, @Selbi182

Highlights

Documentation

• Completed documentation of every remaining engine subsystem and object
• Fully documented all remaining boss objects (special thanks to @noobguy57 for enduring this monstrous task!)
• Finished and substantially improved Special Stage documentation
• Expanded documentation for notoriously complex subsystems such as level drawing, deformation, sprites, reaction handling, and more
• Numerous older comments have been rewritten for clarity, consistency, and accuracy
• All anonymous labels and cryptic routines have been given meaningful names
• Incorporated findings from previous community research where appropriate, while adding substantial original analysis and filling many remaining gaps
• Added constants for collision sizes, Sonic speed values, Special Stage data, collision types, render flags, and sprite handling

Bug fixes

• Introduced various new FixBugs flags to fix several engine issues discovered during the documentation process
• Added new _Fixed Binary Files folder for file fixes that can't be done through FixBugs

Cleanup

• Reorganized and renamed many object source files for consistency
• Standardized formatting, constants, naming conventions, and comments throughout the project
• Fixed numerous typos and documentation inaccuracies

Looking ahead

What started as an effort to improve readability gradually evolved into a complete documentation pass over the entire project. The result is a disassembly that should be significantly easier to study, modify, and maintain, whether you're investigating how the original game works or building your own projects on top of it.

For the foreseeable future, this release should be last "major" one.