Boss Room 0.2.0 changelog

blog/2021-05-19-boss-room-0-2-0.md

@@ -0,0 +1,23 @@
+---
+title: Boss Room 0.2.0 is live!
+author: Lori Krell
+author_title: Unity, Senior Tech Writer
+tags: [releases, bossroom]
+description: Welcome to the next release of the Unity Boss Room Small Scale Co-op Sample for version 0.2.0. This release includes numerous added features, updates, and fixes.
+hide_table_of_contents: false
+---
+
+Thank you for your continued support for MLAPI and the Boss Room Small Scale Co-op Sample! We have released a new v. 0.2.0 release of Boss Room, using 0.1.0 experimental MLAPI.
+
+In the past month, the team has delivered new features, optimizations, and numerous fixes and changes including the following highlights: 
+
+* Updated and introduced various hero abilities, such as: Archer’s PowerShot which accounts for a duration that a key is pressed for or Rogue Dash that teleports the player to a target spot  - to learn more about how to handle teleport-like abilities in a networked environment, please check out the DashAttackAction.cs - as well as Implementing a better cooldown solution and calculations.
+* Introduced static scene `NetworkObject`s, as well as implementing a `ScriptableObject` based event system to encapsulate events inside assets.
+* Increased the overall GPU performance of Boss Room by disabling GPU Skinning, enabling GPU instancing, turning off Cast Shadows for various prefabs, and more optimizations.
+* Updated the user interface in many places and refactored the Action Bar code to increase the extensibility without the need of having to manually modify the code in multiple areas.
+* Updated our `GameNetPortal` to properly handle Per-Connection state on client disconnect and Player connection if they experience a game-level connection failure - you can check out the `ApprovalCheck` function in our *ServerGameNetPortal.cs*.
+* Fixed various known issues from the previous release.
+
+Find all details in our [changelog](/releases/samples/samples-0-2-0) and download the release from [GitHub](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases/latest).
+
+Have questions? Chat with us in the [Multiplayer forums](https://forum.unity.com/forums/multiplayer.26) and [Discord](https://discord.gg/buMxnnPvTb) in the #dev-samples channel.

docs/learn/listenserverhostarchitecture.md

@@ -1,6 +1,8 @@
 ---
-id: listenserverhostarchitecture
+id: listen-server-host-architecture
 title: Create a game with a listen server / host architecture
+sidebar_label: Listen server and host architecture
+description: Learn more about creating a game with a listen server and host architecture.
 ---
 
 ## What is a listen server

docs/learn/multiplayergamearhitectureintroduction.md

@@ -1,5 +1,5 @@
 ---
-id: multiplayergamearhitectureintroduction
+id: multiplayer-game-arhitecture
 title: Introduction
 sidebar_label: Introduction
 ---

docusaurus.config.js

@@ -205,6 +205,14 @@ module.exports = {
                 label: 'Unity Multiplayer Forum',
                 href: 'https://forum.unity.com/forums/multiplayer.26/',
               },
+              {
+                label: 'MLAPI Forum',
+                href: 'https://forum.unity.com/forums/mlapi.661/',
+              },
+              {
+                label: 'Unity Transport Forum',
+                href: 'https://forum.unity.com/forums/unity-transport.664/',
+              },
             ]
             },
         ],
@@ -481,18 +489,18 @@ module.exports = {
             return `https://github.com/Unity-Technologies/com.unity.multiplayer.docs/edit/master/${versionDocsDirPath}/${docPath}`;
           },
           includeCurrentVersion: true,
-            lastVersion: '0.9.0',
+            lastVersion: '0.8.0',
             versions: {
               //current: {
               //  label: 'Next',
               //  path: 'next',
               //},
               '0.9.0': {
-               label: 'v. 0.9.0',
-                path: '',
+               label: 'v. 0.9.0preview',
+                path: '0.9.0',
               },
               '0.8.0': {
-                label: 'v. 0.8.0',
+                label: 'v. 0.8.0preview',
                  path: '0.8.0',
                },
             },
@@ -556,9 +564,20 @@ module.exports = {
       {
         id: 'GTM-5V25JL6', // GTM Container ID
       }],
+      [
+        '@docusaurus/plugin-client-redirects',
+        {
+          redirects: [
+            {
+              to: '/docs/advanced-topics/messaging-system',
+              from: '/docs/advanced-topics/messaging-system/about-rpc',
+            },
+          ]
+        },
+      ],
         'plugin-image-zoom',
         'docusaurus-plugin-sass',
         '@saucelabs/theme-github-codeblock',
         'react-iframe'
-    ],
+      ]
   };

releases/index.md

@@ -28,9 +28,10 @@ For Unity experimental releases:
 
 See the following project releases for Boss Room.
 
-| Release | Status | Date | Supported Unity Versions |
+| Release | Status | Date | Supported MLAPI | Supported Unity |
 | -- | -- | -- | -- |
-| [v0.1.0](samples/release-0-1-0.md) | Early Access | April 7, 2021 | 2020.3 and later |
+| [v0.2.0](samples/release-0-2-0.md) | Early Access | May 19, 2021 | [0.1.0](multiplayer/release-0-1-0.md) | v2020.3.8f1 LTS |
+| [v0.1.0](samples/release-0-1-0.md) | Early Access | April 7, 2021 | [0.1.0](multiplayer/release-0-1-0.md) | 2020.3.0f1 LTS |
 
 :::important
 Boss Room: Small Scale Co-op Sample always requires the latest version of Unity MLAPI.

releases/samples/release-0-1-0.md

@@ -9,7 +9,7 @@ The Boss Room: Small Scale Co-op Sample v0.1.0 release provides new sample code,
 
 | Product | Version | Status | Release Date | Supported Unity Versions |
 | -- | -- | -- | -- | -- |
-| Boss Room: Small Scale Co-op Sample | 0.1.0 | Early Access | April 7, 2021 | 2020.3 and later |
+| Boss Room: Small Scale Co-op Sample | 0.1.0 | Early Access | April 7, 2021 | 2020.3.0f1 |
 
 :::important
 Boss Room: Small Scale Co-op Sample always requires the latest version of Unity MLAPI. See [Unity MLAPI](../index.md) for more information on those features, fixes, and known issues.
@@ -65,7 +65,7 @@ v0.1.1 is a hotfix for an Early Access release for Boss Room: Small Scale Co-op
 The following issues may occur for access and games:
 
 * Sometimes when the host leaves the Boss Room, not all clients will return to the Main Menu, but will remain stuck in the Boss Room scene. <!-- GOMPS-439-->
-* Sometimes after completing a match and the host starts a new match from the Victory or Loss screen, connected players may have no visible interactions to join or select characters. <!-- GOMPS-464 -->
+* Sometimes after completing a match and the host starts a new match from the Victory or Loss screen, connected players may have no visible interactions to join or select characters. <!-- GOMPS-464 GOMPS-506 -->
 * A player may encounter a rare exception when the Tank character uses her Shield Aura ability. This issue may be due to intercepting the Boss charge attack. <!-- GOMPS-435 -->
 * If two players in the Character Select **Ready** for the same hero at the same time, the UI will update to *Readied* on both clients, but only one will have actually selected the hero on the Host. This issue blocks Character Select from proceeding.  <!-- GOMPS-390 -->
 * Any player that plays the game and then returns to the Main Menu may be unable to Start or Join properly again, requiring you to restart the client. <!-- GOMPS-355 -->
@@ -82,6 +82,6 @@ The following issues may occur for access and games:
 
 ## Learn more
 
-See [Getting Started with Boss Room](../../learn/getting-started-boss-room.md) to install and get started with Boss Room.
+See [Getting Started with Boss Room](/docs/learn/bossroom) to install and get started with Boss Room.
 
 To provide feedback and content on documentation, see the links at the bottom of each page.

releases/samples/release-0-2-0.md

@@ -0,0 +1,145 @@
+---
+id: samples-0-2-0
+title: Boss Room Small Scale Co-op Sample 0.2.0 - 2021-05-19
+sidebar_label: Boss Room 0.2.x
+description: Release notes for Boss Room Small Scale Co-op Sample v0.2.0, the first release of the Boss Room sample project for Unity MLAPI.
+---
+
+The Boss Room: Small Scale Co-op Sample v0.2.0 release provides new sample code, assets, and features for the Boss Room cooperative game sample project. THis project provides a learning experience for Unity MLAPI.
+
+| Product | Version | Status | Release Date | Supported Unity Versions |
+| -- | -- | -- | -- | -- |
+| Boss Room: Small Scale Co-op Sample | 0.2.0 | Early Access | May 19, 2021 | v2020.3.8f1 LTS |
+
+:::important
+Boss Room: Small Scale Co-op Sample always requires the latest version of Unity MLAPI. See [Unity MLAPI](../index.md) for more information on those features, fixes, and known issues.
+:::
+
+## [0.2.0] - 2021-05-19
+
+## New features
+
+This release includes the following new features and additions:
+
+* Introduced static scene `NetworkObject`s to BossRoom scene including the following updates:<!-- GOMPS-381 PR 292-->
+
+    * Implemented a `ScriptableObject` based event system to encapsulate events inside assets. These objects include a `GameEvent` (ScriptableObject) and `GameEventListener` (MonoBehaviour) to encapsulate events inside assets, located in the `ServerBossRoomState` prefab which now has a `GameEventListener` component. The event associated to this listener is `BossDefeated`, which the Boss raises when the `LifeState` is Dead in the `RaiseEventOnLifeChange` component.
+    * Added two separator `GameObject`s for scene readability: runtime `NetworkObject`s and `NetworkObject`s already placed in the scene.
+    * Added a custom editor for GameEvents to fire in the editor (greatly enhances testing).
+    * The `LifeState` `NetworkVariable` was moved from `NetworkCharacterState` into its own component, `NetworkLifeState`.
+    * Cleaned up and removed old spawn prefab collections and spawner scripts (`NetSpawnPoint`).
+
+* Added ramp-up animation for hero movement and actions <!-- GOMPS-122 GOMPS-472-->
+* Added F/X and animation assets for the game including:
+
+  * Audio files for boss sound effects <!--  GOMPS-110 -->
+  * Visual effects and particles for Tank charge skill <!-- GOMPS-237 GOMPS-238 -->
+  * Art assets to wave spawner, including animations for ReceiveDamage, Broken (died), and Revive <!-- GOMPS-123 -->
+
+* Added Boss fight theme. <!-- GOMPS-128 -->
+* Updated and added various hero abilities:
+
+  * Added a cooldown to Archer's PowerShot.
+  * Added the Rogue's Dagger and Dash skills. The dash skill shows an instinct teleport (using an RPC) instead of a charge like the boss' (which updates its position over time). <!-- GOMPS-483 GOMPS-16 GOMPS-65 -->
+  * Added the Rogue's Sneak skill using local stealth, applying a graphical effect to the stealthy character while still sending all network events normally. <!--  GOMPS-64 -->
+  * Properly display Heal abilities when targeting a fallen ally character. <!-- GOMPS-454 -->
+  * Character attack actions properly support Hold to charge options. <!-- GOMPS-455 -->
+
+* To show how UI elements and game objects can be networked, added networked functionality using `INetworkSerializable` in the `CharSelect` screen to network player's selected character on the Character Selection screen. <!-- GOMPS-174 -->
+* Added input sanitization to remove any invisible characters introduced by other chat programs when copy-pasting room names, IP addresses, or ports. (Useful when sharing with friends.)
+* Added disconnection error message to load when a player or host disconnects. Client logic was also updated to detect Host disconnection scenarios, such as losting connectivity. <!-- GOMPS-448 GOMPS-470 -->
+* Balanced hero and enemy stats, spawners, trigger areas, and enemy detetction areas. <!-- GOMPS-249, 251 -->
+* Added healthbars to display when damaged and properly track imp health locally and across clients. <!-- GOMPS-450 -->
+
+## Changes
+
+* The Boss Room project now loads MLAPI 0.1.0-experimental package through the Unity Package Manager Registry. See the [MLAPI install guide](/docs/migration/install) for details.
+* Updated the user interface including the following:
+
+  * When joining a game, a "Connecting..." UI loads. When disconnecting from a game, you are returned to the MainMenuScene with a "Connection to Host lost" message. If the game fails to connect, a general message "Connection to Host failed" loads. <!-- GOMPS-5, GOMPS-114 -->
+  * Added an option to leave the lobby after joining it. You no longer have to restart the game to leave the lobby. <!-- GOMPS-375 -->
+  * Added option to cancel my selection after clicking **Ready**. <!-- GOMPS-293 -->
+  * Added a gear icon for accessing and modifying app settings. <!-- GOMPS-421 -->
+  * The UI now tracks and displays player has arrived, number of connected players in the lobby, and player status. <!-- GOMPS-292 GOMPS-351 -->
+
+This release includes the following updates:
+
+* Updated Boss Room per asset and project settings for increased performance and better resource management: <!-- GOMPS-539-->
+
+  * Disabled GPU Skinning to optimize GPU usage and FPS.
+  * Lowered quality of ambient occlusion from high to medium.
+  * Switched SMAA High to FXAA (fast mode) reducing GPU cost.
+  * Modified GPU Instancing on imps, heroes, and the boss to significantly reduce the number of draw calls.
+  * Turned off Cast Shadows on Imp and Imp Boss.
+  * Disabled mesh colliders of lava, which is more decorative than interactive.
+  * Refactored the S_SimpleDissolve shader which consumed most import time.
+
+* Removed a duplicated `GameObject` from the MainMenu scene. <!-- GOMPS-474 -->
+* Reviewed and revised code to better following quality standards. <!-- GOMPS-203, GOMPS-218, GOMPS-223 -->
+* Updated the Mage character base attack to better support the new enqueuing ability and handle game behaviors. Updates include:<!-- https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/pull/60 GOMPS-228 GOMPS-379 GOMPS-417 -->
+
+  * Actions being non-blocking now allow other actions while a mage-bolt is in flight
+  * Actions send in `ActionSequence` groups to better handle actions when players spam click enemies
+  * Timing issues with animations, actions, and character location
+  * Bolt animation for legitimate hits
+  * Updated attacks not to knock rogues out of stealth <!-- GOMPS-423 -->
+
+* Updated character attacks to not cause friendly-fire damage between players. <!-- GOMPS-299 -->
+* Updated and resolved issues with 3D models including polygon count of coins and chest, artifacts where level graphics are stitched together or overlapping characters, and asset map consistency used by objects (color + normal map + emission). <!-- GOMPS-342 GOMPS-462 GOMPS-524 -->
+* Merged `ConnectStatus` and `DisconnectReason` into a single `ConnectStatus`. <!-- GOMPS-470 -->
+* Updated `ServerGameNetPortal` to properly handle the following:<!-- GOMPS-470 -->
+
+  * Per-connection state on client disconnect
+  * Additional errors including a full server and player ID (GUID) already playing
+
+* Updated code to allow hosts to specify a port to listen to,removing the hard-coded port. <!-- GOMPS-270 -->
+* Refactored Action Bar code including the following: <!-- commits https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/commit/579c710fb64c2fc51e6b52c0483f0fe81b9d65f8-->
+
+  * Removed the `ButtonID` from `UIHudButton`.
+  * Removed hard-coded values from `HeroActionBar`.
+  * Removed switch statements.
+  * Completed minor code cleanup.
+  * Added verification to only show skill and ability buttons for available character abilities. Empty buttons no longer load for characters. <!-- GOMPS-356 -->
+
+* Added a call to warm up shaders when the project starts to ensure animations issues do not occur. <!-- GOMPS-367 -->
+* Removed collision from objects that have a Broken (dead) state. <!-- GOMPS-461 -->
+* Implemented a better cooldown solution and calculations for tracking and managing character, imp, and boss actions. <!-- GOMPS-468 PR 309-->
+* Updated event registration and unregistration code to be symmetrical across the project.<!-- GOMPS-471 -->
+
+## Fixes
+
+This release includes the following issue fixes:
+
+* Fixed an issue where any player that plays the game and then returns to the Main Menu may be unable to Start or Join properly again, requiring you to restart the client. <!-- GOMPS-355 -->
+* Updates and refinements in Boss Room resolved an issue that occurred in some degraded network conditions that caused a replicated entity on a client to vanish from that client, creating the effect of being assailed by an invisible enemy. <!-- GOMPS-380-->
+* Fixed displayed graphical affects for casting and blocking a Bolt to correctly match the caster and target, and properly stops animations for cancelled actions across clients.  <!-- GOMPS-417 GOMPS-467 PR #223-->
+* Fixed a rare exception when the Tank character uses her Shield Aura ability to intercept the Boss charge attack. <!-- GOMPS-435 -->
+* Fixed an issue returning all clients to the Main Menu when the host leaves the Boss Room. <!-- GOMPS-439-->
+* Green quads no longer show on impact when the Archer arrow strikes enemies. <!-- GOMPS-460 -->
+* Fixed issue to correctly allow one player to receive a character when two players in the Character Select click **Ready** for the same hero at the same time. Character Select is no longer blocked.  <!-- GOMPS-390 -->
+* Fixed an issue with boss collisions with a Pillar correctly applying a stun effect and shattering the pillar when using the Trample attack. <!-- PR #206 gomps-330 -->
+* Fixed the lobby welcome messages to correctly list the player names, including a previous issues for P1 and P2. <!-- GOMPS-428 --> 
+* On Windows, investigated and fixed issues with visible effects for character actions including mage freeze attack.<!-- GOMPS-347-->
+* On Windows, fixed issue with imp spawners not respawning new imps after exploring the room. <!-- GOMPS-353-->
+* Fixed an issue where the door state does not reflect the existing state when players connect late to a game, for example if other players open the door and a player joins late the door displays as closed. <!-- GOMPS-409 -->
+* Removed a previous work-around for character selections when host replays a completed game. The issue was resolved, allowing players to see character selections during replay. <!-- GOMPS-444 -->
+* Fixed collision wall settings, fixing an issues where the boss knock-back ability sent players through walls. <!-- GOMPS-289 -->
+* Resolved an issue where any players leaving the lobby sent all players to the lobby. <!-- GOMPS-431 -->
+* Fixed the ignored health amount (HP parameter) for revived characters. The correct value correctly sets the revived character to a lower amount than maximum. <!-- GOMPS-498 GOMPS-485 PR 267 GH 267-->
+* Fixed animations for enemies including the smoke animation for destroyed imps and the boss helmet when crying. <!-- GOMPS-500, 463 -->
+* Fixed loading of the game skybox before the menu loaded.<!-- GOMPS-459 -->
+
+## Known issues
+
+The following issues may occur for access and games:
+
+* An MLAPI soft sync error on cleanup between scene transitions may break the game, for example imps do not spawn and pots are intangible.  <!-- GOMPS-535, MTT-772-->
+* The game can be initiated while a second player is connecting to the host in `CharSelect`. Players may join without selected characters spawning and in an unresponsive state.<!-- GOMPS-534 -->
+* Sometimes after completing a match and the host starts a new match from the Victory or Loss screen, connected players may have no visible interactions to join or select characters. A work-around is implemented to not block entry into the game. <!-- GOMPS-464 GOMPS-506 still an issue -->
+* Sometimes the client may be disconnected from Photon which causes a timeout and `PhotonRealtimeTransport` to be in a bad state after the shutdown. An exception is developed that fires every frame. <!-- GOMPS-525 GOMPS-532 MLAPI GH 70 -->
+
+## Learn more
+
+See [Getting Started with Boss Room](/docs/learn/bossroom) to install and get started with Boss Room.
+
+To provide feedback and content on documentation, see the links at the bottom of each page.