Skip to content

ThePlayerRolo/lm-decomp

Repository files navigation

Luigi's Mansion Build Status Code Progress_USA Data Progress_USACode Progress_JPN Data Progress_JPN Code Progress_PAL_00 Data Progress_PAL_00 Code Progress_PAL_01 Data Progress_PAL_01

A work-in-progress decompilation of Luigi's Mansion.

This repository does not contain any game assets or assembly whatsoever. An existing copy of the game is required.

Warning

Using AI software to contribute to this decompilation is strictly prohibited and will result in being banned from contributing. This is because AI is known to use code from illegally leaked sources, which presents legal concerns the maintainers of this project want to avoid.

Supported versions:

  • GLME01: Rev 0 (USA)
  • GLMJ01: Rev 0 (JPN)
  • GLMP01_00: Rev 0 (PAL)
  • GLMP01_01: Rev 1 (PAL)

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%.
  • 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

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

Building

  • Clone the repository:

    git clone https://github.com/theplayerrolo/lm-decomp.git
  • Copy your game's disc image to orig/GLME01.

    • 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 GLME01 (USA), specify it with --version.

  • Build:

    ninja

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.

About

A decompilation of Luigi's Mansion brought to you by a bunch of clever folks.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors

Generated from encounter/dtk-template