SevenOfAces/MatchmakerServer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README.md

Browse source
This commit is contained in:
techiesplash 2023-01-15 13:37:10 -08:00
parent 90b9eae405
commit f1a05ca659
1 changed files with 33 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -20,16 +20,41 @@ This is a project for implementing a Matchmaker API into Unity3D.
It can be expanded with custom packets as needed.
<br />
<br />
It depends on another project to be used in Unity. https://github.com/Techiesplash/Matchmaker-API-Client-Unity3d
<br /><br />
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
<br />
![UVS Preview](./Images/preview.png)
<h2>Building</h2>
You can open this in Visual Studio or Visual Studio Code and it should be ready to run immediately.<br />
To compile from the CLI, use 'dotnet build' or 'dotnet build --configuration Release'.
<br /><br />
<h3>Anyone is free to use, copy, modify, merge, publish, distribute, sublicense, or and/or sell copies of the software.</h3>
## 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