{"id":18336278,"url":"https://github.com/zeldaret/af","last_synced_at":"2025-04-06T04:35:21.681Z","repository":{"id":187583116,"uuid":"617065079","full_name":"zeldaret/af","owner":"zeldaret","description":"Decompilation of Animal Forest","archived":false,"fork":false,"pushed_at":"2024-04-13T19:49:06.000Z","size":2909,"stargazers_count":106,"open_issues_count":4,"forks_count":17,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-04-14T12:59:14.352Z","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":"CONTRIBUTING.md","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}},"created_at":"2023-03-21T16:22:46.000Z","updated_at":"2024-04-16T00:30:06.668Z","dependencies_parsed_at":"2023-08-11T08:07:22.949Z","dependency_job_id":"eae44fa2-3eb5-4140-b2d3-1c8dea0c7167","html_url":"https://github.com/zeldaret/af","commit_stats":null,"previous_names":["zeldaret/af"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Faf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Faf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Faf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeldaret%2Faf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeldaret","download_url":"https://codeload.github.com/zeldaret/af/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223238114,"owners_count":17111359,"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-11-05T20:07:08.971Z","updated_at":"2024-11-05T20:07:09.543Z","avatar_url":"https://github.com/zeldaret.png","language":"C","funding_links":[],"categories":["Nintendo Wii","Reverse Engineering","Game \u0026 Studio Tools"],"sub_categories":["Projects","Nintendo EAD"],"readme":"# Animal Forest [![Build Status][jenkins-badge]][jenkins] ![Code jp Progress] [![Discord Channel][discord-badge]][discord]\n\n[jenkins]: https://jenkins.deco.mp/job/AF/job/main\n[jenkins-badge]: https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fjenkins.deco.mp%2Fjob%2FAF%2Fjob%2Fmain\n\n[Code jp Progress]: https://img.shields.io/endpoint?label=Code%20jp\u0026url=https%3A%2F%2Fprogress.deco.mp%2Fdata%2Fanimalforest%2Fjp%2Fcode%2F%3Fmode%3Dshield%26measure%3Dall\n\n[discord]: https://discord.zelda.deco.mp/\n[discord-badge]: https://img.shields.io/discord/688807550715560050?color=%237289DA\u0026logo=discord\u0026logoColor=%23FFFFFF\n\nThis is a work-in-progress decompilation project for the Nintendo 64 game *Animal Forest*, also known as どうぶつの森 (*Doubutsu no Mori*).\nThere is a decompilation project for the GameCube versions (*Animal Crossing*, etc.) [here](https://github.com/Prakxo/ac-decomp/).\n\n```diff\n- WARNING! -\n\nThis repository is a work in progress, and while it can be used to make certain changes, it's \nstill constantly evolving. If you wish to use it for modding purposes in its current state,\nplease be aware that the codebase could drastically change at any time. Also note that some\nparts of the ROM may not be 'shiftable' yet, so modifying them could currently be difficult.\n```\n\n**Note:** this project is *not* a port, to PC or any other platform.\nIt takes a Nintendo 64 rom, extracts assets from it, and combines them with C code we reverse-engineered from the rom, to produce an identical rom.\nIt is explicitly a non-goal for this project to be used as basis for a port, or to be used for any commercial purpose.\n\n## Setup\n\n### Linux\n\n#### 1. Install build dependencies\n\nThe build process has the following package requirements:\n\n* make\n* git\n* build-essential\n* clang\n* binutils-mips-linux-gnu\n* python3\n* python3-pip\n* python3-venv\n\nUnder Debian / Ubuntu (which we recommend using), you can install them with the following commands:\n\n```bash\nsudo apt update\nsudo apt install make git build-essential clang binutils-mips-linux-gnu python3 python3-pip python3-venv\n```\n\n#### 2. Install python dependencies\n\nThe build process has a few python packages required that are located in `requirements.txt`.\n\nTo install them simply run in a terminal:\n\n```bash\nmake venv\n```\n\n#### 3. Prepare a base ROM\n\nCopy your ROM to inside `baseroms/` in the version folder corresponding to your ROM's version, and rename the file of the baserom to `baserom.z64`. ex: `baseroms/jp/baserom.z64`\n\n#### 4. Make and Build the ROM\n\nTo start the extraction/build process, run the following command:\n\n```bash\nmake setup\nmake extract\nmake\nmake compress\n```\n\n## Note about licensing\n\nThe contents of the `src` and `include` folders are, as far as possible, licensed under CC0.\n\nOther folders and files in the repository are CC0 unless they specify another license.\n\nThe licensing of this repository does not cover subrepos, namely:\n\n* `tools/asm-differ`\n* `tools/asm-processor`\n* `tools/fado`\n* `lib/ultralib`\n* `tools/z64compress`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeldaret%2Faf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeldaret%2Faf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeldaret%2Faf/lists"}