diff --git a/README.md b/README.md index 56de51d..6420d02 100755 --- a/README.md +++ b/README.md @@ -20,16 +20,41 @@ This is a project for implementing a Matchmaker API into Unity3D. It can be expanded with custom packets as needed.

+ It depends on another project to be used in Unity. https://github.com/Techiesplash/Matchmaker-API-Client-Unity3d -

-This project is built upon MIT-Licensed code by Tom Weiland meant for a tutorial series. -Please check out his work: https://github.com/tom-weiland/tcp-udp-networking
![UVS Preview](./Images/preview.png) -

Building

-You can open this in Visual Studio or Visual Studio Code and it should be ready to run immediately.
-To compile from the CLI, use 'dotnet build' or 'dotnet build --configuration Release'. -

-

Anyone is free to use, copy, modify, merge, publish, distribute, sublicense, or and/or sell copies of the software.

+## Installation +Ensure you have the latest .NET SDK and Runtime (7.0) installed. + +First grab the latest release, and extract it to a directory. + +Open that directory in a C# editor such as JetBrains Rider, Visual Studio or Visual Studio Code. + +## Usage +First edit ```Matchmaker/Config.cs```. + +The following settings need to match on both the client and the matchmaker server: + +- Set ```GameId``` to the name of your game. +- Set ```GameVersion``` to the latest version number of your game. Remember to update this as you update your game. + +The rest can be changed at your discretion. + +Now build and run, and it should be done. + +## Authors + +* **Tom Weiland** - *Initial work (TCP/UDP interface)* - [Tom Weiland](https://github.com/tom-weiland) +* **Techiesplash** - *Matchmaker API* - [Techiesplash](https://github.com/Techiesplash) + +This project is built upon MIT-Licensed code by Tom Weiland meant for a tutorial series. +Please check out his work: https://github.com/tom-weiland/tcp-udp-networking + +See also the list of [contributors](https://github.com/Techiesplash/ParentalControls/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details