Animal Crossing Decompilation

Decompilation in progress of Animal Crossing (GAFE01)

A decompilation of the original N64 version of the game is being worked on here.

Cloning

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

Building

Note

On Windows, the build is known to run disproportionately slow when ran natively, so WSL is recommended.

Docker

1. Dump a copy of the game and extract all files.
2. Place main.dol, foresta.rel.szs, forest_1st.arc, and forest_2nd.arc in dump/.
3. Install Docker.
4. Set up the Docker image. If using MacOS or Linux (including WSL), run chmod +x docker-setup.sh && ./docker-setup.sh. If using Windows, run the docker-setup.bat file.
5. Run configure.py (docker run --rm -v ${PWD}:/ac-decomp ac-decomp python3 configure.py).
6. Run build.py (docker run --rm -v ${PWD}:/ac-decomp ac-decomp python3 build.py).

Build manually

Tip

When building manually from a work directory previously used for Docker, sudo ninja -t clean will need to be ran for the build to execute properly.

1. Dump a copy of the game 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 and extract them to tools/1.3.2/, tools/1.3.2r/, and tools/1.2.5n/, respectively.
4. Install Python, pip, and ninja using a package manager of choice.
   • If using an ARM-based device, cmake will also need to be installed.
5. Install Python modules from requirements.txt (pip install -r requirements.txt).
6. Install 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 the latest GitHub release and run install ./wibo /usr/bin to install it to the system.
7. Install devkitPPC.
   • devkitPro Pacman is needed to get devkitPPC.
     • 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 libultra or equivalent headers. Headers from ultralib can be used.
   • Headers should be located at $N64_SDK/ultra/usr/include.
   • Gpopmtx's param member must be modified to be unsigned int in gbi.h.
9. Run python3 configure.py.
10. Run python3 build.py.

Quick Guides

• Dumping Game Files
• Ghidra Setup
• Generating Decomp Context
• decomp.me Basics
• Ghidra Basics
• m2c Basics
• Decomp Basics

Credits

• jamchamb, Cuyler36, NWPlayer123 and fraser125 for past documentation of Animal Crossing.
• SeekyCt for ppcdis and helping setting up the project.
• msg for helping with tools/map.py.