Super Mario 64 OpenGL port for PC. Mirror of https://github.com/sm64pc/sm64pc https://github.com/sm64pc/sm64pc
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Vinícius R. Miguel 74635cdc39 Update issue templates 2 years ago
.github/ISSUE_TEMPLATE Update issue templates 2 years ago
actors Refresh 7 3 years ago
asm Refresh 8 3 years ago
assets Refresh 3 3 years ago
bin merge PC port onto the decompile 2 years ago
data Refresh 8 3 years ago
doxygen init2 3 years ago
enhancements Refresh 8 3 years ago
include merge PC port onto the decompile 2 years ago
levels merge PC port onto the decompile 2 years ago
lib merge PC port onto the decompile 2 years ago
sound merge PC port onto the decompile 2 years ago
src add Hotkeys for Fullscreen (ALT+Enter) 2 years ago
text refresh 6 3 years ago
tools merge PC port onto the decompile 2 years ago
.clang-format Refresh 1 3 years ago
.clang-tidy Refresh 1 3 years ago
.gitattributes Refresh 1 3 years ago
.gitignore update .gitignore 2 years ago
CHANGES Refresh 8 3 years ago
Dockerfile incorporate streetster's suggestions 3 years ago
Doxyfile refresh 4 3 years ago
Jenkinsfile refresh 6 3 years ago
Makefile Update Makefile 2 years ago
Makefile.split Refresh 7 3 years ago
README.md Update README to include webassembly build info 2 years ago
asmdiff.jp.sh merge PC port onto the decompile 2 years ago
asmdiff.us.sh init2 3 years ago
assets.json Refresh 8 3 years ago
charmap.txt refresh 5 3 years ago
charmap_menu.txt refresh 5 3 years ago
diff.py Refresh 8 3 years ago
diff_settings.py Refresh 8 3 years ago
extract_assets.py merge PC port onto the decompile 2 years ago
first-diff.py Refresh 8 3 years ago
format.sh init2 3 years ago
readme2.txt merge PC port onto the decompile 2 years ago
rename_sym.sh Refresh 7 3 years ago
sm64.eu.sha1 init2 3 years ago
sm64.jp.sha1 init2 3 years ago
sm64.ld Refresh 8 3 years ago
sm64.sh.sha1 Refresh 7 3 years ago
sm64.us.sha1 init2 3 years ago
undefined_syms.txt Refresh 8 3 years ago

README.md

sm64pc

OpenGL adaptation of n64decomp/sm64.

Feel free to report bugs and contribute, but remember, there must be no upload of any copyrighted asset. Run ./extract-assets.py --clean && make clean or make distclean to remove ROM-originated content.

Building

On Linux

1. Copy baserom(s) for asset extraction

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

2. Install build dependencies

The build system has the following package requirements:

  • python3 >= 3.6
  • libsdl2-dev
  • audiofile
  • libglew-dev
  • git

Debian / Ubuntu - targeting 32 bits

sudo apt install build-essential git python3 libaudiofile-dev libglew-dev:i386 libsdl2-dev:i386

Debian / Ubuntu - targeting 64 bits

sudo apt install build-essential git python3 libaudiofile-dev libglew-dev libsdl2-dev

Arch Linux

sudo pacman -S base-devel python audiofile sdl2 glew

3. Build the executable.

Run make to build (defaults to VERSION=us)

make VERSION=jp -j6                 # build (J) version with 6 jobs
make VERSION=us WINDOWS-BUILD=1     # builds a (U) Windows executable 

On Windows

Install WSL with a distro of your choice (Ubuntu 18.04 recommended) following the official guide.

Then follow the instructions of the Linux section above. It's also possible to build using MinGW, but it tends to be considerably more difficult.

For the web

The game can be compiled for web browsers that support webassembly using emscripten. To do so, install emsdk and run make TARGET_WEB=1.

Current issues

  • Support for the EU version is still experimental.
  • There seems to be savedata-related problems on some 64-bits builds.
  • Camera controls are also bugged for some.