A decompilation of Metroid Prime brought to you by fans of the series.

Go to file

Phillip Stephens 5b5c114bb6 Minor CSfxManager fixes and renames		2024-10-12 19:29:07 -07:00
.github/workflows	Update to latest dtk-template	2024-09-04 22:03:20 -06:00
.vscode	Enable clangd integration & revamp VS Code config	2024-10-12 16:58:00 -06:00
assets	Cleanup, fixes & update README/CONTRIBUTING	2023-10-11 17:20:51 -04:00
buildstrings	Migrate to dtk	2023-10-09 20:16:05 -07:00
config	Minor CSfxManager fixes and renames	2024-10-12 19:29:07 -07:00
extern	Match and link synthmacros, update musyx	2024-04-24 21:27:01 -07:00
include	Minor CSfxManager fixes and renames	2024-10-12 19:29:07 -07:00
libc	Enable clangd integration & revamp VS Code config	2024-10-12 16:58:00 -06:00
orig	Cleanup, fixes & update README/CONTRIBUTING	2023-10-11 17:20:51 -04:00
sha1	Add missing sha1 files	2022-08-22 10:18:31 -04:00
src	Minor CSfxManager fixes and renames	2024-10-12 19:29:07 -07:00
tools	Enable clangd integration & revamp VS Code config	2024-10-12 16:58:00 -06:00
.clang-format	Start matching CScriptPlatform; more CScriptMazeNode	2022-09-18 01:55:13 -04:00
.flake8	DolphinCGraphics & CDecal 99%	2024-09-18 23:13:27 -06:00
.gitattributes	Update to latest dtk-template	2024-09-04 22:03:20 -06:00
.gitignore	Enable clangd integration & revamp VS Code config	2024-10-12 16:58:00 -06:00
.gitmodules	Use https instead	2023-12-18 18:44:00 -08:00
CONTRIBUTING.md	Cleanup, fixes & update README/CONTRIBUTING	2023-10-11 17:20:51 -04:00
README.md	Use decomp.dev progress badges	2024-09-19 00:20:50 -06:00
configure.py	Revamp progress output	2024-09-30 22:16:32 -06:00

README.md

Metroid Prime

A work-in-progress decompilation of Metroid Prime.

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

The following game versions are supported:

GM8E01_00 (USA v1.088)

If you'd like to contribute, see CONTRIBUTING.md.

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

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

Clone the repository:

git clone https://github.com/PrimeDecomp/prime.git

Update and Initialize submodules:

git submodule update --init --recursive

Using Dolphin Emulator, extract your game to orig/GM8E01_00 (or the appropriate version).
- To save space, the only necessary files are the following. Any others can be deleted.
  - sys/main.dol
  - files/NESemuP.rel
Configure:
```
python configure.py
```
To use a version other than GM8E01_00 (USA), specify --version GM8E01_01 or similar.
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.