sm64coopdx/README.md

31 lines
2.2 KiB
Markdown
Raw Normal View History

2020-06-19 20:42:57 +00:00
# sm64ex
Fork of [sm64-port/sm64-port](https://github.com/sm64-port/sm64-port) with additional features.
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**.
2020-06-19 20:42:57 +00:00
Run `./extract_assets.py --clean && make clean` or `make distclean` to remove ROM-originated content.
2020-05-15 03:05:50 +00:00
2020-06-19 20:42:57 +00:00
Please contribute **first** to the [nightly branch](https://github.com/sm64pc/sm64ex/tree/nightly/). New functionality will be merged to master once they're considered to be well-tested.
2020-05-16 21:37:08 +00:00
2020-06-11 01:41:29 +00:00
*Read this in other languages: [Español](README_es_ES.md), [Português](README_pt_BR.md) or [简体中文](README_zh_CN.md).*
2020-05-07 17:11:38 +00:00
2020-06-19 20:42:57 +00:00
## New features
2020-05-08 06:26:21 +00:00
2020-06-19 20:42:57 +00:00
* Options menu with various settings, including button remapping.
* Optional external data loading (so far only textures and assembled soundbanks), providing support for custom texture packs.
* Optional analog camera and mouse look (using [Puppycam](https://github.com/FazanaJ/puppycam)).
* Optional OpenGL1.3-based renderer for older machines, as well as the original GL2.1, D3D11 and D3D12 renderers from Emill's [n64-fast3d-engine](https://github.com/Emill/n64-fast3d-engine/).
* Option to disable drawing distances.
2020-06-19 20:43:40 +00:00
* Optional model and texture fixes (e.g. the smoke texture).
2020-05-15 02:05:21 +00:00
* Skip introductory Peach & Lakitu cutscenes with the `--skip-intro` CLI option
2020-06-19 20:42:57 +00:00
* Cheats menu in Options (activate with `--cheats` or by pressing L thrice in the pause menu).
* Support for both little-endian and big-endian save files (meaning you can use save files from both sm64-port and most emulators), as well as an optional text-based save format.
Recent changes in Nightly have moved the save and configuration file path to `%HOMEPATH%\AppData\Roaming\sm64pc` on Windows and `$HOME/.local/share/sm64pc` on Linux. This behaviour can be changed with the `--savepath` CLI option.
For example `--savepath .` will read saves from the current directory (which not always matches the exe directory, but most of the time it does);
2020-06-05 18:19:44 +00:00
`--savepath '!'` will read saves from the executable directory.
2020-05-08 06:26:21 +00:00
2020-05-07 16:28:34 +00:00
## Building
2020-06-19 20:42:57 +00:00
For building instructions, please refer to the [wiki](https://github.com/sm64pc/sm64ex/wiki).
2020-05-10 19:50:48 +00:00
**Make sure you have MXE first before attempting to compile for Windows on Linux and WSL. Follow the guide on the wiki.**