72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
# sm64pc
|
|
OpenGL adaptation of [n64decomp/sm64](https://github.com/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](https://audiofile.68k.org/)
|
|
* 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
|
|
```
|
|
|
|
__Void Linux - targeting 64 bits__
|
|
```
|
|
sudo xbps-install -S base-devel python3 audiofile-devel SDL2-devel glew-devel
|
|
```
|
|
|
|
__Void Linux - targeting 32 bits__
|
|
```
|
|
sudo xbps-install -S base-devel python3 audiofile-devel-32bit SDL2-devel-32bit glew-devel-32bit
|
|
```
|
|
|
|
#### 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
|
|
|
|
A full guide is to be written. You can use [mxe](https://mxe.cc/) and MinGW.
|
|
|
|
### For the web
|
|
|
|
The game can be compiled for web browsers that support WebGL using [Emscripten](https://github.com/emscripten-core). To do so, install [emsdk](https://github.com/emscripten-core/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.
|