Animal Forest

- WARNING! -

This repository is a work in progress, and while it can be used to make certain changes, it's 
still constantly evolving. If you wish to use it for modding purposes in its current state,
please be aware that the codebase could drastically change at any time. Also note that some
parts of the ROM may not be 'shiftable' yet, so modifying them could currently be difficult.

Setup

Linux

1. Install build dependencies

The build process has the following package requirements:

• make
• git
• build-essential
• clang
• binutils-mips-linux-gnu
• python3
• pip3

Under Debian / Ubuntu (which we recommend using), you can install them with the following commands:

sudo apt update
sudo apt install make git build-essential clang binutils-mips-linux-gnu python3 python3-pip

2. Install python dependencies

The build process has a few python packages required that are located in requirements.txt.

To install them simply run in a terminal:

python3 -m pip install -U -r requirements.txt

3. Prepare a base ROM

Copy your ROM to inside the root of this new project directory, and rename the file of the baserom to reflect the version of ROM you are using. ex: baserom.jp.z64

4. Make and Build the ROM

To start the extraction/build process, run the following command:

make setup
make extract
make

Note about licensing

The contents of the src and include folders are, as far as possible, licensed under CC0.

Other folders and files in the repository are CC0 unless they specify another license.

The licensing of this repository does not cover subrepos, namely:

• tools/asm-differ
• tools/asm-processor
• tools/fado
• tools/splat
• lib/ultralib