sm64pc/README.md

17 lines
904 B
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-08 06:26:21 +00:00
## Features
* Native rendering. You can now play SM64 without the need of an emulator.
* Variable aspect ratio and resolution. The game can now correctly render at basically any window size.
* Native xinput controller support. On Linux, DualShock 4 has been confirmed to work plug-and-play.
2020-05-10 18:09:40 +00:00
* Analog camera control and mouse look. (Activate with `make BETTERCAMERA=1`.)
2020-05-08 06:26:21 +00:00
2020-05-07 16:28:34 +00:00
## Building
2020-05-10 14:03:43 +00:00
For building instructions, please refer to the [wiki](https://github.com/sm64pc/sm64pc/wiki).
2020-05-10 19:50:48 +00:00
Windows users: do not attempt to compile with `WINDOWS_BUILD=1` under WSL. It will NOT work. Follow the guide on the wiki.