n64decomp /sm64

A Super Mario 64 decompilation, brought to you by a bunch of clever folks.

★ 8,974⑂ 1,686👁 240⑃ 83● 0▤ 2
CCC0-1.0Created 2019-06-08discord.gg/DuYH3Fh
Download: qemu-irix binaryirix2 ↓22019-08-25
+1
Daily
8,974
stars
1,686
forks
240
watchers
83
prs
0
issues
2
releases

README

Super Mario 64

- This repo contains a full decompilation of Super Mario 64 of the following releases: Japan (jp), North America (us), Europe (eu), Shindou (sh) and iQue Player (cn).
- Naming and documentation of the source code and data structures are in progress.

It builds the following ROMs:

 sm64.jp.z64 sha1: 8a20a5c83d6ceb0f0506cfc9fa20d8f438cafe51
 sm64.us.z64 sha1: 9bef1128717f958171a4afac3ed78ee2bb4e86ce
 sm64.eu.z64 sha1: 4ac5721683d0e0b6bbb561b58a71740845dceea9
 sm64.sh.z64 sha1: 3f319ae697533a255a1003d09202379d78d5a2e0
 sm64.cn.z64 sha1: 2e1db2780985a1f068077dc0444b685f39cd90ec

This repo does not include all assets necessary for compiling the ROMs.
A prior copy of the game is required to extract the assets.

 Quick Start (for Ubuntu)

1. Install prerequisites: sudo apt install -y binutils-mips-linux-gnu build-essential git pkgconf python3
2. Clone the repo from within Linux: git clone https://github.com/n64decomp/sm64.git
3. Place a Super Mario 64 ROM called baserom..z64 into the project folder for asset extraction, where VERSION can be jp, us, eu, sh, or cn.
4. Run make to build. Specify the version through make VERSION=. Add -j4 to improve build speed (hardware dependent).

Ensure the repo path length does not exceed 255 characters. Long path names result in build errors.

 Installation

 Windows

Install WSL and a distro of your choice following
Windows Subsystem for Linux Installation Guide for Windows 10.
We recommend either Debian or Ubuntu 18.04 Linux distributions under WSL.
Note: WSL1 does not currently support Ubuntu 20.04.

Next, clone the SM64 repo from within the Linux shell:
git clone https://github.com/n64decomp/sm64.git

Then continue following the directions in the Linux installation section below.

 Linux

There are 3 steps to set up a working build.

 Step 1: Install dependencies

The build system has the following package requirements:
  binutils-mips
  pkgconf
  python3 = 3.6

Dependency installation instructions for common Linux distros are provided below:

 Debian / Ubuntu
To install build dependencies:

sudo apt install -y binutils-mips-linux-gnu build-essential git pkgconf python3


 Arch Linux
To install build dependencies:

sudo pacman -S base-devel python

Install the following AUR packages:
 mips64-elf-binutils (AUR)

 Other Linux distributions

Most modern Linux distributions should have equivalent packages to the other two listed above.
You may have to use a different version of GNU binutils. Listed below are fully compatible binutils
distributions with support in the makefile, and examples of distros that offer them:

 mips64-elf- (Arch AUR)
 mips-linux-gnu- (Ubuntu and other Debian-based distros)
 mips64-linux-gnu- (RHEL/CentOS/Fedora)

You may also use Docker to handle installing an image with minimal dependencies.

 Step 2: Copy baserom(s) for asset extraction

For each version (jp/us/eu/sh/cn) for which you want to build a ROM, put an existing ROM at
./baserom..z64 for asset extraction.

 Step 3: 

Latest release

qemu-irix binary irix2 2019-08-25
Removes dependency on libcapstone3. Requires Ubuntu  18.04.

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON