Game-Decompilation/spm-decomp
1
0
Fork 0
mirror of https://github.com/SeekyCt/spm-decomp.git synced 2024-11-23 05:19:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
WIP 1:1 decompilation of Super Paper Mario
381 Commits 1 Branch 0 Tags 2 MiB
C 83.8%
Python 11.5%
C++ 4.7%
2a2e7f6bbf
Go to file
Seeky 2a2e7f6bbf Cleanup nonCopyable.h
2024-09-13 16:00:18 +01:00
.github/workflows New build system 2024-08-28 23:09:49 +01:00
.vscode.example Remove spm-headers ppcdis support 2024-09-03 18:25:44 +01:00
config/EU0 Embedded tpl labelling 2024-09-03 22:45:09 +01:00
orig/EU0 New build system 2024-08-28 23:09:49 +01:00
spm-headers Cleanup nonCopyable.h 2024-09-13 16:00:18 +01:00
src Cleanup non-matched notation 2024-09-03 14:43:10 +01:00
tools Update objdiff_tag and dtk-template (#22) 2024-09-04 13:40:52 +01:00
.gitattributes New build system 2024-08-28 23:09:49 +01:00
.gitignore New build system 2024-08-28 23:09:49 +01:00
configure.py NonStarted status in configure.py 2024-09-13 15:48:14 +01:00
CONTRIBUTING.md New build system 2024-08-28 23:09:49 +01:00
README.md New build system 2024-08-28 23:09:49 +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. 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%.
  • Download ninja and add it to %PATH%.
    • Quick install via pip: pip install ninja

macOS

  • Install ninja:

    brew install ninja

  • Install wine-crossover:

    brew install --cask --no-quarantine gcenx/wine/wine-crossover

After OS upgrades, if macOS complains about Wine Crossover.app being unverified, you can unquarantine it using:

sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'

Linux

  • Install ninja.
  • For non-x86(_64) platforms: Install wine from your package manager.
    • For x86(_64), wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building

  • Using Dolphin Emulator, extract your game to orig/EU0.
    • To save space, the only necessary files are the following. Any others can be deleted.
      • sys/main.dol
      • files/rel/relF.bin
  • Run configure.py
  • 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