From 798500507efac095e87bb863b26e9cc6ecde07d1 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Wed, 5 Oct 2022 13:40:57 +0100 Subject: [PATCH 01/14] Update README.md I've done an edit of the Readme to try to make it a little easier to digest and bring some of the more important user information to the forefront. I've also added a little Let me know your thoughts! --- README.md | 238 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 135 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 4233c18a3..7959d5907 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,144 @@ ![Banner](Documentation/Images/Banner.png) ## Co-op multiplayer RPG and utilities built with Unity Netcode for GameObjects -|[Feedback Form](#feedback-form) | -| -- | +Boss Room is a fully functional co-op multiplayer RPG made with Unity Netcode. It is an educational sample designed to showcase typical gameplay [patterns](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom-actions/index.html) that are frequently featured in similar networked games. + + +__PLEASE NOTE__: +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.
+ +**Boss Room has been developed and tested on the following platforms:** +- Windows +- Mac +- iOS +- Android
-| Support is available on [Discord](https://discord.gg/mNgM2XRDpb) and [forums](https://forum.unity.com/forums/multiplayer.26/) to help you work through issues you may encounter when using Boss Room. | +**Boss Room has been tested for use on the following devices:** +- iPhone 6S +- Pixel 3
+ +Find our full project documentation, [here](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom/index.html). + +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/).
Alternatively, tell us what you think using our new [Feedback Form](#feedback-form)
. | -- | -## Table of content + + +## Contents and Quick Links -- [Boss Room](#boss-room) -- [Index of resources in this project](#index-of-resources-in-this-project) - - [Gameplay](#gameplay) - - [Game Flow](#game-flow) - - [Connectivity](#connectivity) - - [Services (Lobby, Relay, etc)](#services-lobby-relay-etc) - - [Tools and Utilities](#tools-and-utilities) +- [Boss Room Overview](#boss-room-overview) - [Getting the project](#getting-the-project) - [Direct download](#direct-download) - [Installing Git LFS to clone locally](#installing-git-lfs-to-clone-locally) - [Registering the project with Unity Gaming Services (UGS)](#registering-the-project-with-unity-gaming-services-ugs) - [Opening the project for the first time](#opening-the-project-for-the-first-time) -- [Testing multiplayer](#testing-multiplayer) - [Exploring the project](#exploring-the-project) +- [Testing multiplayer](#testing-multiplayer) +- [Index of resources in this project](#index-of-resources-in-this-project) + - [Gameplay](#gameplay) + - [Game Flow](#game-flow) + - [Connectivity](#connectivity) + - [Services (Lobby, Relay, etc)](#services-lobby-relay-etc) + - [Tools and Utilities](#tools-and-utilities) +- [Troubleshooting](#troubleshooting) +- [Licence](#licence) - [Other samples](#other-samples) - [Bite-size Samples](#bite-size-samples) - [Contributing](#contributing) - [Feedback Form](#feedback-form) -## Boss Room +## Boss Room Overview -Boss Room is a fully functional co-op multiplayer RPG made with Unity Netcode. It is built to serve as an educational sample that showcases certain typical gameplay [patterns](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom-examples/bossroom-actions) that are frequently featured in similar networked 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](https://unity.com/products/relay), [Lobby](https://unity.com/products/lobby), and [Authentication](https://unity.com/products/authentication) services. -You can use everything in this project as a starting point or as bits and pieces in your own Unity games. The project is licensed under the Unity Companion License. See [LICENSE.md](LICENSE.md) for more legal information. +You can use the project as a starting point for your own Unity game or use elements individually. -This repo also contains a [Utilities](Packages/com.unity.multiplayer.samples.coop) package, containing sample scripts reusable in your own projects. You can install it using the following manifest file entry: +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: `"com.unity.multiplayer.samples.coop": "https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop.git?path=/Packages/com.unity.multiplayer.samples.coop", -` - -See [ART_NOTES.md](Documentation/ART_NOTES.md) for more information on the art of Boss Room. +`. + +For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/ART_NOTES.md). -> __IMPORTANT__: -> - Boss Room has been developed and tested on these Platforms (Windows, Mac, iOS, and Android). -> - Tested on iPhone 6 and Pixel 3. -> - Boss Room is compatible with the latest Unity LTS version. -> - Make sure to include standalone support for Windows/Mac in your installation. ![](Documentation/Images/Boss.png) + + +## Getting the project +### Direct download + - You can download the latest version of Boss Room from our [Releases](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page. + - __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. + - __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/). + + +### Installing Git LFS to clone locally + +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. + +## Registering the project with Unity Gaming Services (UGS) + +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. + +## Opening the project for the first time + +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](https://unity.com/releases/2021-lts). + - Include standalone support for Windows/Mac in your installation. + - Add the project to the _Unity Hub_ by clicking on the **Add** button and pointing it to the root folder of the downloaded project. + - __Please note :__ the first time you open the project Unity will import all assets, which will take longer than usual. + + - Once open, select the 'Startup' scene and click the **Play** button. You can then host a new game or join an existing one using the in-game UI. + + ![](Documentation/Images/StartupScene.png) + + ------------------------------------------ + +## Exploring the project +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. + +- The game is server-authoritative, with latency-masking animations. +- Position updates are carried out through NetworkedVars that sync position, rotation and movement speed. +- NetworkedVars and Remote Procedure Calls (RPC) endpoints are isolated in a class that is shared between the server and client specialized logic - components. + +Code is organized in domain-based assemblies. See our [ARCHITECTURE.md](ARCHITECTURE.md) file for more details. + +## Testing multiplayer + +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. + +--------------- +**Local multiplayer setup** + +First, build an executable by clicking **'File/Build Settings'** in the menu bar, and then click **'Build'**.
+![](Documentation/Images/BuildProject.png) -![](Documentation/Images/Players.png) +Once the build has completed you can launch several instances of the built executable in order to both host and join a game.
+> __Mac users:__ to run multiple instances of the same app, you need to use the command line. Run `open -n BossRoom.app` + +--------------- +**Multiplayer over Internet** + +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. + + + **Relay Setup** + +- 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) + +- 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). + +--------------- ## Index of resources in this project @@ -117,104 +203,50 @@ See [ART_NOTES.md](Documentation/ART_NOTES.md) for more information on the art o * Scene utils with synced loading screens - [Packages/com.unity.multiplayer.samples.coop/Utilities/SceneManagement/ ](Packages/com.unity.multiplayer.samples.coop/Utilities/SceneManagement/) * 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) * ParrelSync - [ Packages/manifest.json ](Packages/manifest.json) + +## Troubleshooting + +**Known Issues** + Find an up-to-date list of Boss Room's knows issues in te changelog of our ['Releases'](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page. + +**Bugs** + Report bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting). + + **Documentation** + For a deep dive into Unity Netcode and Boss Room, visit our [documentation site](https://docs-multiplayer.unity3d.com/). + +## Licence. +Boss Room is licenced under the Unity Companion Licence. See [LICENSE.md](LICENSE.md) for more legal information. -## Getting the project -### Direct download - - The pre-release version can be downloaded from the [Releases](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page. - - Alternatively: click the green `Code` button and then choose to download the zip archive. Remember, that you would download the branch that you are currently viewing in Github. - - For Windows users: Using Windows' built-in extracting tool may generate a "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. - - -### Installing Git LFS to clone locally - -This project uses Git Large Files Support (LFS), which ensures all large assets required locally are handled for the project. See [Git LFS installation options](https://github.com/git-lfs/git-lfs/wiki/Installation) for Windows and Mac instructions. - -## Registering the project with Unity Gaming Services (UGS) - -This project leverages several services from UGS to facilitate connectivity between players. In order to use these services inside your project, one must first [create an organization](https://support.unity.com/hc/en-us/articles/208592876-How-do-I-create-a-new-Organization-) inside Unity Dashboard, and enable both the [Relay](https://docs.unity.com/relay/get-started.html) and [Lobby](https://docs.unity.com/lobby/game-lobby-sample.html) services. Otherwise, Boss Room can still be used without UGS. - -## Opening the project for the first time - -Once you have downloaded the project, the steps below should get you up and running: - - Make sure you have installed the version of Unity that is listed above in the prerequisites section. - - Make sure to include standalone support for Windows/Mac in your installation. - - Add the project in _Unity Hub_ by clicking on **Add** button and pointing it to the root folder of the downloaded project. - - The first time you open the project Unity will import all assets, which will take longer than usual - it is normal. -![](Documentation/Images/StartupScene.png) - - From there you can click the **Play** button. You can host a new game or join an existing game using the in-game UI. - -## Testing multiplayer - -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. - ---------------- -**Local multiplayer setup** - -First we need to build an executable. - -To build an executable, press _File/Build Settings_ in the menu bar, and then press **Build**. -![](Documentation/Images/BuildProject.png) - -Once the build has completed you can launch several instances of the built executable in order to both host and join a game. - -> Mac users: to run multiple instances of the same app, you need to use the command line. -> Run `open -n BossRoom.app` - ---------------- -**Multiplayer over internet** - -To play over internet, we need to build an executable that is shared between all players. See the previous section. - -It is possible to connect between multiple instances of the same executable OR between executables and the editor that produced said executable. - -Running the game over internet currently requires setting up a relay. Boss Room provides an integration with [Unity Relay](https://docs-multiplayer.unity3d.com/netcode/current/relay/relay). - -> Checkout our Unity Relay setup guide [here](https://docs-multiplayer.unity3d.com/netcode/current/relay/relay) - -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). - ------------------------------------------- - -## Exploring the project -BossRoom is an eight-player co-op RPG game experience, where players collaborate to take down some 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 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. - -The game is server-authoritative, with latency-masking animations. Position updates are done through NetworkedVars that sync position, rotation and movement speed. NetworkedVars and Remote Procedure Calls (RPC) endpoints are isolated in a class that is shared between the server and client specialized logic components. - -Code is organized in domain based assemblies. See our [ARCHITECTURE.md](ARCHITECTURE.md) file for more details. - ---------------- For a deep dive in Unity Netcode and Boss Room, visit our [docs site](https://docs-multiplayer.unity3d.com/). ## Other samples ### Bite-size Samples -This repository contains a collection of bitesize sample projects and games that showcase different sub-features of NGO. You can review these samples with documentation to understand APIs and features better. -- [Our various bitesize samples](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize) +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. -## Contributing -The project uses the `git-flow` branching strategy, as such: - - `develop` branch contains all active development - - `main` branch contains release versions +## Contributing +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. + +Our projects use the `git-flow` branching strategy: + - our **`develop`** branch contains all active development + - our **`main`** branch contains release versions To 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 ``` -> __IMPORTANT__: -> You should have [Git LFS](https://git-lfs.github.com/) installed on your local machine. +__IMPORTANT__: You should have [Git LFS](https://git-lfs.github.com/) installed on your local machine. Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom! -For further discussion points and to connect with the team, join us on the Unity Multiplayer Networking Discord Server - Channel #dev-samples - -[![Discord](https://img.shields.io/discord/449263083769036810.svg?label=discord&logo=discord&color=informational)](https://discord.gg/FM8SE9E) ## Feedback Form 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](https://unitytech.typeform.com/bossroom) + + ![](Documentation/Images/Players.png) From ced9201ecf5de3b4993f1146f4ee26fb848791de Mon Sep 17 00:00:00 2001 From: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> Date: Wed, 5 Oct 2022 11:32:50 -0400 Subject: [PATCH 02/14] removing mistaken double ref --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7959d5907..d103130bb 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ Running the game over internet currently requires setting up a relay. * NetworkVariable with Enum - [Assets/Scripts/Gameplay/GameState/NetworkPostGame.cs](Assets/Scripts/Gameplay/GameState/NetworkPostGame.cs) * NetworkVariable with custom serialization (GUID) - [Assets/Scripts/Infrastructure/NetworkGuid.cs](Assets/Scripts/Infrastructure/NetworkGuid.cs) * NetworkVariable with fixed string - [Assets/Scripts/Utils/NetworkNameState.cs](Assets/Scripts/Utils/NetworkNameState.cs) -* NetworkList with custom serialization (LobbyPlayerState) - [Assets/Scripts/Gameplay/GameState/NetworkCharSelection.cs](Assets/Scripts/Gameplay/GameState/NetworkCharSelection.cs)
[Assets/Scripts/Gameplay/GameState/NetworkCharSelection.cs](Assets/Scripts/Gameplay/GameState/NetworkCharSelection.cs) +* NetworkList with custom serialization (LobbyPlayerState) - [Assets/Scripts/Gameplay/GameState/NetworkCharSelection.cs](Assets/Scripts/Gameplay/GameState/NetworkCharSelection.cs) * Persistent player (over multiple scenes) - [Assets/Scripts/Gameplay/GameplayObjects/PersistentPlayer.cs ](Assets/Scripts/Gameplay/GameplayObjects/PersistentPlayer.cs) * Character logic (including player's avatar) - [Assets/Scripts/Gameplay/GameplayObjects/Character/ ](Assets/Scripts/Gameplay/GameplayObjects/Character/)
[ Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacter.cs ](Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacter.cs) * Character movements - [Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacterMovement.cs](Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacterMovement.cs) From d45de2849857eb7bf2d16186c9df0a81a17d599a Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:47:42 +0100 Subject: [PATCH 03/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index d103130bb..34880355b 100644 --- a/README.md +++ b/README.md @@ -206,9 +206,6 @@ Running the game over internet currently requires setting up a relay. ## Troubleshooting -**Known Issues** - Find an up-to-date list of Boss Room's knows issues in te changelog of our ['Releases'](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page. - **Bugs** Report bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting). From f10a7264ba98d73ed1a5beb9ced5ab4bef811329 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:49:10 +0100 Subject: [PATCH 04/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 34880355b..d4ffd9d1a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Boss Room is compatible with the latest Unity Long Term Support (LTS) editor ver - iOS - Android
-**Boss Room has been tested for use on the following devices:** +**Boss Room's min spec devices are:** - iPhone 6S - Pixel 3
From ad1a2f4a68a8d64571e8027cf2075e8985e44fc2 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:49:40 +0100 Subject: [PATCH 05/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4ffd9d1a..02e72f93a 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ Once you have downloaded the project, follow the steps below to get up and runni - Add the project to the _Unity Hub_ by clicking on the **Add** button and pointing it to the root folder of the downloaded project. - __Please note :__ the first time you open the project Unity will import all assets, which will take longer than usual. - - Once open, select the 'Startup' scene and click the **Play** button. You can then host a new game or join an existing one using the in-game UI. + - Hit the **Play** button. You can then host a new game or join an existing one using the in-game UI. ![](Documentation/Images/StartupScene.png) From 54b690d10e0464dd3db2fef795c990878972280d Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:51:12 +0100 Subject: [PATCH 06/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 02e72f93a..08fd0d79f 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ To connect and find support, join the multiplayer community on the Unity [Discor 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. -You can use the project as a starting point for your own Unity game or use elements individually. +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](Packages/com.unity.multiplayer.samples.coop) package, containing reusable sample scripts. You can install it using the following manifest file entry: From c043e99b4ad7792dc88c62195fe83876487a68d3 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:51:38 +0100 Subject: [PATCH 07/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 08fd0d79f..8566ef6ed 100644 --- a/README.md +++ b/README.md @@ -102,8 +102,7 @@ BossRoom is an eight-player co-op RPG game experience, where players collaborate 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. - The game is server-authoritative, with latency-masking animations. -- Position updates are carried out through NetworkedVars that sync position, rotation and movement speed. -- NetworkedVars and Remote Procedure Calls (RPC) endpoints are isolated in a class that is shared between the server and client specialized logic - components. +- Position updates are carried out through NetworkTransform that sync position and rotation. Code is organized in domain-based assemblies. See our [ARCHITECTURE.md](ARCHITECTURE.md) file for more details. From 2dd8109bc1077b6dcced2d449137e66bf2220615 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:51:53 +0100 Subject: [PATCH 08/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8566ef6ed..2630f0aac 100644 --- a/README.md +++ b/README.md @@ -206,7 +206,9 @@ Running the game over internet currently requires setting up a relay. ## Troubleshooting **Bugs** - Report bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting). + Report bugs in Boss Room using Github [issues](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/issues) + Report NGO bugs using NGO Github [issues](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects) + Report Unity bugs using the [Unity bug submission process](https://unity3d.com/unity/qa/bug-reporting). **Documentation** For a deep dive into Unity Netcode and Boss Room, visit our [documentation site](https://docs-multiplayer.unity3d.com/). From e5bfecd053ffb04a3ec198e583000e82a1a0d01d Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:54:34 +0100 Subject: [PATCH 09/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2630f0aac..42d5d3fb5 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ For more information on the art of Boss Room, see [ART_NOTES.md](Documentation/A ### Installing Git LFS to clone locally -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. +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. ## Registering the project with Unity Gaming Services (UGS) From 0cf5f30817f88f226a0dee536bdd398d43da11b7 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:55:10 +0100 Subject: [PATCH 10/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 42d5d3fb5..d6394afc9 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,7 @@ Running the game over internet currently requires setting up a relay. * Persistent player (over multiple scenes) - [Assets/Scripts/Gameplay/GameplayObjects/PersistentPlayer.cs ](Assets/Scripts/Gameplay/GameplayObjects/PersistentPlayer.cs) * Character logic (including player's avatar) - [Assets/Scripts/Gameplay/GameplayObjects/Character/ ](Assets/Scripts/Gameplay/GameplayObjects/Character/)
[ Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacter.cs ](Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacter.cs) * Character movements - [Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacterMovement.cs](Assets/Scripts/Gameplay/GameplayObjects/Character/ServerCharacterMovement.cs) +* Client driven movements - Boss Room is server driven with anticipation animation. See [Client Driven bitesize](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/tree/main/Basic/ClientDriven) for client driven gameplay * Player spawn - SpawnPlayer() in [Assets/Scripts/Gameplay/GameState/ServerBossRoomState.cs](Assets/Scripts/Gameplay/GameState/ServerBossRoomState.cs) ### Game Flow From 1af0e6fa95d129740b0f2df6bb52be9cda051174 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:55:30 +0100 Subject: [PATCH 11/14] Update README.md Co-authored-by: LPLafontaineB --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d6394afc9..2b6a0fdab 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ In order to see the multiplayer functionality in action we can either run multip First, build an executable by clicking **'File/Build Settings'** in the menu bar, and then click **'Build'**.
![](Documentation/Images/BuildProject.png) -Once the build has completed you can launch several instances of the built executable in order to both host and join a game.
+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` --------------- From 87605d3920a6236d07a730843752dbff1cf52ec1 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:55:38 +0100 Subject: [PATCH 12/14] Update README.md Co-authored-by: Jil Franco <89089503+jilfranco-unity@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b6a0fdab..c3094896c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Boss Room is compatible with the latest Unity Long Term Support (LTS) editor ver **Boss Room's min spec devices are:** - iPhone 6S -- Pixel 3
+- Samsung Galaxy J2 Core
Find our full project documentation, [here](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom/index.html). From 513207d78d4eda9d4ea25995728c1c34a40038bc Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 12:55:59 +0100 Subject: [PATCH 13/14] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c3094896c..f2a24ba49 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Boss Room is compatible with the latest Unity Long Term Support (LTS) editor ver Find our full project documentation, [here](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom/index.html). -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/).
Alternatively, tell us what you think using our new [Feedback Form](#feedback-form)
. +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/).
Got feedback? Tell us what you think using our new [Feedback Form](#feedback-form)
. | -- | From be3e45a85b35c2faf8a708d9c0aa2c71cb265b33 Mon Sep 17 00:00:00 2001 From: MorwennaG <47358526+MorwennaG@users.noreply.github.com> Date: Thu, 6 Oct 2022 13:35:12 +0100 Subject: [PATCH 14/14] Update README.md Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f2a24ba49..e8f874928 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![Banner](Documentation/Images/Banner.png) ## Co-op multiplayer RPG and utilities built with Unity Netcode for GameObjects -Boss Room is a fully functional co-op multiplayer RPG made with Unity Netcode. It is an educational sample designed to showcase typical gameplay [patterns](https://docs-multiplayer.unity3d.com/netcode/current/learn/bossroom/bossroom-actions/index.html) that are frequently featured in similar networked games. +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. __PLEASE NOTE__: