MatchmakerClient-Unity/README.md

<div align="center">
  
# Matchmaker-API - Unity3D Client
<br />

![Unity](https://img.shields.io/badge/unity-%23000000.svg?style=for-the-badge&logo=unity&logoColor=white)
![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)
![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)


![GitHub forks](https://img.shields.io/github/forks/Techiesplash/MatchmakerClient)
![GitHub repo size](https://img.shields.io/github/repo-size/Techiesplash/MatchmakerClient)
![GitHub all releases](https://img.shields.io/github/downloads/Techiesplash/MatchmakerClient/total)
![GitHub issues](https://img.shields.io/github/issues/Techiesplash/MatchmakerClient)

![GitHub](https://img.shields.io/github/license/Techiesplash/MatchmakerClient)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/Techiesplash/MatchmakerClient)

<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/MatchmakerServer
<br />

![UVS Preview](./Images/preview.png)

<h2>Installation</h2>
To start, you can either download this project as a .ZIP file and place the files in your project,
or you can click on your Project files in Unity Editor and use Import > Custom Package and import a package from the latest Release.
<br /><br />
This includes Visual Scripting support. If you want to use this feature, ensure VIsual Scripting is enabled in Project Settings > Visual Scripting. You may also need to regenerate the nodes in Project Settings > Visual Scripting > Regenerate Nodes.

## 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/MatchmakerClient/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details