MatchmakerClient-Unity/README.md

41 lines
2.2 KiB
Markdown
Raw Normal View History

2023-01-15 13:55:38 -08:00
<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/Matchmaker-API-Client-Unity3d)
![GitHub repo size](https://img.shields.io/github/repo-size/Techiesplash/Matchmaker-API-Client-Unity3d)
![GitHub all releases](https://img.shields.io/github/downloads/Techiesplash/Matchmaker-API-Client-Unity3d/total)
![GitHub issues](https://img.shields.io/github/issues/Techiesplash/Matchmaker-API-Client-Unity3d)
![GitHub](https://img.shields.io/github/license/Techiesplash/Matchmaker-API-Client-Unity3d)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/Techiesplash/Matchmaker-API-Client-Unity3d)
<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-Server
<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>Setup</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 Releases.
<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.
<br /><br />
<h3>Anyone is free to use, copy, modify, merge, publish, distribute, sublicense, or and/or sell copies of the software.</h3>