Go to file
Vinícius R. Miguel 0cb29b3012 Update README.md 2020-05-07 20:46:35 +02:00
actors Refresh 7 2020-03-01 22:42:52 -05:00
asm Refresh 8 2020-04-03 14:57:26 -04:00
assets
bin merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
data Refresh 8 2020-04-03 14:57:26 -04:00
doxygen
enhancements Refresh 8 2020-04-03 14:57:26 -04:00
include merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
levels merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
lib merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
sound merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
src add Hotkeys for Fullscreen (ALT+Enter) 2020-05-07 20:46:35 +02:00
text refresh 6 2020-02-03 00:51:26 -05:00
tools merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
.clang-format
.clang-tidy
.gitattributes
.gitignore update .gitignore 2020-05-07 20:46:35 +02:00
CHANGES Refresh 8 2020-04-03 14:57:26 -04:00
Dockerfile incorporate streetster's suggestions 2020-04-02 11:00:05 -07:00
Doxyfile
Jenkinsfile refresh 6 2020-02-03 00:51:26 -05:00
Makefile Update Makefile 2020-05-07 20:46:35 +02:00
Makefile.split Refresh 7 2020-03-01 22:42:52 -05:00
README.md Update README.md 2020-05-07 20:46:35 +02:00
asmdiff.jp.sh merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
asmdiff.us.sh
assets.json Refresh 8 2020-04-03 14:57:26 -04:00
charmap.txt
charmap_menu.txt
diff.py Refresh 8 2020-04-03 14:57:26 -04:00
diff_settings.py Refresh 8 2020-04-03 14:57:26 -04:00
extract_assets.py merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
first-diff.py Refresh 8 2020-04-03 14:57:26 -04:00
format.sh
readme2.txt merge PC port onto the decompile 2020-05-07 20:21:22 +02:00
rename_sym.sh Refresh 7 2020-03-01 22:42:52 -05:00
sm64.eu.sha1
sm64.jp.sha1
sm64.ld Refresh 8 2020-04-03 14:57:26 -04:00
sm64.sh.sha1 Refresh 7 2020-03-01 22:42:52 -05:00
sm64.us.sha1
undefined_syms.txt Refresh 8 2020-04-03 14:57:26 -04:00

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.

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.