sm64pc/README.md

61 lines
1.8 KiB
Markdown
Raw Normal View History

2020-05-07 16:28:34 +00:00
# sm64pc
OpenGL adaptation of [n64decomp/sm64](https://github.com/n64decomp/sm64).
2019-08-25 04:46:40 +00:00
2020-05-07 17:11:38 +00:00
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.
2020-05-07 16:28:34 +00:00
## Building
2019-08-25 04:46:40 +00:00
2020-05-07 16:28:34 +00:00
### On Linux
2019-08-25 04:46:40 +00:00
2019-09-01 19:50:50 +00:00
#### 1. Copy baserom(s) for asset extraction
2020-05-07 17:11:38 +00:00
For each version (jp/us/eu) that you want to build an executable for, put an existing ROM at
2019-08-25 04:46:40 +00:00
`./baserom.<version>.z64` for asset extraction.
2019-09-01 19:50:50 +00:00
#### 2. Install build dependencies
The build system has the following package requirements:
2020-05-07 16:28:34 +00:00
* python3 >= 3.6
* libsdl2-dev
* [audiofile](https://audiofile.68k.org/)
* libglew-dev
* git
2019-08-25 04:46:40 +00:00
2020-05-07 16:28:34 +00:00
__Debian / Ubuntu - targeting 32 bits__
2019-08-25 04:46:40 +00:00
```
2020-05-07 16:28:34 +00:00
sudo apt install build-essential git python3 libaudiofile-dev libglew-dev:i386 libsdl2-dev:i386
2019-08-25 04:46:40 +00:00
```
2020-05-07 16:28:34 +00:00
__Debian / Ubuntu - targeting 64 bits__
2019-08-25 04:46:40 +00:00
```
2020-05-07 16:28:34 +00:00
sudo apt install build-essential git python3 libaudiofile-dev libglew-dev libsdl2-dev
2019-08-25 06:41:24 +00:00
```
2019-08-25 04:46:40 +00:00
2020-05-07 16:45:21 +00:00
__Arch Linux__
```
sudo pacman -S base-devel python audiofile sdl2 glew
2020-05-07 16:45:21 +00:00
```
#### 3. Build the executable.
Run `make` to build (defaults to `VERSION=us`)
```
2020-05-07 17:11:38 +00:00
make VERSION=jp -j6 # build (J) version with 6 jobs
2020-05-07 16:45:21 +00:00
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](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
Then follow the instructions of the Linux section above. It's also possible to build using [MinGW](http://www.mingw.org/), but it tends to be considerably more difficult.
### Current issues
2019-08-25 04:46:40 +00:00
2020-05-07 16:28:34 +00:00
* Support for the EU version is still experimental.
* There seems to be savedata-related problems on some 64-bits builds.
2020-05-07 17:11:38 +00:00
* Camera controls are also bugged for some.