Wrote a CONTRIBUTING.md.

This commit is contained in:
2020-08-31 03:47:56 +02:00
parent 5f10718315
commit 4ade533f40
2 changed files with 88 additions and 1 deletions

View File

@@ -70,7 +70,7 @@ This just works if you're all under the same LAN, but if you want to play over t
If you're in a region in which Turner's CDN doesn't still have the game's assets cached, you won't be able to play the game in its default configuration.
You'll need to obtain the necessary assets elsewhere and set up your own local web server to host them, because unlike web browsers, the game itself cannot interpret the `file://` schema, and will thus need the assets hosted on an actual HTTP server.
Don't forget to point `assetInfo.php` to where you're hosting the assets and change the `src` param of both the `<embed>` tag and the `<object>` tag in `FreeClient/resources/files/index.html` to where you're hosting the `.unity3d` entrypoint.
Don't forget to point `assetInfo.php` to where you're hosting the assets and change the `src` param of both the `<embed>` tag and the `<object>` tag in `FreeClient/resources/app/files/index.html` to where you're hosting the `.unity3d` entrypoint.
If you change `loginInfo.php` or `assetInfo.php`, make sure not to put any newline characters (or any other whitespace) at the end of the file(s).
Some modern IDEs/text editors do this automatically. If all else fails, use Notepad.
@@ -87,6 +87,10 @@ A detailed compilation guide is available for Windows users in the wiki [using M
A detailed guide is available [in the wiki](https://github.com/OpenFusionProject/OpenFusion/wiki/Compilation-with-CMake-or-Visual-Studio) for people using regular old CMake or the version of CMake that comes with Visual Studio. tl;dr: `cmake -B build`
## Contributing
If you'd like to contribute to this project, please read [CONTRIBUTING.md](CONTRIBUTING.md).
## "Gameplay"
Notice the quotes. This is not a full-fledged game that can be played.