spm-decomp

Decompilation of Super Paper Mario. The main versions targetted are the two PAL versions of the game (with symbol and split addresses being identical between both). Support has also been set-up for NTSC-U revision 0 of the game, though less addresses have been ported (and it's advised to not put work into this until some kind of automated porting setup has been created).

This will never be a decompilation of the full game, just specific parts that are useful or interesting, and it certainly won't lead to ports to any other platform. In theory the repo is shiftable (i.e. files marked as Matching in configure.py can be edited to change the behaviour of the game) but this hasn't been thorougly tested. The SDK, NW4R and MSL libraries are out of scope for this project and will not be decompiled (though partial headers will be needed for them to allow other code to be decompiled).

See also https://github.com/SeekyCt/spm-docs for other documentation.

Dependency Setup

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

• Copy your game's disc image to the subfolder of orig for your version
  • Supported versions:
    • EU0: PAL revision 0
    • EU1: PAL revision 1
    • JP0: NTSC-J revision 0
    • KR0: NTSC-K revision 0
  • Supported formats: ISO (GCM), RVZ, WIA, WBFS, CISO, NFS, GCZ, TGC
  • After the initial build, the disc image can be deleted to save space.
• Run configure.py
  • For EU0, no additional arguments are required
  • For any other version, use --version RGX where RGX is the region and revision of your version
• Run ninja

Contributing

See CONTRIBUTING.md

Modding

In its current state, the repo isn't really ready for direct editing, but functions can be copied into REL mods and edited there, and the documentation is still useful.

Credits

• PistonMiner, Zephiles, Jdaster64, Jasper, NWPlayer123, Malleo, SolidifiedGaming and Diagamma for their TTYD documentation
• All contributors to the PM64 decomp
• All contributors to asm-differ
• All contributors to decomp-toolkit and dtk-template