Documentation Index
Fetch the complete documentation index at: https://mintlify.com/pmret/papermario/llms.txt
Use this file to discover all available pages before exploring further.
This page walks you through cloning the papermario repository and installing all dependencies needed to build the project. Choose the tab below that matches your operating system.
If you run into problems at any point, the project Discord at discord.gg/PgcMpQTzh5 is the best place to ask for help. Clone the repository
Start by cloning the repository. This step applies to all platforms except Nix, which has its own clone step below.
git clone https://github.com/pmret/papermario
cd papermario
Install build dependencies
Run the dependency installation script. It detects your Linux distribution (Debian/Ubuntu, Arch, Fedora, openSUSE, Alpine) or macOS and installs the required packages automatically.On macOS, if you see an error about md5sha1sum conflicting with coreutils, open install_deps.sh in a text editor, remove md5sha1sum from the brew install line, rerun the script, then restore the file (do not commit the change). Install the original compilers
Download and install the original IDO compilers used to build Paper Mario: Install pigment64
pigment64 is the project’s image-processing tool. Install it using Rust’s package manager:curl https://sh.rustup.rs -sSf | sh
cargo install pigment64
~/.cargo/bin is on your PATH so that pigment64 is accessible from the shell. Continue to building
Your environment is ready. Head to the building guide to place your base ROM and compile the game. Install or upgrade to WSL 2
Open a WSL terminal and update packages
sudo apt update && sudo apt upgrade && cd ~
Clone the repository
git clone https://github.com/pmret/papermario
cd papermario
Install build dependencies
Install the original compilers
Install pigment64
curl https://sh.rustup.rs -sSf | sh
cargo install pigment64
~/.cargo/bin is on your PATH.Optional: open in VS Code
If you have Visual Studio Code installed, run code . from the repository root to open it inside WSL. Press Ctrl+J to open a Linux terminal within VS Code.
Continue to building
Your environment is ready. Head to the building guide.When you need to copy files into the Linux filesystem from Windows Explorer, navigate to \\wsl$\Ubuntu\home\<your username>\papermario.
Enable experimental features
Clone the repository
git clone https://github.com/pmret/papermario
cd papermario
Add base ROMs to the Nix store
Add all four base ROMs to the Nix store before entering the shell. Replace path/to/ with the actual path to each ROM file on your system.nix store add --mode flat --name papermario.us.z64 --hash-algo sha1 path/to/papermario.us.z64
nix store add --mode flat --name papermario.jp.z64 --hash-algo sha1 path/to/papermario.jp.z64
nix store add --mode flat --name papermario.pal.z64 --hash-algo sha1 path/to/papermario.pal.z64
nix store add --mode flat --name papermario.ique.z64 --hash-algo sha1 path/to/papermario.ique.z64
Enter the Nix development shell
This shell provides all required tools including the compilers and pigment64. You do not need to run install_deps.sh or install_compilers.sh. Continue to building
Your environment is ready. Head to the building guide. You can skip the base ROM placement step there — you already added the ROMs to the Nix store. 