Luigi's Mansion
[![Build Status]][actions] [![Code Progress_USA]][progress] [![Data Progress_USA]][progress][![Code Progress_JPN]][progress] [![Data Progress_JPN]][progress] [![Code Progress_PAL_00]][progress] [![Data Progress_PAL_00]][progress] [![Code Progress_PAL_01]][progress] [![Data Progress_PAL_01]][progress]
=============
[Build Status]: https://github.com/theplayerrolo/lm-decomp/actions/workflows/build.yml/badge.svg
[actions]: https://github.com/theplayerrolo/lm-decomp/actions/workflows/build.yml

[Code Progress_USA]: https://decomp.dev/theplayerrolo/lm-decomp/GLME01.svg?mode=shield&measure=code&label=USA%20Code
[Data Progress_USA]: https://decomp.dev/theplayerrolo/lm-decomp/GLME01.svg?mode=shield&measure=data&label=USA%20Data
[Code Progress_JPN]: https://decomp.dev/theplayerrolo/lm-decomp/GLMJ01.svg?mode=shield&measure=code&label=JPN%20Code
[Data Progress_JPN]: https://decomp.dev/theplayerrolo/lm-decomp/GLMJ01.svg?mode=shield&measure=data&label=JPN%20Data
[Code Progress_PAL_00]: https://decomp.dev/theplayerrolo/lm-decomp/GLMP01_00.svg?mode=shield&measure=code&label=PAL%20Rev%200%20Code
[Data Progress_PAL_00]: https://decomp.dev/theplayerrolo/lm-decomp/GLMP01_00.svg?mode=shield&measure=data&label=PAL%20Rev%200%20Data
[Code Progress_PAL_01]: https://decomp.dev/theplayerrolo/lm-decomp/GLMP01_01.svg?mode=shield&measure=code&label=PAL%20Rev%201%20Code
[Data Progress_PAL_01]: https://decomp.dev/theplayerrolo/lm-decomp/GLMP01_01.svg?mode=shield&measure=data&label=PAL%20Rev%201%20Data
[progress]: https://decomp.dev/theplayerrolo/lm-decomp


# **NOTE: This is outdated! Check out https://github.com/SomeJakeGuy/lm-decomp!** <br>
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](#diffing) is unable to get filesystem notifications for automatic rebuilds.

- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`.
  - Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K).
- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`.
  - Quick install via pip: `pip install ninja`

macOS
------

- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages):

  ```sh
  brew install ninja
  ```

[wibo](https://github.com/decompals/wibo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Linux
------

- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages).

[wibo](https://github.com/decompals/wibo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building
========

- Clone the repository:

  ```sh
  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:

  ```sh
  python configure.py
  ```

  To use a version other than `GLME01` (USA), specify it with `--version`.

- Build:

  ```sh
  ninja
  ```

Diffing
=======

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

Download the latest release from [encounter/objdiff](https://github.com/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`.

![](assets/objdiff.png)