sm64pc/README.md

30 lines
1.9 KiB
Markdown
Raw Normal View History

2020-05-07 18:28:34 +02:00
# sm64pc
OpenGL adaptation of [n64decomp/sm64](https://github.com/n64decomp/sm64).
2019-08-25 06:46:40 +02:00
2020-05-07 19:11:38 +02:00
Feel free to report bugs and contribute, but remember, there must be **no upload of any copyrighted asset**.
2020-05-19 17:00:33 +02:00
Run `./extract_assets.py --clean && make clean` or `make distclean` to remove ROM-originated content. This port has been made possible mostly thanks to [Emill](https://github.com/Emill) and his [n64-fast3d-engine](https://github.com/Emill/n64-fast3d-engine/) renderer.
2020-05-15 05:05:50 +02:00
2020-05-16 23:37:08 +02:00
Please contribute **first** to the [nightly branch](https://github.com/sm64pc/sm64pc/tree/nightly/). New functionality will be merged to master once they're considered to be well-tested.
*Read this in other languages: [Español](README_es_ES.md) [简体中文](README_zh_CN.md).*
2020-05-07 19:11:38 +02:00
2020-05-08 08:26:21 +02: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 20:09:40 +02:00
* Analog camera control and mouse look. (Activate with `make BETTERCAMERA=1`.)
2020-05-14 19:49:05 +02:00
* An option to disable drawing distances. (Activate with `make NODRAWINGDISTANCE=1`.)
2020-05-19 17:00:33 +02:00
* Model and texture fixes. (Activate with `make TEXTURE_FIX=1`.)
* In-game control binding.
2020-05-15 04:05:21 +02:00
* Skip introductory Peach & Lakitu cutscenes with the `--skip-intro` CLI option
2020-05-19 17:00:33 +02:00
* Disabling the HUD.
2020-05-19 01:02:03 +02:00
* Cheats menu in Options. (Activate with `--cheats`) Please note that if a cheat asks you to press "L" it's referring to the N64 button. Check your bindings and make sure you have the "L" button mapped to a button in your controller.
* Text-based save support. (Activate with `make TEXTSAVES=1`.)
2020-05-08 08:26:21 +02:00
2020-05-07 18:28:34 +02:00
## Building
2020-05-10 16:03:43 +02:00
For building instructions, please refer to the [wiki](https://github.com/sm64pc/sm64pc/wiki).
2020-05-10 21:50:48 +02:00
**Make sure you have MXE first before attempting to compile for Windows on Linux and WSL. Follow the guide on the wiki.**