From 73ffdfcaaba7cb96905c30f883d1cfc8684ae7da Mon Sep 17 00:00:00 2001 From: techiesplash Date: Sun, 15 Jan 2023 14:11:35 -0800 Subject: [PATCH] Updated README.md --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9c20fd0..5e6a416 100755 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ ![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 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/Matchmaker-API-Client-Unity3d) -![GitHub release (latest by date)](https://img.shields.io/github/v/release/Techiesplash/Matchmaker-API-Client-Unity3d) +![GitHub](https://img.shields.io/github/license/Techiesplash/MatchmakerClient) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/Techiesplash/MatchmakerClient)

Introduction

This is a project for implementing a Matchmaker API into Unity3D. @@ -23,18 +23,27 @@ 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-Server -

-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 +It depends on another project to be used in Unity. https://github.com/Techiesplash/MatchmakerServecr
![UVS Preview](./Images/preview.png) -

Setup

+

Installation

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. +or you can click on your Project files in Unity Editor and use Import > Custom Package and import a package from the latest Release.

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. -

-

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

+ +## 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