1.6 KiB
Setup
This repository supports:
- Linux
- macOS
- Windows Subsystem for Linux 2
- Docker (any host OS)
If you encounter any issues setting up the repo, please feel free to reach out to us on Discord.
Unix
Clone the repository:
git clone https://github.com/pmret/papermario
cd papermario
Install build dependencies:
./install.sh
Copy a Paper Mario (USA) ROM into the root directory of the repository with the name baserom.z64. If you're using WSL, you can enter the Linux filesystem by opening \\wsl$ in File Explorer; e.g. \\wsl$\Ubuntu\home\<your username>\papermario.
Configure the build and extract assets from the base ROM:
./configure.py
Compile the game:
ninja
If you get papermario.z64: OK at the end, the build succeeded!
The output ROM is papermario.z64 - you can run this in an emulator such as Project64.
WSL 2
- Install or upgrade to WSL 2 following these instructions (Ubuntu is recommended)
- Open a WSL terminal
- Run the following command:
sudo apt update && sudo apt upgrade && cd ~ - Continue with the instructions for Linux
If you have Visual Studio Code, you can type code . to open the repo within it.
Ctrl + J opens up a Linux terminal within VS Code.
Docker
A Docker image containing all dependencies can be built and ran as follows:
docker build . -t pm
docker run --rm -ti -v $(pwd):/papermario pm
Then continue with the instructions for Linux.