kirsle
/
sm64pc
1
0
Fork 0
Code Releases Wiki Activity
Super Mario 64 OpenGL port for PC. Mirror of https://github.com/sm64pc/sm64pc https://github.com/sm64pc/sm64pc
4 Commits
1 Branch
0 Tags
18 MiB
C 88.5%
C++ 5.6%
Shell 2.1%
Assembly 1.5%
Makefile 1.4%
Other 0.7%
 
 
 
 
 
 
Go to file
mountainflaw c6102eb802
Merge pull request #1 from bramhaag/patch-2 
Fixed formatting issue in README.md
 		2019-08-25 17:34:16 -04:00
actors init2 2019-08-25 00:46:40 -04:00
asm init2 2019-08-25 00:46:40 -04:00
assets init2 2019-08-25 00:46:40 -04:00
bin init2 2019-08-25 00:46:40 -04:00
data init2 2019-08-25 00:46:40 -04:00
doxygen init2 2019-08-25 00:46:40 -04:00
enhancements init2 2019-08-25 00:46:40 -04:00
include init2 2019-08-25 00:46:40 -04:00
levels init2 2019-08-25 00:46:40 -04:00
lib init2 2019-08-25 00:46:40 -04:00
sound init2 2019-08-25 00:46:40 -04:00
src init2 2019-08-25 00:46:40 -04:00
text init2 2019-08-25 00:46:40 -04:00
tools fix tabledesign 2019-08-25 00:58:46 -04:00
.clang-format init2 2019-08-25 00:46:40 -04:00
.gitignore init2 2019-08-25 00:46:40 -04:00
Doxyfile init2 2019-08-25 00:46:40 -04:00
Jenkinsfile init2 2019-08-25 00:46:40 -04:00
Makefile init2 2019-08-25 00:46:40 -04:00
Makefile.split init2 2019-08-25 00:46:40 -04:00
README.md Fixed formatting issue 2019-08-25 08:41:24 +02:00
asmdiff.jp.sh init2 2019-08-25 00:46:40 -04:00
asmdiff.us.sh init2 2019-08-25 00:46:40 -04:00
assets.json init2 2019-08-25 00:46:40 -04:00
charmap.txt init2 2019-08-25 00:46:40 -04:00
diff-settings.sh init2 2019-08-25 00:46:40 -04:00
diff.sh init2 2019-08-25 00:46:40 -04:00
extract_assets.py init2 2019-08-25 00:46:40 -04:00
first-diff.py init2 2019-08-25 00:46:40 -04:00
format.sh init2 2019-08-25 00:46:40 -04:00
rename_sym.sh init2 2019-08-25 00:46:40 -04:00
sm64.eu.sha1 init2 2019-08-25 00:46:40 -04:00
sm64.jp.sha1 init2 2019-08-25 00:46:40 -04:00
sm64.ld init2 2019-08-25 00:46:40 -04:00
sm64.us.sha1 init2 2019-08-25 00:46:40 -04:00
undefined_syms.txt init2 2019-08-25 00:46:40 -04:00

README.md

Super Mario 64

This repo contains a full decompilation of Super Mario 64 (J) and (U). The source and data have been decompiled but complete naming and documentation all of the code and data is still a work in progress. Decompiling the (E) ROM is also an ongoing effort.

It builds the following ROMs:

  • sm64.jp.z64 sha1: 8a20a5c83d6ceb0f0506cfc9fa20d8f438cafe51
  • sm64.us.z64 sha1: 9bef1128717f958171a4afac3ed78ee2bb4e86ce

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

Installation

Linux

  1. For each version (jp/us/eu) that you want to build a ROM for, put an existing ROM at ./baserom.<version>.z64 for asset extraction.

  2. Install the following packages:

Debian / Ubuntu

  • git
  • binutils-mips-linux-gnu / mips64-elf (>= 2.27)
  • python3 (>= 3.7)
  • build-essential
  • pkg-config
  • zlib1g-dev
  • libaudiofile-dev

Arch Linux

  1. Install qemu-irix

3.a Options: 1. Clone https://github.com/n64decomp/qemu-irix to somewhere and follow its install instructions in the README. 2. Optionally, grab the prebuilt qemu-irix from the Releases section. 3. (Arch) Use AUR package qemu-irix-git

3.b (For options 1 or 2), copy executable qemu-irix from irix-linux-user to somewhere convenient with a relatively short path.

mkdir -p /opt/qemu-irix/bin
cp irix-linux-user/qemu-irix /opt/qemu-irix/bin

3.c Define QEMU_IRIX environment variable in your ~/.bashrc to point to this qemu-irix executable.

export QEMU_IRIX=/opt/qemu-irix/bin/qemu-irix
  1. Run make to build the ROM (defaults to us version). Make sure your path to the repo is not too long or else this process will error, as the emulated IDO compiler cannot handle paths longer than 255 characters. Build examples:
make VERSION=jp -j4       # build (J) version instead with 4 jobs
make VERSION=eu COMPARE=0 # non-matching EU version still WIP

Windows

For Windows, install WSL and a distro of your choice and follow the Linux guide.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Run clang-format on your code to ensure it meets the project's coding standards.

Official discord: https://discord.gg/27JtCWs