MatchmakerServer/README.md
2023-01-15 13:26:28 -08:00

35 lines
1.6 KiB
Markdown
Executable file

<div align="center">
# Matchmaker-API - Server
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
![GitHub forks](https://img.shields.io/github/forks/Techiesplash/Matchmaker-API-Server)
![GitHub repo size](https://img.shields.io/github/repo-size/Techiesplash/Matchmaker-API-Server)
![GitHub all releases](https://img.shields.io/github/downloads/Techiesplash/Matchmaker-API-Server/total)
![GitHub issues](https://img.shields.io/github/issues/Techiesplash/Matchmaker-API-Server)
![GitHub](https://img.shields.io/github/license/Techiesplash/Matchmaker-API-Server)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/Techiesplash/Matchmaker-API-Server)
<h2>Introduction</h2>
This is a project for implementing a Matchmaker API into Unity3D.
<br />
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>