sm64pc/README.md

# 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. This port has been made possible mostly thanks to [Emill](https://github.com/Emill) and his [n64-fast32-engine](https://github.com/Emill/n64-fast3d-engine/) renderer.


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).*

## 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.
 * Analog camera control and mouse look. (Activate with `make BETTERCAMERA=1`.)
 * An option to disable drawing distances. (Activate with `make NODRAWINGDISTANCE=1`.)
 * In-game control binding, currently available on the `testing` branch.
 * Skip introductory Peach & Lakitu cutscenes with the `--skip-intro` CLI option

## Building
For building instructions, please refer to the [wiki](https://github.com/sm64pc/sm64pc/wiki).

**Do NOT attempt to compile Windows executables with `WINDOWS_BUILD=1` under Linux or WSL. It will NOT work. Follow the guide on the wiki.**
Update README.md 2020-05-07 18:28:34 +02:00			`# sm64pc`
			`OpenGL adaptation of [n64decomp/sm64](https://github.com/n64decomp/sm64).`
init2 2019-08-25 06:46:40 +02:00
Update README.md 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.`
Typo in extract_assets.py Closes #131 2020-05-16 20:42:59 +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-fast32-engine](https://github.com/Emill/n64-fast3d-engine/) renderer.
Add a link to the es_ES README 2020-05-15 05:05:50 +02:00
Added nightly notice. 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.`

Add link to Simplified Chinese readme.md. 2020-05-15 06:32:28 +02:00			`Read this in other languages: [Español](README_es_ES.md) [简体中文](README_zh_CN.md).`
Update README.md 2020-05-07 19:11:38 +02:00
Add features and enhancements. 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.`
Add BETTERCAMERA notice 2020-05-10 20:09:40 +02:00			* Analog camera control and mouse look. (Activate with `make BETTERCAMERA=1`.)
Typo fix 2020-05-14 19:49:05 +02:00			* An option to disable drawing distances. (Activate with `make NODRAWINGDISTANCE=1`.)
Update README.md 2020-05-14 19:47:59 +02:00			* In-game control binding, currently available on the `testing` branch.
Merge branch 'master' into skipintro 2020-05-15 04:05:21 +02:00			* Skip introductory Peach & Lakitu cutscenes with the `--skip-intro` CLI option
Add features and enhancements. 2020-05-08 08:26:21 +02:00
Update README.md 2020-05-07 18:28:34 +02:00			`## Building`
Update README.md 2020-05-10 16:03:43 +02:00			`For building instructions, please refer to the [wiki](https://github.com/sm64pc/sm64pc/wiki).`
Windows build clarifications. 2020-05-10 21:50:48 +02:00
Even more clarification re: WINDOWS_BUILD 2020-05-11 04:38:38 +02:00			Do NOT attempt to compile Windows executables with `WINDOWS_BUILD=1` under Linux or WSL. It will NOT work. Follow the guide on the wiki.