Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 2.49 KB

SETUP.md

File metadata and controls

96 lines (72 loc) · 2.49 KB
Raw

Setup

This repository supports:

If you encounter any issues setting up the repo, please feel free to reach out to us on Discord.

Common

Clone the repository:

git clone git@github.com:JCog/pm-chaos-edition.git
cd pm-chaos-edition

Install pigment64 (our image-processing tool)

curl https://sh.rustup.rs -sSf | sh
cargo install pigment64

and make sure pigment64 is in your system path.

Unix

Install build dependencies:

./install_deps.sh
./install_compilers.sh

NOTE: On Mac, if you get an error that looks like

Error: Cannot install md5sha1sum because conflicting formulae are installed.
 coreutils: because both install `md5sum` and `sha1sum` binaries

Please `brew unlink coreutils` before continuing.

it's fine to just open install_deps.sh in a text editor, delete the md5sha1sum from the brew install line, and rerun it (put it back after so you don't accidentally commit it!)

Continue onto building

WSL 2

  1. Install or upgrade to WSL 2 following these instructions (Ubuntu is recommended)
  2. Open a WSL terminal
  3. Run the following command: sudo apt update && sudo apt upgrade && cd ~
  4. Install build dependencies:
./install_deps.sh
./install_compilers.sh
  1. Continue with building

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.

Nix

  1. Install Nix
  2. Clone the repository and cd into it
  3. Enter a shell with NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1 NIX_BUILD_CORES=0 nix-shell
  4. Continue with building

Building

Copy baserom into the following place:

  • ver/us/baserom.z64 (sha1: 3837f44cda784b466c9a2d99df70d77c322b97a0)

(If you're using WSL, you can enter the Linux filesystem by opening \\wsl$ in File Explorer; e.g. \\wsl$\Ubuntu\home\<your username>\pm-chaos-edition.)

Configure the build and extract assets from the base ROM:

./configure

Compile the game:

ninja

The output ROM is ver/us/build/papermario.z64 - you can run this in any N64 emulator.

Alternative, to compile and run, you can use the run script:

./run

(This will search known paths for an emulator. If your emulator isn't listed, add it to the list and contribute!)

You can now begin modding.