Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ACreTeam/ac-decomp

Decompilation in progress of Animal Crossing for the Nintendo GameCube.
https://github.com/ACreTeam/ac-decomp

Last synced: 30 days ago
JSON representation

Decompilation in progress of Animal Crossing for the Nintendo GameCube.

Host: GitHub
URL: https://github.com/ACreTeam/ac-decomp
Owner: ACreTeam
License: cc0-1.0
Created: 2022-12-17T16:06:06.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-10-29T12:35:32.000Z (about 1 month ago)
Last Synced: 2024-10-29T14:46:08.737Z (about 1 month ago)
Language: C
Size: 10.5 MB
Stars: 362
Watchers: 26
Forks: 21
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-gamecube-development - Animal Crossing - An in-progress decompilation of _Animal Crossing_ (Reverse Engineering / Projects)

README

        # Animal Crossing Decompilation [![Discord Channel][discord-badge]][discord] ![rel progress] ![dol progress]

[discord]: https://discord.gg/hKx3FJJgrV

[discord-badge]: https://img.shields.io/discord/727908905392275526?color=%237289DA&logo=discord&logoColor=%23FFFFFF

[rel progress]: https://img.shields.io/endpoint?label=rel&url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Fanimalcrossing%2Fus%2Frel%2F%3Fmode%3Dshield%26measure%3Dcode

[dol progress]: https://img.shields.io/endpoint?label=dol&url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Fanimalcrossing%2Fus%2Fdol%2F%3Fmode%3Dshield%26measure%3Dcode

Decompilation in progress of Animal Crossing (GAFE01)

A decompilation of the original N64 version of the game is being worked on [here](https://github.com/zeldaret/af).

## Cloning

Use `--recursive` when cloning to have ppcdis in the repository. 

## Building

> ℹ️ When using Windows, it's recommended to use WSL.

### Docker

1. [Dump a copy of the game](./docs/extract_game.md) and extract all files.

2. Place **main.dol**, **foresta.rel.szs**, **forest_1st.arc**, and **forest_2nd.arc** in *dump/*.

3. 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.

4. Install Docker.

5. Build the Docker image (`docker build -t ac-decomp .`).

6. Run configure.py (`docker run --rm -v ${PWD}:/ac-decomp ac-decomp python3 configure.py`).

7. Run build.py (`docker run --rm -v ${PWD}:/ac-decomp ac-decomp python3 build.py`).

### Build manually

> ℹ️ 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.

1. [Dump a copy of the game](./docs/extract_game.md) and extract all files.

2. Place **main.dol**, **foresta.rel.szs**, **forest_1st.arc**, and **forest_2nd.arc** in *dump/*.

3. 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.

4. Install Python, pip, and [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages#package-managers) using your package manager of choice.

5. Install Python modules from requirements.txt (`pip install -r requirements.txt`).

6. Install version 0.6.13 of [wibo](https://github.com/decompals/wibo)

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

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

7. Install devkitPPC.

    - To get devkitPPC, you'll need [devkitPro Pacman](https://devkitpro.org/wiki/devkitPro_pacman#Installing_devkitPro_Pacman).

        - Run `dkp-pacman -S devkitPPC` once dkp-pacman is installed to install devkitPPC.

        - Set the `DEVKITPPC` environment variable to */opt/devkitpro/devkitPPC*.

8. 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).

    - Headers should be located at `$N64_SDK/ultra/usr/include`.

    - You must modify `Gpopmtx`'s `param` member to be `unsigned int` in **gbi.h**.

9. Run `python3 configure.py`.

10. Run `python3 build.py`.

## Quick Guides

- [Dumping Game Files](./docs/extract_game.md)

- [Ghidra Setup](./docs/ghidra_setup.md)

- [Generating Decomp Context](./docs/generating_decomp_context.md)

- [decomp.me Basics](./docs/decomp_me_basics.md)

- [Ghidra Basics](./docs/ghidra_basics.md)

- [m2c Basics](./docs/m2c_basics.md)

- [Decomp Basics](./docs/decomp_basics.md)

## Credits

- jamchamb, Cuyler36, NWPlayer123 and fraser125 for past documentation of Animal Crossing.

- SeekyCt for [ppcdis](https://github.com/SeekyCt/ppcdis/) and helping setting up the project.

- msg for helping with *tools/map.py*.