Skip to content

Commit 971daef

Browse files
readme + doc cleanup (#921)
1 parent f68ec8b commit 971daef

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

Documentation/Unity-Relay/README.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
### Made with and Including Utilities for Netcode for GameObjects
66
<br>
77

8-
[![UnityVersion](https://img.shields.io/badge/Unity%20Version:-6000.0.44f1%20LTS-57b9d3.svg?logo=unity&color=2196F3)](https://unity.com/releases/editor/whats-new/6000.0.44)
9-
[![NetcodeVersion](https://img.shields.io/badge/Netcode%20Version:-2.2.0-57b9d3.svg?logo=unity&color=2196F3)](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/releases/tag/ngo%2F2.2.0)
10-
[![LatestRelease](https://img.shields.io/badge/Latest%20Github%20Release:-v2.6.0-57b9d3.svg?logo=github&color=brightgreen)](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases/tag/v2.6.0)
8+
[![UnityVersion](https://img.shields.io/badge/Unity%20Version:-6000.0.52f1%20LTS-57b9d3.svg?logo=unity&color=2196F3)](https://unity.com/releases/editor/whats-new/6000.0.52)
9+
[![NetcodeVersion](https://img.shields.io/badge/Netcode%20Version:-2.4.3-57b9d3.svg?logo=unity&color=2196F3)](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/releases/tag/v2.4.3)
10+
[![LatestRelease](https://img.shields.io/badge/Latest%20Github%20Release:-v2.5.0-57b9d3.svg?logo=github&color=brightgreen)](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases/tag/v2.5.0)
1111
<br><br>
1212

1313
Boss Room is a fully functional co-op multiplayer RPG made with Unity Netcode. It is an educational sample designed to showcase typical netcode [patterns](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom-actions/index.html) that are frequently featured in similar multiplayer games.
@@ -56,12 +56,12 @@ For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/A
5656
- ### [Testing multiplayer](#testing-multiplayer-1)
5757
- [Local Multiplayer Setup](#local-multiplayer-setup)
5858
- [Multiplayer over Internet](#multiplayer-over-internet)
59-
- [Relay Setup](#relay-setup)
59+
- [Multiplayer Services Setup](#multiplayer-services-setup)
6060
- ### [Index of resources in this project](#index-of-resources-in-this-project-1)
6161
- [Gameplay](#gameplay)
6262
- [Game Flow](#game-flow)
6363
- [Connectivity](#connectivity)
64-
- [Services (Lobby, Relay, etc)](#services-lobby-relay-etc)
64+
- [Services (Sessions and Authentication)](#services-sessions-authentication)
6565
- [Tools and Utilities](#tools-and-utilities)
6666
- ### [Troubleshooting](#troubleshooting-1)
6767
- [Bugs](#bugs)
@@ -71,7 +71,7 @@ For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/A
7171
- ### [Community](#community-1)
7272
- ### [Feedback Form](#feedback-form-1)
7373
- ### [Other samples](#other-samples-1)
74-
- [Bite-size Samples](#bite-size-samples)
74+
- [Bitesize Samples](#bitesize-samples)
7575
</details>
7676

7777
------
@@ -167,7 +167,7 @@ It is possible to connect between multiple instances of the same executable OR b
167167
Running the game over internet currently requires setting up a relay.
168168

169169

170-
### Relay Setup
170+
### Multiplayer Services Setup
171171

172172
- Boss Room uses the Multiplayer Services Package to integrate [Sessions](https://docs.unity.com/ugs/en-us/manual/mps-sdk/manual) for grouping and connecting players.
173173

@@ -248,7 +248,6 @@ Running the game over internet currently requires setting up a relay.
248248
* Netcode hooks - [Packages/com.unity.multiplayer.samples.coop/Utilities/Net/NetcodeHooks.cs ](Packages/com.unity.multiplayer.samples.coop/Utilities/Net/NetcodeHooks.cs)
249249
* Spawner for in-scene objects - [Packages/com.unity.multiplayer.samples.coop/Utilities/Net/NetworkObjectSpawner.cs ](Packages/com.unity.multiplayer.samples.coop/Utilities/Net/NetworkObjectSpawner.cs)
250250
* Session manager for reconnection - [Packages/com.unity.multiplayer.samples.coop/Utilities/Net/SessionManager.cs ](Packages/com.unity.multiplayer.samples.coop/Utilities/Net/SessionManager.cs)
251-
* Relay utils - [Packages/com.unity.multiplayer.samples.coop/Utilities/Net/UnityRelayUtilities.cs ](Packages/com.unity.multiplayer.samples.coop/Utilities/Net/UnityRelayUtilities.cs)
252251
* Client authority - [Packages/com.unity.multiplayer.samples.coop/Utilities/Net/ClientAuthority/](Packages/com.unity.multiplayer.samples.coop/Utilities/Net/ClientAuthority/)
253252
* Scene utils with synced loading screens - [Packages/com.unity.multiplayer.samples.coop/Utilities/SceneManagement/ ](Packages/com.unity.multiplayer.samples.coop/Utilities/SceneManagement/)
254253
* RNSM custom config - [Packages/com.unity.multiplayer.samples.coop/Utilities/Net/RNSM/CustomNetStatsMonitorConfiguration.asset ](Packages/com.unity.multiplayer.samples.coop/Utilities/Net/RNSM/CustomNetStatsMonitorConfiguration.asset)
@@ -303,7 +302,7 @@ Thank you for cloning Boss Room and taking a look at the project. To help us imp
303302
<br><br>
304303

305304
## Other samples
306-
### Bite-size Samples
305+
### Bitesize Samples
307306
- The [Bitesize Samples](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize) repository is currently being expanded and contains a collection of smaller samples and games, showcasing sub-features of NGO. You can review these samples with documentation to understand our APIs and features better.
308307
<br><br>
309308

0 commit comments

Comments
 (0)