{"id":13691920,"url":"https://github.com/PrimeDecomp/prime","last_synced_at":"2025-05-02T16:30:56.213Z","repository":{"id":42678662,"uuid":"473362373","full_name":"PrimeDecomp/prime","owner":"PrimeDecomp","description":"A matching decompilation of Metroid Prime","archived":false,"fork":false,"pushed_at":"2024-10-28T04:18:15.000Z","size":41716,"stargazers_count":150,"open_issues_count":0,"forks_count":7,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-10-28T07:39:05.281Z","etag":null,"topics":["cplusplus","decompilation","gamecube","metroid","metroid-prime","reverse-engineering"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PrimeDecomp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-23T21:22:23.000Z","updated_at":"2024-10-28T04:18:19.000Z","dependencies_parsed_at":"2024-06-24T05:41:01.409Z","dependency_job_id":"a6ffc4ed-8011-44ca-872d-258090abcc2d","html_url":"https://github.com/PrimeDecomp/prime","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrimeDecomp%2Fprime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrimeDecomp%2Fprime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrimeDecomp%2Fprime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrimeDecomp%2Fprime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrimeDecomp","download_url":"https://codeload.github.com/PrimeDecomp/prime/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224319471,"owners_count":17291847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cplusplus","decompilation","gamecube","metroid","metroid-prime","reverse-engineering"],"created_at":"2024-08-02T17:00:51.659Z","updated_at":"2025-05-02T16:30:56.176Z","avatar_url":"https://github.com/PrimeDecomp.png","language":"C++","readme":"Metroid Prime  \n[![Build Status]][actions] [![Code Progress]][progress] [![Data Progress]][progress] [![Discord Badge]][discord]\n=============\n\n[Build Status]: https://github.com/PrimeDecomp/prime/actions/workflows/build.yml/badge.svg\n[actions]: https://github.com/PrimeDecomp/prime/actions/workflows/build.yml\n[Code Progress]: https://decomp.dev/PrimeDecomp/prime.svg?mode=shield\u0026measure=code\u0026label=Code\n[Data Progress]: https://decomp.dev/PrimeDecomp/prime.svg?mode=shield\u0026measure=data\u0026label=Data\n[progress]: https://decomp.dev/PrimeDecomp/prime\n[Discord Badge]: https://img.shields.io/discord/727908905392275526?color=%237289DA\u0026logo=discord\u0026logoColor=%23FFFFFF\n[discord]: https://discord.gg/hKx3FJJgrV\n\nA work-in-progress decompilation of Metroid Prime.\n\nThis repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.\n\nThe following game versions are supported:\n\n- `GM8E01_00` (USA v1.088)\n\u003c!--\n- `GM8E01_01` (USA v1.093)\n- `GM8E01_48` (KOR v1.097)\n--\u003e\n\nIf you'd like to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\nDependencies\n============\n\nWindows\n--------\n\nOn Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required.  \nWhen running under WSL, [objdiff](#diffing) is unable to get filesystem notifications for automatic rebuilds.\n\n- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`.\n  - Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K).\n- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`.\n  - Quick install via pip: `pip install ninja`\n\nmacOS\n------\n\n- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages):\n\n  ```sh\n  brew install ninja\n  ```\n\n- Install [wine-crossover](https://github.com/Gcenx/homebrew-wine):\n\n  ```sh\n  brew install --cask --no-quarantine gcenx/wine/wine-crossover\n  ```\n\nAfter OS upgrades, if macOS complains about `Wine Crossover.app` being unverified, you can unquarantine it using:\n\n```sh\nsudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'\n```\n\nLinux\n------\n\n- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages).\n- For non-x86(_64) platforms: Install wine from your package manager.\n  - For x86(_64), [wibo](https://github.com/decompals/wibo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.\n\nBuilding\n========\n\n- Clone the repository:\n\n  ```sh\n  git clone https://github.com/PrimeDecomp/prime.git\n  ```\n\n- Update and Initialize submodules:\n\n  ```sh\n  git submodule update --init --recursive\n  ```\n\n- Copy your game's disc image to `orig/GM8E01_00` (or the appropriate version).\n  - Supported formats: ISO (GCM), RVZ, WIA, WBFS, CISO, NFS, GCZ, TGC\n  - After the initial build, the disc image can be deleted to save space.\n\n- Configure:\n\n  ```sh\n  python configure.py\n  ```\n\n  To use a version other than `GM8E01_00` (USA), specify `--version GM8E01_01` or similar.\n- Build:\n\n  ```sh\n  ninja\n  ```\n\nDiffing\n=======\n\nOnce the initial build succeeds, an `objdiff.json` should exist in the project root.\n\nDownload the latest release from [encounter/objdiff](https://github.com/encounter/objdiff). Under project settings, set `Project directory`. The configuration should be loaded automatically.\n\nSelect 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`.\n\n![](assets/objdiff.png)\n","funding_links":[],"categories":["Reverse Engineering"],"sub_categories":["Projects"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPrimeDecomp%2Fprime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPrimeDecomp%2Fprime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPrimeDecomp%2Fprime/lists"}