You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
14
+
<br><br>
5
15
16
+
# Boss Room Sample Overview
6
17
7
-
__PLEASE NOTE__:
8
-
Boss Room is compatible with the latest Unity Long Term Support (LTS) editor version, currently [2021 LTS](https://unity.com/releases/2021-lts). Please include standalone support for Windows/Mac in your installation. <br>
18
+
Boss Room is designed to be used in its entirety to help you explore the concepts and patterns behind a multiplayer game flow; such as character abilities, casting animations to hide latency, replicated objects, RPCs, and integration with the [Relay](https://unity.com/products/relay), [Lobby](https://unity.com/products/lobby), and [Authentication](https://unity.com/products/authentication) services.
9
19
10
-
**Boss Room has been developed and tested on the following platforms:**
11
-
- Windows
12
-
- Mac
13
-
- iOS
14
-
- Android <br>
20
+
You can use the project as a reference starting point for your own Unity game or use elements individually.
21
+
<br><br>
15
22
16
-
**Boss Room's min spec devices are:**
17
-
- iPhone 6S
18
-
- Samsung Galaxy J2 Core <br>
19
23
20
-
Find our full project documentation, [here](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom/index.html).
24
+
### Utilities Package
25
+
This repository also contains a [Utilities](Packages/com.unity.multiplayer.samples.coop) package, containing reusable sample scripts. You can install it using the following manifest file entry:
To connect and find support, join the multiplayer community on the Unity [Discord](https://discord.gg/mNgM2XRDpb) and [Forum](https://forum.unity.com/forums/multiplayer.26/).<br> Got feedback? Tell us what you think using our new [Feedback Form](#feedback-form) <center>.
23
-
| -- |
29
+
<br>
24
30
31
+
For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/ART_NOTES.md).
25
32
26
33
27
-
## Contents and Quick Links
34
+
35
+
<br><br>
36
+
37
+
-----
28
38
39
+
## Readme Contents and Quick Links
29
40
<!-- TOC generated from https://luciopaiva.com/markdown-toc/ -->
41
+
<detailsopen>
42
+
<summary> <b>Click to expand/collapse contents</b> </summary>
30
43
31
-
32
-
-[Boss Room Overview](#boss-room-overview)
33
-
-[Getting the project](#getting-the-project)
44
+
-### [Getting the project](#getting-the-project)
34
45
-[Direct download](#direct-download)
35
46
-[Installing Git LFS to clone locally](#installing-git-lfs-to-clone-locally)
36
-
-[Registering the project with Unity Gaming Services (UGS)](#registering-the-project-with-unity-gaming-services-ugs)
37
-
-[Opening the project for the first time](#opening-the-project-for-the-first-time)
38
-
-[Exploring the project](#exploring-the-project)
39
-
-[Testing multiplayer](#testing-multiplayer)
40
-
-[Index of resources in this project](#index-of-resources-in-this-project)
Boss Room is designed to be used in its entirety to help you explore the concepts and patterns behind a multiplayer game flow; such as character abilities, casting animations to hide latency, replicated objects, RPCs, and integration with the [Relay](https://unity.com/products/relay), [Lobby](https://unity.com/products/lobby), and [Authentication](https://unity.com/products/authentication) services.
56
-
57
-
You can use the project as a reference starting point for your own Unity game or use elements individually.
58
-
59
-
This repository also contains a [Utilities](Packages/com.unity.multiplayer.samples.coop) package, containing reusable sample scripts. You can install it using the following manifest file entry:
For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/ART_NOTES.md).
65
-
66
-
67
-
68
-
73
+
------
74
+
<br>
69
75
70
76
## Getting the project
71
77
### Direct download
@@ -74,13 +80,30 @@ For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/A
74
80
-__Windows users:__ Using Windows' built-in extraction tool may generate an "Error 0x80010135: Path too long" error window which can invalidate the extraction process. A workaround for this is to shorten the zip file to a single character (eg. "c.zip") and move it to the shortest path on your computer (most often right at C:\\) and retry. If that solution fails, another workaround is to extract the downloaded zip file using [7zip](https://www.7-zip.org/).
75
81
76
82
83
+
## Requirements
84
+
85
+
BossRoom is compatible with the latest Unity Long Term Support (LTS) editor version, currently [2021 LTS](https://unity.com/releases/2021-lts). Please include standalone support for Windows/Mac in your installation.
86
+
87
+
**PLEASE NOTE:** You will also need Netcode for Game Objects to use these samples. Complete the [Hello World Getting Started](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/helloworld) to prepare your environment.
88
+
<br><br>
89
+
90
+
#### Boss Room has been developed and tested on the following platforms:
91
+
- Windows
92
+
- Mac
93
+
- iOS
94
+
- Android <br>
95
+
96
+
#### Boss Room's min spec devices are:
97
+
- iPhone 6S
98
+
- Samsung Galaxy J2 Core
99
+
<br><br>
100
+
77
101
### Installing Git LFS to clone locally
78
102
79
103
Boss Room uses Git Large Files Support (LFS) to handle all large assets required locally. See [Git LFS installation options](https://github.com/git-lfs/git-lfs/wiki/Installation) for Windows and Mac instructions. This step is only needed if cloning locally. You can also just download the project which will already include large files.
104
+
<br><br>
80
105
81
-
## Registering the project with Unity Gaming Services (UGS)
82
106
83
-
Boss Room leverages several services from UGS to facilitate connectivity between players. To use these services inside your project, you must [create an organization](https://support.unity.com/hc/en-us/articles/208592876-How-do-I-create-a-new-Organization-) inside the Unity Dashboard, and enable the [Relay](https://docs.unity.com/relay/get-started.html) and [Lobby](https://docs.unity.com/lobby/game-lobby-sample.html) services. Otherwise, you can still use Boss Room without UGS.
84
107
85
108
## Opening the project for the first time
86
109
@@ -93,8 +116,7 @@ Once you have downloaded the project, follow the steps below to get up and runni
93
116
- Hit the **Play** button. You can then host a new game or join an existing one using the in-game UI.
94
117
95
118
96
-
97
-
------------------------------------------
119
+
<br><br><br>
98
120
99
121
## Exploring the project
100
122
BossRoom is an eight-player co-op RPG game experience, where players collaborate to fight imps, and then a boss. Players can select between classes that each have skills with didactically interesting networking characteristics. Control model is click-to-move, with skills triggered by a mouse button or hotkey.
@@ -105,22 +127,29 @@ One of the eight clients acts as the host/server. That client will use a composi
105
127
- Position updates are carried out through NetworkTransform that sync position and rotation.
106
128
107
129
Code is organized in domain-based assemblies. See the [Boss Room architecture documentation](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom-architecture) file for more details.
108
-
130
+
<br><br>
131
+
132
+
### Registering the project with Unity Gaming Services (UGS)
133
+
134
+
Boss Room leverages several services from UGS to facilitate connectivity between players. To use these services inside your project, you must [create an organization](https://support.unity.com/hc/en-us/articles/208592876-How-do-I-create-a-new-Organization-) inside the Unity Dashboard, and enable the [Relay](https://docs.unity.com/relay/get-started.html) and [Lobby](https://docs.unity.com/lobby/game-lobby-sample.html) services. Otherwise, you can still use Boss Room without UGS.
135
+
<br><br><br>
136
+
109
137
## Testing multiplayer
110
138
111
139
In order to see the multiplayer functionality in action we can either run multiple instances of the game locally on your computer - using either ParrelSync or builds - or choose to connect to a friend over the internet. See [how to test](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/testing/testing_locally) for more info.
140
+
<br><br>
112
141
113
-
---------------
114
-
**Local multiplayer setup**
142
+
### Local multiplayer setup
115
143
116
144
First, build an executable by clicking **'File/Build Settings'** in the menu bar, and then click **'Build'**.<br>
117
145
118
146
119
147
Once the build has completed you can launch several instances of the built executable in order to both host and join a game. When using several instances locally, you will have to set different profiles for each instance for authentication purposes, by using the **'Change Profile'** button. <br>
120
148
> __Mac users:__ to run multiple instances of the same app, you need to use the command line. Run `open -n BossRoom.app`
121
149
122
-
---------------
123
-
**Multiplayer over Internet**
150
+
<br>
151
+
152
+
### Multiplayer over Internet
124
153
125
154
To play over internet, first build an executable that is shared between all players - as above.
126
155
@@ -129,17 +158,22 @@ It is possible to connect between multiple instances of the same executable OR b
129
158
Running the game over internet currently requires setting up a relay.
130
159
131
160
132
-
**Relay Setup**
161
+
### Relay Setup
133
162
134
163
- Boss Room provides an integration with [Unity Relay](https://docs-multiplayer.unity3d.com/netcode/current/relay/relay). You can find our Unity Relay setup guide [here](https://docs-multiplayer.unity3d.com/netcode/current/relay/relay)
135
164
136
165
- Alternatively you can use Port Forwarding. The https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers.
137
166
- Boss Room uses `UDP` and needs a `9998` external port to be open.
138
167
- Make sure your host's address listens on 0.0.0.0 (127.0.0.1 is for local development only).
168
+
<br><br><br>
139
169
140
-
---------------
170
+
-----
171
+
<br>
141
172
142
-
## Index of resources in this project
173
+
## Full index of resources in this project
174
+
175
+
<detailsopen>
176
+
<summary> <b>Click to expand/collapse contents</b> </summary>
143
177
144
178
### Gameplay
145
179
* Action anticipation - AnticipateActionClient() in [Assets/Scripts/Gameplay/Action/Action.cs](Assets/Scripts/Gameplay/Action/Action.cs)
@@ -209,30 +243,30 @@ Running the game over internet currently requires setting up a relay.
209
243
* Scene utils with synced loading screens - [Packages/com.unity.multiplayer.samples.coop/Utilities/SceneManagement/ ](Packages/com.unity.multiplayer.samples.coop/Utilities/SceneManagement/)
Report bugs in Boss Room using Github [issues](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/issues)
217
-
Report NGO bugs using NGO Github [issues](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects)
218
-
Report Unity bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting).
253
+
### Bugs
254
+
- Report bugs in Boss Room using Github [issues](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/issues)
255
+
- Report NGO bugs using NGO Github [issues](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects)
256
+
- Report Unity bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting).
219
257
220
-
**Documentation**
221
-
For a deep dive into Unity Netcode and Boss Room, visit our [documentation site](https://docs-multiplayer.unity3d.com/).
258
+
### Documentation
259
+
For a deep dive into Unity Netcode and Boss Room, visit our [documentation site](https://docs-multiplayer.unity3d.com/).
260
+
<br><br>
222
261
223
-
## Licence.
224
-
Boss Room is licenced under the Unity Companion Licence. See [LICENSE.md](LICENSE.md) for more legal information.
225
-
262
+
## License
263
+
Boss Room is licensed under the Unity Companion License. See [LICENSE.md](LICENSE.md) for more legal information.
226
264
227
265
For a deep dive in Unity Netcode and Boss Room, visit our [docs site](https://docs-multiplayer.unity3d.com/).
228
-
229
-
## Other samples
230
-
### Bite-size Samples
231
-
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.
232
-
266
+
<br><br>
233
267
234
268
## Contributing
235
-
Please check out [CONTRIBUTING.md](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/blob/develop/CONTRIBUTING.md) for full guidelines on submitting issues and PRs to BossRoom.
269
+
We welcome your contributions to this sample code and objects. See our [contribution guidelines](CONTRIBUTING.md) for details.
236
270
237
271
Our projects use the `git-flow` branching strategy:
238
272
- our **`develop`** branch contains all active development
@@ -243,15 +277,28 @@ To get the project on your machine you need to clone the repository from GitHub
__IMPORTANT__: You should have [Git LFS](https://git-lfs.github.com/) installed on your local machine.
247
-
248
-
Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom!
280
+
**PLEASE NOTE:** You will need to have [Git LFS](https://git-lfs.github.com/) installed on your local machine in order to clone our repo.
281
+
<br><br>
249
282
283
+
## Community
284
+
For help, questions, networking advice, or discussions about Netcode for GameObjects and its samples, please join our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/netcode-for-gameobjects.661/).
285
+
<br><br>
250
286
251
287
## Feedback Form
252
288
253
289
Thank you for cloning Boss Room and taking a look at the project. To help us improve and build better samples in the future, please consider submitting feedback about your experiences with Boss Room and let us know if you were able to learn everything you needed to today. It'll only take a couple of minutes. Thanks!
254
290
255
291
[Enter the Boss Room Feedback Form](https://unitytech.typeform.com/bossroom)
292
+
<br><br>
293
+
294
+
## Other samples
295
+
### Bite-size Samples
296
+
- 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.
0 commit comments