Star Fox Adventures Decompilation

This is the decompilation for Star Fox Adventures for the Nintendo GameCube.

There are 3 versions of this game: JP, EN, and PAL (EU), with the EN having an initial v1.00 release, and a patched version v1.01.

⚠️ Assets are not bundled with this repository. You must obtain these on your own. ⚠️

Contribution Guide

Beginners Contribution Guide

The most direct way to contribute that requires minimal setup, is to simply pick a 10-99% matching section from the decomp tracker, and update the code until it has a higher match score.

Refer to the sections on building and diffing. Once you have this set up, all you need to do is modify .cpp and .h files until the score goes up!

Advanced Contribution Guide

Splits and symbols are largely incomplete at this point. Until these are in a better place, contributing code is quite difficult.

Dependencies

Windows

On Windows, it's highly recommended to use native tooling. WSL or msys2 are not required.
When running under WSL, objdiff is unable to get filesystem notifications for automatic rebuilds.

• Install Python and add it to %PATH%.
  • Also available from the Windows Store.
• Download ninja and add it to %PATH%.
  • Quick install via pip: pip install ninja

macOS

• Install ninja:

  brew install ninja
  

wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Linux

• Install ninja.

wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building

• Clone the repository:

  git clone https://github.com/my/repo.git
  

• Copy your game's disc image to the matching version directory under orig/. The configured versions are GSAE01 (the default EN v1.0 target), GSAE01_rev1, GSAJ01, GSAP01 (PAL rev 0), and GSAP01_rev1 (PAL rev 1).

  • Supported formats: ISO (GCM), RVZ, WIA, WBFS, CISO, NFS, GCZ, TGC
  • After the initial build, the disc image can be deleted to save space.

• Configure:

  python configure.py
  

  To use a version other than EN v1.0, specify it with --version. All five versions also support --matching, which links completed source units with retail objects for the remaining code and checks the original DOL checksum. For example:

  python configure.py --version GSAJ01 --matching
  

• Build:

  ninja
  

  Run ninja all_source as well to compile the unfinished source units.

Diffing

Once the initial build succeeds, an objdiff.json should exist in the project root.

Download the latest release from encounter/objdiff. Under project settings, set Project directory. The configuration should be loaded automatically.

Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, configure.py, splits.txt or symbols.txt.

For the optional CLI fix that compares anonymous constructors and exception records, see compiler metadata comparison.

Acknowledgements

Much of the function and symbol naming in this project draws on Rena Kunisaki's extensive Star Fox Adventures reverse-engineering work — in particular the symbol map from the StarFoxAdventures research repo. Reference notes from Rena's SFA wiki, cross-referenced to this codebase, are collected under docs/wiki/. Thank you to Rena for making that work available.

The project structure also takes inspiration from the Dinosaur Planet decompilation, which represents an earlier version of the same codebase.