af

(โ˜… 290)

Decompilation of Animal Forest

  • .clang-format
  • .clang-tidy
  • .gitignore
  • CONTRIBUTING.md
  • decomp.yaml
  • diff.py
  • diff_settings.py
  • LICENSE
  • Makefile
  • README.md
  • requirements.txt

# Installation Guide

1. Get the code
git clone https://github.com/zeldaret/af

Downloads the entire project code from GitHub to your computer.

cd af

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
sudo apt install make git build-essential clang binutils-mips-linux-gnu python3 python3-pip python3-venv

Installs directly from the APT package repository (Debian/Ubuntu-based).

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
sudo apt install make git build-essential clang binutils-mips-linux-gnu python3 python3-pip python3-venv

Installs directly from the APT package repository (Debian/Ubuntu-based).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd tools/asm-processor/rust

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make venv

Compiles the code based on the generated build configuration to produce an executable.

make setup

Compiles the code based on the generated build configuration to produce an executable.

make extract

Compiles the code based on the generated build configuration to produce an executable.

make

Compiles the code based on the generated build configuration to produce an executable.

make compress

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation