Build Instructions

The build system has the following package requirements:

binutils-mips >= 2.27
python3 >= 3.6
libaudiofile

To add submodules run git submodule update --init --recursive after cloning.

Run make assets to extract assets.

Linux

Ubuntu

sudo apt install cmake build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev libcapstone-dev

Fedora

sudo dnf install make automake gcc gcc-c++ kernel-devel cmake pkg-config git python3 zlib-devel audiofile-devel capstone

and install gcc toolchain of libdragon and add export PATH="/opt/libdragon/bin:$PATH" to ~/.bashrc

Arch

sudo pacman -S base-devel capstone python

Install the following AUR package:

mips64-elf-binutils (AUR)

Review the n64decomp/sm64 readme for instructions to compile in other distributions.

Windows

Clone the repo or download the zip.
Download and extract the toolchain from here

Setup

Place the mingw64 folder from the toolchain into the tools folder like so: mk64/tools/mingw64.
Open a terminal (cmd or powershell) in the repo folder and run "tools\mingw64\w64devkit.exe" and after make assets && make -j
Wait for the build to finish and Enjoy!

macOS

Install Homebrew, then install the following dependencies:

brew update

brew install python3 capstone coreutils make pkg-config tehzz/n64-dev/mips64-elf-binutils

Build using gmake ensuring homebrew make is used instead of the old macOS system make.

Docker

Build the Docker image:

docker build -t mk64 .

When building and using other tools, append the following in front of every command you run:

docker run --rm -v .:/mk64 mk64

For example:

docker run --rm -v .:/mk64 mk64 make

Building US

Place a US version of Mario Kart 64 called baserom.us.z64 into the project folder for asset extraction.

Run the following commands after pulling:

make -j

Building EU

Building EU requires US to be built first. See above.

mk64 decomp supports two EU versions

EU 1.0 eu.v10
EU 1.1 eu.v11

Build using

make -j VERSION=eu.v10

or

make -j VERSION=eu.v11

First-diff/diff commands for EU

python3 first-diff.py --eu

./diff <function> -eu

Handling Changes

Certain changes may result in unexpected behaviour (frequently related to physics) due to the games obnoxious linker setup. This is resolved by compiling with the AVOID_UB flag.

This will require a rebuild, run

make clean

Then compile like so make -j AVOID_UB=1 or make -j DEBUG=1 // Enables debug mode and avoid_ub

Recompiling .inc.c files requires saving the root .c file for makefile to recognize that the file requires a rebuild. This is because at compile time a inc.c file is essentially copy/pasted into its associated .c file. Therefore makefile does not recognize changes to .inc.c files, only .c files. This may be resolved in the following ways: 1) Search for #include "my_file.inc.c to find the root file and then save it with ctrl+s. 2) make clean and rebuild 3) make my_file.c 4) Find help in the Discord

Table of Contents