Game-Decompilation/spm-decomp
1
0
Fork 0
mirror of https://github.com/SeekyCt/spm-decomp.git synced 2024-11-23 13:29:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
WIP 1:1 decompilation of Super Paper Mario
228 Commits 1 Branch 0 Tags 2 MiB
C 83.8%
Python 11.5%
C++ 4.7%
c417026fe6
Go to file
Seeky c417026fe6 Move rel forceactive to lcf
2022-07-20 13:16:19 +01:00
config Move rel forceactive to lcf 2022-07-20 13:16:19 +01:00
include float -> f32 2022-07-20 12:48:34 +01:00
orig New build system 2022-07-01 12:13:31 +01:00
rel float -> f32 2022-07-20 12:48:34 +01:00
src Move rel forceactive to lcf 2022-07-20 13:16:19 +01:00
tools Update ppcdis 2022-07-19 14:48:46 +01:00
.gitignore New build system 2022-07-01 12:13:31 +01:00
.gitmodules New build system 2022-07-01 12:13:31 +01:00
common.py Remove todo 2022-07-19 17:33:14 +01:00
configure.py getfunction symbol name support 2022-07-12 11:53:22 +01:00
CONTRIBUTING.md Update diff.py 2022-07-08 00:19:27 +01:00
decompme.py decompme diff label fix 2022-07-12 12:43:04 +01:00
diff_settings.py Update diff.py 2022-07-08 00:19:27 +01:00
diff.py Update diff.py 2022-07-08 14:03:19 +01:00
expected.py New build system 2022-07-01 12:13:31 +01:00
getfunction.py decompme diff label fix 2022-07-12 12:43:04 +01:00
makectx_m2c.py Fix makectx 2022-07-05 14:32:08 +01:00
makectx.py Fix makectx 2022-07-05 14:32:08 +01:00
progress.py Fix progress check 2022-07-08 15:35:26 +01:00
README.md Fix progress check 2022-07-08 15:35:26 +01:00
requirements.txt New build system 2022-07-01 12:13:31 +01:00

README.md

spm-decomp

Decompilation of Super Paper Mario PAL revision 0. 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. The repo is currently not shiftable (i.e. making changes to the code that causes functions or data to change size or move won't create a working output) but is intended to be at some point. 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.

Building

  • Dump a copy of the game and extract the main.dol & relF.bin files
  • Extract relF.bin to relF.rel with a tool like nlzss
  • Place main.dol and relF.rel in the orig folder
  • Place Codewarrior EPPC Version 4.1 Build 60831 in tools/4199_60831
  • Install DevkitPPC, Ninja and Python
    • DevkitPPC r38 and r41 are known to work, other versions probably do too
    • Python 3.8+ is supported, earlier versions may work
  • If you didn't use --recursive when cloning, run git submodule update --init --recursive
  • Install the modules from requirements.txt (pip install -r requirements.txt)
  • Run configure.py
  • Run ninja

Pulling

When pulling the repo later on, make sure to rerun configure.py and git submodule update --recursive

Checking Progress

Running progress.py after a successful build will give the current dol & rel .text section progress.

Contributing

See CONTRIBUTING.md

Modding

In it's current state, the repo isn't really ready for direct editing (the DOL isn't shiftable, the REL might be but it's not been thoroughly tested), 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 ppcdis