{"id":13692018,"url":"https://github.com/zeldaret/tp","last_synced_at":"2025-05-14T19:08:41.027Z","repository":{"id":38377629,"uuid":"291260123","full_name":"zeldaret/tp","owner":"zeldaret","description":"Decompilation of The Legend of Zelda: Twilight Princess (GCN, USA)","archived":false,"fork":false,"pushed_at":"2025-05-08T22:52:22.000Z","size":185006,"stargazers_count":985,"open_issues_count":809,"forks_count":110,"subscribers_count":28,"default_branch":"main","last_synced_at":"2025-05-08T23:32:32.913Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zeldaret.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null}},"created_at":"2020-08-29T11:41:26.000Z","updated_at":"2025-05-08T22:52:26.000Z","dependencies_parsed_at":"2025-04-30T23:36:26.423Z","dependency_job_id":"1d6a916a-bd6f-4aeb-aed6-c437b82e2d3b","html_url":"https://github.com/zeldaret/tp","commit_stats":{"total_commits":1302,"total_committers":37,"mean_commits":"35.189189189189186","dds":0.7542242703533026,"last_synced_commit":"ee09fdf9158ba4fb7b28c914acd9af19ff8e7186"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Ftp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Ftp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Ftp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Ftp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeldaret","download_url":"https://codeload.github.com/zeldaret/tp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254209859,"owners_count":22032897,"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":[],"created_at":"2024-08-02T17:00:52.604Z","updated_at":"2025-05-14T19:08:34.558Z","avatar_url":"https://github.com/zeldaret.png","language":"C++","funding_links":[],"categories":["Game \u0026 Studio Tools","Nintendo Wii","Reverse Engineering"],"sub_categories":["Nintendo EAD","Projects"],"readme":"The Legend of Zelda: Twilight Princess  \n[![Build Status]][actions] [![Code Progress]][progress] [![DOL Progress]][progress] [![RELs Progress]][progress] [![Discord Badge]][discord]\n=============\n\n[Build Status]: https://github.com/zeldaret/tp/actions/workflows/build.yml/badge.svg\n[actions]: https://github.com/zeldaret/tp/actions/workflows/build.yml\n[Code Progress]: https://decomp.dev/zeldaret/tp.svg?mode=shield\u0026category=all\u0026measure=code\u0026label=Code\n[DOL Progress]: https://decomp.dev/zeldaret/tp.svg?mode=shield\u0026category=dol\u0026measure=code\u0026label=DOL\n[RELs Progress]: https://decomp.dev/zeldaret/tp.svg?mode=shield\u0026category=modules\u0026measure=code\u0026label=RELs\n[progress]: https://decomp.dev/zeldaret/tp\n[Discord Badge]: https://img.shields.io/discord/688807550715560050?color=%237289DA\u0026logo=discord\u0026logoColor=%23FFFFFF\n[discord]: https://discord.com/invite/DqwyCBYKqf\n\nA work-in-progress decompilation of The Legend of Zelda: Twilight Princess (GCN USA).\n\nThis repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.\n\nMore information about the project can be found here: https://zsrtp.link  \n\n\u003c!--ts--\u003e\n* [Progress](https://zsrtp.link/progress)\n* [Dependencies](#dependencies)\n* [Building](#building)\n* [Diffing](#diffing)\n* [Contributing](https://zsrtp.link/contribute)\n* [FAQ](https://zsrtp.link/about)\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/zeldaret/tp.git\n  ```\n\n- Copy your game's disc image to `orig/GZ2E01`.\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 `GZ2E01` (USA), specify it with `--version`.\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeldaret%2Ftp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeldaret%2Ftp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeldaret%2Ftp/lists"}