Pokémon Puzzle League

Matching decomp of Pokémon Puzzle League

Progress graph 📈

Dependencies

System packages

The build process has the following package requirements:

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

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 gcc-mips-linux-gnu python3 python3-pip python3-venv

Python dependencies

First you'll need to create a virtual environment for the python packages:

python3 -m venv .venv

To start using the virtual environment on your current terminal run:

. .venv/bin/activate

Take in mind for each new terminal you'll need to active the Python virtual environment again, there's no need to create the virtual environment again.

Now you can install the Python dependencies, to do so run:

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

Rust dependencies

To install Rust run the following command and follow the on-screen instructions

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

The following Rust programs are required by the build process:

• pigment64

To install those programs run the following commands:

cargo install pigment64 --version ">=0.3.0,<1.*"

Building

Copy your big-endian Dr Mario 64 ROM into the repository's root directory and rename it to baserom.usa.z64. Then run

make setup
make extract
make

to download the appropriate compiler versions, build libultra, extract data from the rom using splat, and build the files back into a rom. If successful, the last line of output should say

build/usa/puzzleleague64.usa.z64: OK

Other versions

By default this repository builds the USA version of this game, but it also supports the EUR, FRA and GER versions.

To build other version place your ROM in the root of the repo and rename it to baserom.VER.z64 and pass VERSION=VER to the above make commands (Where VER is either EUR, FRA or GER).

Contributing

TODO: write some contributing guidelines.

Small efforts are appreciated. Just open a PR and try to address any review comments left by other contributors c:

Important note

This matching decomp effort is being done leak-free. If you have looked/worked with leaked materials (i.e. gigaleak) then it's a shame but you can't contribute to this project.

License

The repo is licensed under the MIT license, except for files that may have its own license stated either in the top of the file or are in a folder which has its own LICENSE file.

One notable exception is the src/ folder, which is licensed under the CC0 license.