sm64-mirrors/sm64plus
1
0
Fork 0
mirror of https://github.com/MorsGames/sm64plus.git synced 2025-01-22 15:42:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Mors 2021-03-26 13:02:11 +03:00 committed by GitHub
parent d8458f7ddc
commit 0e35c7fabf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -16,19 +16,19 @@ To learn about all the options, visit the [Wiki](https://github.com/MorsGames/sm
This repo does **not** include all the assets necessary for compiling the game. A prior copy of the game is required to extract the assets. Binaries of the game will **not** be distributed for this very reason.
That being said, there is an official launcher that will help you build the game and configure its settings easily. You can download it from the releases section. It is for Windows only.
That being said, there is an official launcher that will help you build the game and configure its settings easily. You can download it from MFGG (once it's out). It is for 64-bit Windows systems only.
You can also build the game manually if you prefer to, or if you're not on a Windows platform. To do that, follow the instructions in the [Wiki](https://github.com/MorsGames/sm64-port/wiki).
You can also build the game manually if you prefer to do so, or if you're not on a Windows platform. To do that, follow the following instructions.
## Building native executables
## Manual Building
### Windows
1. Install and update MSYS2, following the directions listed on https://www.msys2.org/.
2. Launch MSYS2 MinGW and install required packages depending on your machine (do **NOT** launch "MSYS2 MSYS"):
* 64-bit: Launch "MSYS2 MinGW 64-bit" and install: `pacman -S git make python3 mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2 mingw-w64-x86_64-glew`
* 32-bit (will also work on 64-bit machines): Launch "MSYS2 MinGW 32-bit" and install: `pacman -S git make python3 mingw-w64-i686-gcc mingw-w64-i686-SDL2 mingw-w64-i686-glew`
* Do **NOT** install `gcc`.
* 32-bit (untested, but should also work on 64-bit machines): Launch "MSYS2 MinGW 32-bit" and install: `pacman -S git make python3 mingw-w64-i686-gcc mingw-w64-i686-SDL2 mingw-w64-i686-glew`
* Do not install `gcc`.
3. Clone the repo with `git clone https://github.com/MorsGames/sm64-port.git`, then enter it with `cd sm64-port`.
4. Place a *Super Mario 64* ROM called `baserom.us.z64` into the project folder for asset extraction.
5. Run `make` to build. You can add `-j4` to improve build speed (hardware dependent based on the amount of CPU cores available).
@ -44,16 +44,15 @@ You can also build the game manually if you prefer to, or if you're not on a Win
## Additional options
* You can apply the 60FPS patch by using `tools/apply_patch.sh "enhancements/60fps.patch"`. If you get an error, try using `pacman -S patch` first.
* You can target OpenGL by using `make ENABLE_OPENGL=1`. **CURRENTLY NONFUNCTIONAL!** Help is needed to fix this!
## Credits.
- **Mors:** Most things.
- **Mors:** Most new things you see here.
- **[sm64-port](https://github.com/sm64-port/sm64-port) Team:** The port that was used as a base for this project.
- **[SM64 Decompilation](https://github.com/n64decomp/sm64) Team:** The original decompilation used for this project.
- **[A bunch of clever folks](https://github.com/n64decomp/sm64):** The original decompilation used for the port.
- **Emil:** The original 60FPS patch.
- **Kaze Emanuar:** Providing certain bug fixes.
Parts of [sm64ex](https://github.com/sm64pc/sm64ex) were also used as reference for this project.
Parts of [sm64ex](https://github.com/sm64pc/sm64ex) were also used as a reference for this project.
Please let me know if I'm forgetting to credit you.