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 that are frequently featured in similar multiplayer games.
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, Lobby, and Authentication services.
You can use the project as a reference starting point for your own Unity game or use elements individually.
This repository also contains a Utilities package, containing reusable sample scripts. You can install it using the following manifest file entry:
"com.unity.multiplayer.samples.coop": "https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop.git?path=/Packages/com.unity.multiplayer.samples.coop",
For more information on the art of Boss Room, see ART_NOTES.md.
Code
button and then select the 'Download Zip' option. Please note that this will download the branch that you are currently viewing on Github.BossRoom is compatible with the latest Unity Long Term Support (LTS) editor version, currently 2022 LTS. Please include standalone support for Windows/Mac in your installation.
PLEASE NOTE: You will also need Netcode for Game Objects to use these samples. See the Installation Documentation to prepare your environment. You can also complete the Get Started With NGO tutorial to familiarize yourself with Netcode For Game Objects.
Boss Room uses Git Large Files Support (LFS) to handle all large assets required locally. See Git LFS installation options 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.
Once you have downloaded the project, follow the steps below to get up and running:
Check that you have installed the most recent LTS editor version.
Add the project to the Unity Hub by clicking on the Add button and pointing it to the root folder of the downloaded project.
Hit the Play button. You can then host a new game or join an existing one using the in-game UI.
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.
One of the eight clients acts as the host/server. That client will use a compositional approach so that its entities have both server and client components.
Code is organized in domain-based assemblies. See the Boss Room architecture documentation file for more details.
Boss Room leverages several services from UGS to facilitate connectivity between players. To use these services inside your project, you must create an organization inside the Unity Dashboard, and enable the Relay and Lobby services. Otherwise, you can still use Boss Room without UGS.
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 for more info.
First, build an executable by clicking 'File/Build Settings' in the menu bar, and then click 'Build'.
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.
Mac users: To run multiple instances of the same app, you need to use the command line. Run open -n BossRoom.app
To play over internet, first build an executable that is shared between all players - as above.
It is possible to connect between multiple instances of the same executable OR between executables and the editor that produced it.
Running the game over internet currently requires setting up a relay.
Boss Room provides an integration with Unity Relay. You can find our Unity Relay setup guide here
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.
Boss Room uses UDP
and needs a 9998
external port to be open.
Make sure your host's address listens on 0.0.0.0 (127.0.0.1 is for local development only).
For a deep dive into Unity Netcode and Boss Room, visit our documentation site.
Boss Room is licensed under the Unity Companion License. See LICENSE.md for more legal information.
For a deep dive in Unity Netcode and Boss Room, visit our docs site.
We welcome your contributions to this sample code and objects. See our contribution guidelines for details.
Our projects use the git-flow
branching strategy:
develop
branch contains all active developmentmain
branch contains release versionsTo get the project on your machine you need to clone the repository from GitHub using the following command-line command:
git clone https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop.git
PLEASE NOTE: You will need to have Git LFS installed on your local machine in order to clone our repo.
For help, questions, networking advice, or discussions about Netcode for GameObjects and its samples, please join our Discord Community or create a post in the Unity Multiplayer Forum.
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!
Enter the Boss Room Feedback Form