Merge pull request #37 from expected-ingot/expected-ingot-patch-1

make the README clearer, fix grammar and add how to compile manually
This commit is contained in:
Agent X 2023-12-27 17:23:46 -05:00 committed by GitHub
commit b01f4284ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,14 +1,14 @@
# sm64coopdx
Online multiplayer mod for SM64 that synchronizes all entities and every level for multiple players. Fork of [sm64ex-coop](https://github.com/djoslin0/sm64ex-coop).
Online multiplayer mod for the Super Mario 64 PC port that synchronizes all entities and every level for multiple players. Fork of [sm64ex-coop](https://github.com/djoslin0/sm64ex-coop).
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 clear ROM assets, however this is unnecessary for contributing because the .gitignore file already excludes ROM assets.
## How to Play
[Instructions on how to play are available on the wiki.](https://github.com/djoslin0/sm64ex-coop/wiki/How-to-Play)
The easiest way to play is by using [coopdx-patcher](https://github.com/coop-deluxe/coopdx-patcher/releases/latest/download/coopdx-patcher.exe). Simply drag and drop your ROM into the program or run `coopdx-patcher "your_rom_name.z64"`.
- The easiest way to play is by using [coopdx-patcher](https://github.com/coop-deluxe/coopdx-patcher/releases/latest/download/coopdx-patcher.exe)
However, if you need to, you can compile yourself by following the [sm64ex-coop tutorial](https://github.com/djoslin0/sm64ex-coop/wiki/How-to-Play) and replacing the sm64ex-coop links with the sm64coopdx repository.
## Goal (accomplished)
Create a mod for the PC port where multiple people can play together online.