Sonic Rush Adventure

This is a work in progress matching decompilation of Sonic Rush Adventure for the Nintendo DS. For instructions on how to set up the repository, please read INSTALL.md.

This repository builds the following ROM:

• rush2.eu.nds sha1: f105f64da60d7e0544a96b7c4c945b07fc5fa8a2

• Europe (rev01), USA & JP ROM support is planned in the future, but aren't a priority at the moment.

Current state

• ⚠️ The build is NOT shiftable. You can make some modifications, but most aspects of the game will currently cease to function.
• Most of the game's assembly code extracted, disassembled, and somewhat categorised
• Most library functions have been named, though most of the library C code has not been decompiled.

What's left to do

• research any functions and modules that are using _XXXXXX suffixes and give them proper names
• properly split asm files into respective .s files. This includes proper .text, .bss, .data & .rodata sections. This is mostly complete, however some sections need further research.
• replace as many hardcoded addresses as possible with proper labels to allow the game to be more shiftable
• split the library files from the game logic, with the eventual goal to have them as compiled .a static libraries
• decompile all functions into proper .c & .h files
• match all existing non-matching game logic functions
• upgrade build system to convert most binary files into user-friendly formats on extraction, and repack them into their respective binary forms on compilation
• document differences in the JP & USA rom's code and add those differences into the codebase in a form that allows them to build matching
• setup build system to build competition rom (files/mb/contest.srl)

Provide assets

You must have a copy of the Sonic Rush Adventure ROM named baserom.nds in the repository root directory. Any Sonic Rush Adventure ROM should be fine, as the game shares most assets between versions, Though the EU revision 00 rom is recommended, as it is the default build configuration.

Contributing

There's much left to be done, if you think you want to help out then there's many ways to contribute!

• The biggest tasks still to be completed is the work of decompiling and matching functions, if you'd like to help out in that field then create a branch, pick a game logic asm file in the asm folder or a library asm file in the library asm folder and do your best to translate it into C code!
• If you'd like to just assist with smaller tasks, but still help out a bunch, then there's many functions partially or mostly matched throughout the repo that don't require as much knowledge of assembly or C code as decompiling an object or module from scratch!
• General research is also super appreciated even if you can't decompile or match any functions! Tasks like running the game in a debugger to verify everything is named properly and that it's easy for people to understand what it all does and is used for is also an important goal for this project.

When you've got some work you think is finished or ready to be merged into master, create a pull request and it'll either get feedback on what to change or be merged in if it's ready!

Community

Join us on discord to get started in helping out, to discuss the decompilation, or just to hang out!

Credits & Special Thanks

• Pokemon Reverse Engineering Team for tooling for NDS decompilations
• The Sonic 4 - Episode 1 Decompilation which was used as a reference for various modules that both games share
• Sonic Advance Trilogy Research Team for their Sonic Advance 2 Decompilation, which was the inspiration this project
• Velocitas for building an awesome tool to view & edit sprites, backgrounds & levels.