Develop into main (#1291)

Co-authored-by: Vic Cooper <[email protected]>
Co-authored-by: Dominick <[email protected]>
Co-authored-by: Rémi MACH <[email protected]>
Co-authored-by: LagowiecDev <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Griffin of Innatical <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Steve Diniro <[email protected]>
Co-authored-by: s-omeilia-unity <[email protected]>
Co-authored-by: Alex Martin <[email protected]>
Co-authored-by: Monaxys <[email protected]>
Co-authored-by: Flap27 <[email protected]>
Co-authored-by: NRTnarathip <[email protected]>
Co-authored-by: Elfi0Kuhndorf <[email protected]>
Co-authored-by: CodeSmile <[email protected]>
Co-authored-by: Frank Luong <[email protected]>
Co-authored-by: Sue Arkin <[email protected]>

Author: 19 people

docs/learn/distributed-authority-quick-start.md

@@ -11,12 +11,8 @@ Before you begin, you need the following:
 
 - An active Unity account with a valid license.
 - The [Unity Hub](https://unity.com/download).
-- A supported version of the Unity Editor. Refer to the [Netcode for GameObjects requirements](https://docs-multiplayer.unity3d.com/netcode/current/installation).
-
-## Install packages
-
-- Install the latest `com.unity.services.multiplayer` Multiplayer Services package.
-- Install the latest `com.unity.netcode.gameobjects` Netcode for GameObjects package.
+- A supported version of the Unity 6 Editor.
+  - Additional requirements information can be found here: [Netcode for GameObjects requirements](https://docs-multiplayer.unity3d.com/netcode/current/installation).
 
 ## Project setup
 
@@ -28,14 +24,29 @@ Before you begin, you need the following:
 
 ![connect unity cloud](/img/learn/distributed-authority-quick-start/connect-unity-cloud.png)
 
-:::note Access during alpha and beta
-During alpha and beta, you need to request access to the distributed authority service. To do so, provide your Unity contact with the ID of the Unity Cloud project you created.
-:::
+## Install packages
 
-## Connection setup
+- Install the latest `com.unity.netcode.gameobjects` Netcode for GameObjects **v2.0.0** package.
+- Install the latest `com.unity.services.multiplayer` Multiplayer Services package.
+
+## Netcode for GameObjects setup
+
+1.  Using the SampleScene, add a new *Empty* object and name it *NetworkManager*.
+
+2. Attach a Network Manager component to it.
+![add network manager](/img/learn/distributed-authority-quick-start/network-manager.png)
+
+3. Under the Network Settings, set the **Network Topology** property to **Distributed Authority**.
+![set network topology](/img/learn/distributed-authority-quick-start/network-topology.png)
+
+4. Under **Network Transport**, select **UnityTransport** from the list of options to add.
+![use unity transport](/img/learn/distributed-authority-quick-start/unity-transport.png)
+
+5. Save any changes to your objects and scene.
 
-1. Create a new script called *ConnectionManager.cs*. This script provides a user interface and connects to a distributed authority service session:
+## Connection setup
 
+1. Create a new script called *ConnectionManager.cs*. This script provides a user interface and the script logic required to connect to a distributed authority service session:
 ```cs
 using System;
 using System.Threading.Tasks;
@@ -51,6 +62,7 @@ public class ConnectionManager : MonoBehaviour
    private int _maxPlayers = 10;
    private ConnectionState _state = ConnectionState.Disconnected;
    private ISession _session;
+   private NetworkManager m_NetworkManager;
 
    private enum ConnectionState
    {
@@ -59,10 +71,29 @@ public class ConnectionManager : MonoBehaviour
        Connected,
    }
 
-   private async void Awake()
-   {
-       await UnityServices.InitializeAsync();
-   }
+    private async void Awake()
+    {
+        m_NetworkManager = GetComponent<NetworkManager>();
+        m_NetworkManager.OnClientConnectedCallback += OnClientConnectedCallback;
+        m_NetworkManager.OnSessionOwnerPromoted += OnSessionOwnerPromoted;
+        await UnityServices.InitializeAsync();
+    }
+
+    private void OnSessionOwnerPromoted(ulong sessionOwnerPromoted)
+    {
+        if (m_NetworkManager.LocalClient.IsSessionOwner)
+        {
+            Debug.Log($"Client-{m_NetworkManager.LocalClientId} is the session owner!");
+        }
+    }
+
+    private void OnClientConnectedCallback(ulong clientId)
+    {
+        if (m_NetworkManager.LocalClientId == clientId)
+        {
+            Debug.Log($"Client-{clientId} is connected and can spawn {nameof(NetworkObject)}s.");
+        }
+    }
 
    private void OnGUI()
    {
@@ -122,70 +153,139 @@ public class ConnectionManager : MonoBehaviour
 }
 ```
 
-2. Attach this script to a new object in your scene.
-
+2. Add the `ConnectionManager` component script you created to the  *NetworkManager* object.
 ![add connection manager](/img/learn/distributed-authority-quick-start/create-connection-manager.png)
 
-## Netcode for GameObjects setup
-
-1. Create a new object in your scene called *NetworkManager*. Attach a Network Manager component to it.
-
-![add network manager](/img/learn/distributed-authority-quick-start/network-manager.png)
-
-2. Set **Session Mode** to **Distributed Authority**.
-
-![set session mode](/img/learn/distributed-authority-quick-start/session-mode.png)
-
-3. Under **Network Transport**, select **UnityTransport** from the list of options to add.
-
-![use unity transport](/img/learn/distributed-authority-quick-start/unity-transport.png)
-
-4. Save any changes to your objects and scene.
-
 ## Adding gameplay
 
 1. Create a new Script called *PlayerCubeController.cs*:
-
 ```cs
-using Unity.Netcode;
 using Unity.Netcode.Components;
 using UnityEngine;
+#if UNITY_EDITOR
+using Unity.Netcode.Editor;
+using UnityEditor;
+/// <summary>
+/// The custom editor for the <see cref="PlayerCubeController"/> component.
+/// </summary>
+[CustomEditor(typeof(PlayerCubeController), true)]
+public class PlayerCubeControllerEditor : NetworkTransformEditor
+{
+    private SerializedProperty m_Speed;
+    private SerializedProperty m_ApplyVerticalInputToZAxis;
+
+
+    public override void OnEnable()
+    {
+        m_Speed = serializedObject.FindProperty(nameof(PlayerCubeController.Speed));
+        m_ApplyVerticalInputToZAxis = serializedObject.FindProperty(nameof(PlayerCubeController.ApplyVerticalInputToZAxis));
+        base.OnEnable();
+    }
+
+
+    public override void OnInspectorGUI()
+    {
+        var playerCubeController = target as PlayerCubeController;
+
+
+        playerCubeController.PlayerCubeControllerPropertiesVisible = EditorGUILayout.BeginFoldoutHeaderGroup(playerCubeController.PlayerCubeControllerPropertiesVisible, $"{nameof(PlayerCubeController)} Properties");
+        if (playerCubeController.PlayerCubeControllerPropertiesVisible)
+        {
+            EditorGUILayout.PropertyField(m_Speed);
+            EditorGUILayout.PropertyField(m_ApplyVerticalInputToZAxis);
+        }
+        EditorGUILayout.EndFoldoutHeaderGroup();
+
+
+        EditorGUILayout.Space();
+
+
+        playerCubeController.NetworkTransformPropertiesVisible = EditorGUILayout.BeginFoldoutHeaderGroup(playerCubeController.NetworkTransformPropertiesVisible, $"{nameof(NetworkTransform)} Properties");
+        if (playerCubeController.NetworkTransformPropertiesVisible)
+        {
+            // End the header group prior to invoking the base OnInspectorGUID in order to avoid nested
+            // foldout groups.
+            EditorGUILayout.EndFoldoutHeaderGroup();
+            // If NetworkTransform properties are visible, then both the properties any modified properties
+            // will be applied.
+            base.OnInspectorGUI();
+        }
+        else
+        {
+            // End the header group
+            EditorGUILayout.EndFoldoutHeaderGroup();
+            // If NetworkTransform properties are not visible, then make sure we apply any modified properties.
+            serializedObject.ApplyModifiedProperties();
+        }
+    }
+}
+#endif
+
 
-public class PlayerCubeController : NetworkBehaviour
+public class PlayerCubeController : NetworkTransform
 {
-   public float speed = 20;
+#if UNITY_EDITOR
+    // These bool properties ensure that any expanded or collapsed property views
+    // within the inspector view will be saved and restored the next time the
+    // asset/prefab is viewed.
+    public bool PlayerCubeControllerPropertiesVisible;
+    public bool NetworkTransformPropertiesVisible;
+#endif
 
-   private NetworkTransform _transform;
 
-   private void Start()
-   {
-       _transform = GetComponent<NetworkTransform>();
-   }
+    public float Speed = 10;
+    public bool ApplyVerticalInputToZAxis;
 
-   private void Update()
-   {
-       var movement = new Vector3(Input.GetAxis("Horizontal"), Input.GetAxis("Vertical"));
-       _transform.transform.position += movement * speed * Time.deltaTime;
-   }
-}
-```
 
-2. Create a new prefab called *PlayerCube* and open it for editing.
-    - Attach the *PlayerCubeController* to the prefab. When prompted to add a NetworkObject, select **Yes**.
-    - Attach a Network Transform component as well. Make sure all the **Ownership** flags are unchecked.
+    private Vector3 m_Motion;
+
 
-![setup network transform](/img/learn/distributed-authority-quick-start/network-transform.png)
+    private void Update()
+    {
+        // If not spawned or we don't have authority, then don't update
+        if (!IsSpawned || !HasAuthority)
+        {
+            return;
+        }
 
-3. Attach a child object in the prefab. Select the root of the prefab, right-click, and select **3D Object > Cube**.
 
-![add the cube](/img/learn/distributed-authority-quick-start/create-cube.png)
+        // Handle acquiring and applying player input
+        m_Motion = Vector3.zero;
+        m_Motion.x = Input.GetAxis("Horizontal");
 
-4. Save all changes to the prefab.
 
-5. Open the Network Manager, navigate to **Prefab Settings**, and set the **Default Player Prefab** to be **PlayerCube**.
+        // Determine whether the vertical input is applied to the Y or Z axis
+        if (!ApplyVerticalInputToZAxis)
+        {
+            m_Motion.y = Input.GetAxis("Vertical");
+        }
+        else
+        {
+            m_Motion.z = Input.GetAxis("Vertical");
+        }
 
-![set the prefab](/img/learn/distributed-authority-quick-start/player-cube.png)
 
+        // If there is any player input magnitude, then apply that amount of
+        // motion to the transform
+        if (m_Motion.magnitude > 0)
+        {
+            transform.position += m_Motion * Speed * Time.deltaTime;
+        }
+    }
+}
+```
+2. In the open *SampleScene*, create a 3D cube and name it *PlayerCube*.
+![create PlayerCube object](/img/learn/distributed-authority-quick-start/player-cube.png)
+3. Add a `NetworkObject` component to the *PlayerCube*.
+![add a NetworkObject component](/img/learn/distributed-authority-quick-start/add-networkobject.png)
+4. Add the *PlayerCubeController* to the *PlayerCube*.
+![add the PlayerCubeController component](/img/learn/distributed-authority-quick-start/add-playercubecontroller.png)
+5. Create a Prefabs folder in the root Assets folder.
+6. Drag and drop the *PlayerCube* object into the newly created Prefabs folder.
+![create the player cube prefab](/img/learn/distributed-authority-quick-start/create-playercube-prefab.png)
+6. Delete the *PlayerCube* object from your scene.
+5. Open the Network Manager, navigate to **Prefab Settings**, and set the **Default Player Prefab** to be the newly created *PlayerCube*.
+![set the default player prefab](/img/learn/distributed-authority-quick-start/assign-default-player-prefab.png)
 6. Save all changes to the scene.
 
 ## Next steps

docusaurus.config.js

@@ -369,9 +369,17 @@ module.exports = {
         lastVersion: "current",
         versions: {
           current: {
-            label: "1.1.0",
+            label: "1.2.0",
             path: "current",
           },
+          "1.1.0": {
+            label: "1.1.0",
+            path: "1.1.0",
+          },
+          "1.0.0": {
+            label: "1.0.0",
+            path: "1.0.0",
+          },
           "1.0.0": {
             label: "1.0.0",
             path: "1.0.0",

mppm/about.md

@@ -6,6 +6,10 @@ description: Overview of Multiplayer Play Mode
 
 Use Multiplayer Play Mode to test multiplayer functionality within the Unity Editor. You can simulate up to four players (the Main Editor and three Virtual Players) simultaneously on the same development device while using the same source assets on disk. Multiplayer Play Mode can help you create multiplayer development workflows that reduce project build times, run it locally, and test the server-client relationship.
 
+## Compatibility
+
+Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 6000.0.3f1 or later.
+
 ## Multiplayer Play Mode terminology
 
 The following have specific meaning in relation to Multiplayer Play Mode:

mppm/install.md

@@ -4,10 +4,11 @@ title: Install Multiplayer Play Mode
 description: How to install Multiplayer Play Mode
 ---
 
-To begin testing your multiplayer functionality, you must first install the Multiplayer Play Mode package.
+You can use Multiplayer Play Mode version 1.1.0 in Unity Editor versions 6000.0.3f1 or later. Multiplayer Play mode versions 1.0.0 and earlier are compatible with Unity version 2023.1 or later.
+To install the Multiplayer Play Mode package, follow these steps:
 
 1. Open Unity Hub.
-2. Select a Project.
+2. Select a Project to open it.
 3. In the Editor's menu bar, navigate to **Window** > **Package Manager**.
 4. Select **Unity Registry**.
 5. Select the **Multiplayer Play Mode** package. 

mppm/release-notes/release-notes.md

@@ -4,6 +4,15 @@ title: Release notes
 description: Release notes for Multiplayer Play Mode including new features, updates, bug fixes, and known issues.
 ---
 
+## [1.2.0] - 2024-06-04
+
+### Added
+- Added tooltips to the preferences window
+
+### Fixed
+- Fixed an issue that hid Multiplayer roles when you reinstalled the Dedicated Server Package.
+- Fixed the main view window so that when you make it smaller the UI is not affected.
+
 ## [1.1.0] - 2024-04-24
 
 ### Added
@@ -22,7 +31,7 @@ description: Release notes for Multiplayer Play Mode including new features, upd
 - The escape key no longer closes virtual player windows on Windows devices.
 - Fixed issues with heartbeat timeout.
 - Removed the forward slash **/** character from tags because it's for drop-down behavior only.
-  
+
 ## [1.0.0] - 2024-03-12
 
 ### Added

mppm/sync-play-mode.md

@@ -12,7 +12,7 @@ Multiplayer Play Mode syncs the Main Editor and [Virtual Players](../virtual-pla
 | **Pause** | Pauses all activated Players (Main Editor and Virtual Players) |
 | **Step** | Performs a single-frame step for all activated Players (Main Editor and Virtual Players) |
 
-In the toolbar of the **Play Mode** window, you can adjust the layout with the **Layout** dropdown. You can select and deselect the **Console**, **Game**, **Hierarchy**, **Inspector**, and **Scene**. Select **Apply** to implement your changes to the layout.
+You can change the layout of the **Multiplayer Play Mode** window with the **Layout** dropdown. To learn more, refer to [Change the layout of a Virtual Player](virtual-players-layout).
 
 :::note
 If you enable Error Pause in the [Console](https://docs.unity3d.com/Manual/Console.html) toolbar of any Player, all Virtual Players pause when you call `Debug.LogError` from a script.

mppm/sys-req.md

@@ -6,7 +6,7 @@ title: System requirements and compatibility
 The Multiplayer Play Mode package requires the following:
 
 - Unity Editor version 2023.1 or later.
-- An active Project in Unity Hub.
+- An active Project in the Unity Hub.
 
 ## Compatibility
 Multiplayer Play Mode is compatible with the following multiplayer packages and services: 

mppm/troubleshoot/debug-mppm.md

@@ -6,6 +6,10 @@ description: Learn how to test a player running in Multiplayer Play Mode
 
 Use the Test Runner included in the [Unity Test Framework (UTF)](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) to test players in a multiplayer project.
 
+:::note: 
+Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 6000.0.3f1 or later. Multiplayer Play mode versions 1.0.0 and earlier are compatible with Unity version 2023.1 or later.
+:::
+
 ## Test a player
 To open the Test Runner window go to **Window** > **General** > **Test Runner**.