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
* A readme update to match the refreshed bitesize readme update
* tweaked the utilities package section
* fixed broken links for badges, made a mac users info call out more obvious
* Fixed some broken table of contents links, corrected a web badge link, and addressed a typo comment
* removed a line break
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>
23
+
---
19
24
20
-
Find our full project documentation, [here](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom/index.html).
25
+
### 💡 Utilities Package
26
+
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
-
| -- |
30
+
---
24
31
25
32
33
+
<br>
26
34
27
-
## Contents and Quick Links
35
+
For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/ART_NOTES.md).
28
36
29
-
<!-- TOC generated from https://luciopaiva.com/markdown-toc/ -->
30
37
38
+
39
+
<br><br>
40
+
41
+
-----
42
+
43
+
## Readme Contents and Quick Links
44
+
<!-- TOC generated from https://luciopaiva.com/markdown-toc/ -->
45
+
<detailsopen>
46
+
<summary> <b>Click to expand/collapse contents</b> </summary>
31
47
32
-
-[Boss Room Overview](#boss-room-overview)
33
-
-[Getting the project](#getting-the-project)
48
+
-### [Getting the project](#getting-the-project-1)
34
49
-[Direct download](#direct-download)
35
50
-[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
-
77
+
------
78
+
<br>
69
79
70
80
## Getting the project
71
81
### Direct download
72
82
- You can download the latest version of Boss Room from our [Releases](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page.
73
83
-__Alternatively:__ click the green `Code` button and then select the 'Download Zip' option. Please note that this will download the branch that you are currently viewing on Github.
74
84
-__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/).
85
+
<br><br>
86
+
87
+
## Requirements
75
88
89
+
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.
90
+
91
+
**PLEASE NOTE:** You will also need Netcode for Game Objects to use these samples. Complete the [Hello World Tutorial](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/helloworld) to prepare your environment.
92
+
<br><br>
93
+
94
+
#### Boss Room has been developed and tested on the following platforms:
95
+
- Windows
96
+
- Mac
97
+
- iOS
98
+
- Android <br>
99
+
100
+
#### Boss Room's min spec devices are:
101
+
- iPhone 6S
102
+
- Samsung Galaxy J2 Core
103
+
<br><br>
76
104
77
105
### Installing Git LFS to clone locally
78
106
79
107
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.
108
+
<br><br>
80
109
81
-
## Registering the project with Unity Gaming Services (UGS)
82
110
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
111
85
112
## Opening the project for the first time
86
113
@@ -93,8 +120,7 @@ Once you have downloaded the project, follow the steps below to get up and runni
93
120
- Hit the **Play** button. You can then host a new game or join an existing one using the in-game UI.
94
121
95
122
96
-
97
-
------------------------------------------
123
+
<br><br><br>
98
124
99
125
## Exploring the project
100
126
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 +131,34 @@ One of the eight clients acts as the host/server. That client will use a composi
105
131
- Position updates are carried out through NetworkTransform that sync position and rotation.
106
132
107
133
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
-
134
+
<br><br>
135
+
136
+
### Registering the project with Unity Gaming Services (UGS)
137
+
138
+
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.
139
+
<br><br><br>
140
+
109
141
## Testing multiplayer
110
142
111
143
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.
144
+
<br><br>
112
145
113
-
---------------
114
-
**Local multiplayer setup**
146
+
### Local multiplayer setup
115
147
116
148
First, build an executable by clicking **'File/Build Settings'** in the menu bar, and then click **'Build'**.<br>
117
149
118
150
119
151
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
-
> __Mac users:__ to run multiple instances of the same app, you need to use the command line. Run `open -n BossRoom.app`
121
152
122
-
---------------
123
-
**Multiplayer over Internet**
153
+
---
154
+
155
+
💡 **Mac users:** To run multiple instances of the same app, you need to use the command line. Run `open -n BossRoom.app`
156
+
157
+
---
158
+
159
+
<br>
160
+
161
+
### Multiplayer over Internet
124
162
125
163
To play over internet, first build an executable that is shared between all players - as above.
126
164
@@ -129,18 +167,22 @@ It is possible to connect between multiple instances of the same executable OR b
129
167
Running the game over internet currently requires setting up a relay.
130
168
131
169
132
-
**Relay Setup**
170
+
### Relay Setup
133
171
134
172
- 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
173
136
174
- 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
175
- Boss Room uses `UDP` and needs a `9998` external port to be open.
138
176
- Make sure your host's address listens on 0.0.0.0 (127.0.0.1 is for local development only).
177
+
<br><br><br>
139
178
140
-
---------------
179
+
-----
141
180
142
181
## Index of resources in this project
143
182
183
+
<detailsopen>
184
+
<summary> <b>Click to expand/collapse contents</b> </summary>
185
+
144
186
### Gameplay
145
187
* Action anticipation - AnticipateActionClient() in [Assets/Scripts/Gameplay/Action/Action.cs](Assets/Scripts/Gameplay/Action/Action.cs)
146
188
* Object spawning for long actions (archer arrow) - LaunchProjectile() in [Assets/Scripts/Gameplay/Action/ConcreteActions/LaunchProjectileAction.cs ](Assets/Scripts/Gameplay/Action/ConcreteActions/LaunchProjectileAction.cs)
@@ -211,30 +253,30 @@ Running the game over internet currently requires setting up a relay.
211
253
* 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)
219
-
Report NGO bugs using NGO Github [issues](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects)
220
-
Report Unity bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting).
263
+
### Bugs
264
+
- Report bugs in Boss Room using Github [issues](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/issues)
265
+
- Report NGO bugs using NGO Github [issues](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects)
266
+
- Report Unity bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting).
221
267
222
-
**Documentation**
223
-
For a deep dive into Unity Netcode and Boss Room, visit our [documentation site](https://docs-multiplayer.unity3d.com/).
268
+
### Documentation
269
+
For a deep dive into Unity Netcode and Boss Room, visit our [documentation site](https://docs-multiplayer.unity3d.com/).
270
+
<br><br>
224
271
225
-
## Licence.
226
-
Boss Room is licenced under the Unity Companion Licence. See [LICENSE.md](LICENSE.md) for more legal information.
227
-
272
+
## License
273
+
Boss Room is licensed under the Unity Companion License. See [LICENSE.md](LICENSE.md) for more legal information.
228
274
229
275
For a deep dive in Unity Netcode and Boss Room, visit our [docs site](https://docs-multiplayer.unity3d.com/).
230
-
231
-
## Other samples
232
-
### Bite-size Samples
233
-
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.
234
-
276
+
<br><br>
235
277
236
278
## Contributing
237
-
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.
279
+
We welcome your contributions to this sample code and objects. See our [contribution guidelines](CONTRIBUTING.md) for details.
238
280
239
281
Our projects use the `git-flow` branching strategy:
240
282
- our **`develop`** branch contains all active development
@@ -245,15 +287,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.
249
-
250
-
Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom!
290
+
**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.
291
+
<br><br>
251
292
293
+
## Community
294
+
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/).
295
+
<br><br>
252
296
253
297
## Feedback Form
254
298
255
299
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!
256
300
257
301
[Enter the Boss Room Feedback Form](https://unitytech.typeform.com/bossroom)
302
+
<br><br>
303
+
304
+
## Other samples
305
+
### Bite-size Samples
306
+
- 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