{"id":13691835,"url":"https://github.com/ACreTeam/ac-decomp","last_synced_at":"2025-05-02T16:30:33.810Z","repository":{"id":147157188,"uuid":"579413540","full_name":"ACreTeam/ac-decomp","owner":"ACreTeam","description":"Decompilation in progress of Animal Crossing for the Nintendo GameCube.","archived":false,"fork":false,"pushed_at":"2024-10-29T12:35:32.000Z","size":10988,"stargazers_count":362,"open_issues_count":1,"forks_count":21,"subscribers_count":26,"default_branch":"master","last_synced_at":"2024-10-29T14:46:08.737Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/ACreTeam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-12-17T16:06:06.000Z","updated_at":"2024-10-29T12:35:36.000Z","dependencies_parsed_at":"2024-03-02T00:27:50.979Z","dependency_job_id":"206a9c81-6b44-43fe-beb2-6278362a02ca","html_url":"https://github.com/ACreTeam/ac-decomp","commit_stats":null,"previous_names":["acreteam/ac-decomp"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ACreTeam%2Fac-decomp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ACreTeam%2Fac-decomp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ACreTeam%2Fac-decomp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ACreTeam%2Fac-decomp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ACreTeam","download_url":"https://codeload.github.com/ACreTeam/ac-decomp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224319371,"owners_count":17291830,"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:50.856Z","updated_at":"2024-11-12T17:32:10.904Z","avatar_url":"https://github.com/ACreTeam.png","language":"C","funding_links":[],"categories":["Reverse Engineering","others"],"sub_categories":["Projects"],"readme":"# Animal Crossing Decompilation [![Discord Channel][discord-badge]][discord] ![rel progress] ![dol progress]\n[discord]: https://discord.gg/hKx3FJJgrV\n[discord-badge]: https://img.shields.io/discord/727908905392275526?color=%237289DA\u0026logo=discord\u0026logoColor=%23FFFFFF\n[rel progress]: https://img.shields.io/endpoint?label=rel\u0026url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Fanimalcrossing%2Fus%2Frel%2F%3Fmode%3Dshield%26measure%3Dcode\n[dol progress]: https://img.shields.io/endpoint?label=dol\u0026url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Fanimalcrossing%2Fus%2Fdol%2F%3Fmode%3Dshield%26measure%3Dcode\n\nDecompilation in progress of Animal Crossing (GAFE01)\n\nA decompilation of the original N64 version of the game is being worked on [here](https://github.com/zeldaret/af).\n## Cloning\n\nUse `--recursive` when cloning to have ppcdis in the repository. \n\n## Building\n\n\u003e ℹ️ When using Windows, it's recommended to use WSL.\n\n### Docker\n\n1. [Dump a copy of the game](./docs/extract_game.md) and extract all files.\n2. Place **main.dol**, **foresta.rel.szs**, **forest_1st.arc**, and **forest_2nd.arc** in *dump/*.\n3. Download the [CodeWarrior 1.3.2, 1.3.2r, and 1.2.5n compilers](https://files.decomp.dev/compilers_latest.zip) and extract them to *tools/1.3.2/*, *tools/1.3.2r/*, and *tools/1.2.5n/*, respectively.\n4. Install Docker.\n5. Build the Docker image (`docker build -t ac-decomp .`).\n6. Run configure.py (`docker run --rm -v ${PWD}:/ac-decomp ac-decomp python3 configure.py`).\n7. Run build.py (`docker run --rm -v ${PWD}:/ac-decomp ac-decomp python3 build.py`).\n\n### Build manually\n\n\u003e ℹ️ When building manually from a work directory originally used for Docker, you will need to run `sudo ninja -t clean` for the build to execute properly.\n\n1. [Dump a copy of the game](./docs/extract_game.md) and extract all files.\n2. Place **main.dol**, **foresta.rel.szs**, **forest_1st.arc**, and **forest_2nd.arc** in *dump/*.\n3. Download the [CodeWarrior 1.3.2, 1.3.2r, and 1.2.5n compilers](https://files.decomp.dev/compilers_latest.zip) and extract them to *tools/1.3.2/*, *tools/1.3.2r/*, and *tools/1.2.5n/*, respectively.\n4. Install Python, pip, and [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages#package-managers) using your package manager of choice.\n5. Install Python modules from requirements.txt (`pip install -r requirements.txt`).\n6. Install version 0.6.13 of [wibo](https://github.com/decompals/wibo)\n    - Wibo is a lightweight Wine replacement that's tailor-made for use with decomp projects. Regular Wine can be used if preferred, but for the purposes of this guide, these instructions will use wibo.\n    - Download [version 0.6.13 GitHub release](https://github.com/decompals/wibo/releases/tag/0.6.13) and run `install ./wibo /usr/bin` to install it to your system.\n7. Install devkitPPC.\n    - To get devkitPPC, you'll need [devkitPro Pacman](https://devkitpro.org/wiki/devkitPro_pacman#Installing_devkitPro_Pacman).\n        - Run `dkp-pacman -S devkitPPC` once dkp-pacman is installed to install devkitPPC.\n        - Set the `DEVKITPPC` environment variable to */opt/devkitpro/devkitPPC*.\n8. Set the `N64_SDK` environment variable to the path of your libultra or equivalent headers. If you need headers, you can use the ones from [ultralib](https://github.com/decompals/ultralib).\n    - Headers should be located at `$N64_SDK/ultra/usr/include`.\n    - You must modify `Gpopmtx`'s `param` member to be `unsigned int` in **gbi.h**.\n9. Run `python3 configure.py`.\n10. Run `python3 build.py`.\n\n## Quick Guides\n- [Dumping Game Files](./docs/extract_game.md)\n- [Ghidra Setup](./docs/ghidra_setup.md)\n- [Generating Decomp Context](./docs/generating_decomp_context.md)\n- [decomp.me Basics](./docs/decomp_me_basics.md)\n- [Ghidra Basics](./docs/ghidra_basics.md)\n- [m2c Basics](./docs/m2c_basics.md)\n- [Decomp Basics](./docs/decomp_basics.md)\n\n## Credits\n\n- jamchamb, Cuyler36, NWPlayer123 and fraser125 for past documentation of Animal Crossing.\n- SeekyCt for [ppcdis](https://github.com/SeekyCt/ppcdis/) and helping setting up the project.\n- msg for helping with *tools/map.py*.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FACreTeam%2Fac-decomp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FACreTeam%2Fac-decomp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FACreTeam%2Fac-decomp/lists"}