diff --git a/docusaurus.config.js b/docusaurus.config.js index d0576b573..14be1b8d4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -385,12 +385,8 @@ module.exports = { lastVersion: "current", versions: { current: { - label: "1.4.0-pre", - path: "current", - }, - "1.3.2": { label: "1.3.2", - path: "1.3.2", + path: "current", }, "1.2.0": { label: "1.2.0", diff --git a/mppm_versioned_docs/version-1.3.2/about.md b/mppm_versioned_docs/version-1.3.2/about.md deleted file mode 100644 index 6cfe6ece1..000000000 --- a/mppm_versioned_docs/version-1.3.2/about.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: about -title: About Multiplayer Play Mode -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 Player 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.3.0 is compatible with Unity Editor versions 6000.0.22f1 or later. - -## Multiplayer Play Mode terminology - -The following have specific meaning in relation to Multiplayer Play Mode: - -* main Editor Player: The original instance of the project in the Unity Editor. This is the only instance with full authoring capabilities. -* Virtual Players: Simulated Players created with Multiplayer Play Mode. These Players open in a separate window with limited authoring capabilities when you enter [Play mode](https://docs.unity3d.com/Manual/GameView.html). -* Players: All Player instances, including the main Editor Player and all Virtual Players. - -## Limitations - -Multiplayer Play Mode has some inherent technical limitations, specifically around [scale](#scale) and [authoring](#authoring). - -### Scale - -The Unity Editor and Virtual Players require a lot of system resources, so you shouldn't use Multiplayer Play Mode at scale. Multiplayer Play Mode is designed for small-scale, local testing environments that can only support up to four total Players (the main Editor Player and three Virtual Players). - -### Authoring -You can't create or change the properties of GameObjects in a Virtual Player. Instead, use the main Editor Player to make changes and a Virtual Player to test multiplayer functionality. Any changes you make in Play Mode in the main Editor Player reset when you exit Play Mode. -:::note -You can't access any main Editor Player functionality from Virtual Players. -::: - -## Performance impact - -To reduce the demand on system resources caused by each Virtual Player instance, Multiplayer Play Mode shares specific resources, such as the artifact database and imports between the main Editor Player and each Virtual Player. diff --git a/mppm_versioned_docs/version-1.3.2/dedicated-server/multiplayer-role.md b/mppm_versioned_docs/version-1.3.2/dedicated-server/multiplayer-role.md deleted file mode 100644 index 959c3169e..000000000 --- a/mppm_versioned_docs/version-1.3.2/dedicated-server/multiplayer-role.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: multiplayer-role -title: Assign Virtual Players to a Multiplayer Role -description: Learn how to use the dedicated server package to assign Virtual Players to a Multiplayer Role. ---- - -Install the [Dedicated Server package](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/index.html) with Multiplayer Play Mode to switch Players between the server and client role without a script. - -::: Important -To avoid errors, install the Dedicated Server package version that is the same as the Multiplayer Play mode version that exists in your project. -::: - -## Set the main Editor Player Multiplayer Role - -To set the role of a the main Editor Player, do the following: - -1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**). -2. In the **main Editor Player** section, expand the **Multiplayer Role** dropdown. -3. Select the [Multiplayer Role](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/multiplayer-roles.html) you want the main Editor Player to use. - -## Set the Multiplayer Role of a Virtual Player - -To set the role of a [Virtual Player](../../virtual-players), do the following: - - 1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**). - 2. In the **Virtual Players** section, expand a Virtual Player's **Multiplayer Role** dropdown. - 3. Select the [Multiplayer Role](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/multiplayer-roles.html) you want this Player to use. diff --git a/mppm_versioned_docs/version-1.3.2/dedicated-server/play-mode-dedicated-server.md b/mppm_versioned_docs/version-1.3.2/dedicated-server/play-mode-dedicated-server.md deleted file mode 100644 index b11b97caa..000000000 --- a/mppm_versioned_docs/version-1.3.2/dedicated-server/play-mode-dedicated-server.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: play-mode-dedicated-server -title: Use Multiplayer Play mode with a Dedicated Server -description: Use the dedicated server package with multiplayer play mode. ---- - -The [Dedicated Server package](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/index.html) adds [Multiplayer Roles](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/multiplayer-roles.html) to the [Dedicated Server build platform](https://docs.unity3d.com/Manual/dedicated-server-introduction.html). You can use Multiplayer Roles to assign virtual players to a client, server, or client and server Multiplayer Role. - - - -|**Page** |**Description**| -|-|-| -|[Debug Multiplayer Play Mode](debug-mppm.md)| Learn how to use Unity Test Framework to test a project with Multiplayer Play Mode. | diff --git a/mppm_versioned_docs/version-1.3.2/install.md b/mppm_versioned_docs/version-1.3.2/install.md deleted file mode 100644 index 94a617aea..000000000 --- a/mppm_versioned_docs/version-1.3.2/install.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: install -title: Install Multiplayer Play Mode -description: How to install Multiplayer Play Mode ---- - -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 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. -6. Select **Install**. - -## Next steps - -You can now access and configure your [Virtual Players](../virtual-players) and their [tags](../player-tags). diff --git a/mppm_versioned_docs/version-1.3.2/mppm-reference/mppm-reference-lp.md b/mppm_versioned_docs/version-1.3.2/mppm-reference/mppm-reference-lp.md deleted file mode 100644 index ea82266fd..000000000 --- a/mppm_versioned_docs/version-1.3.2/mppm-reference/mppm-reference-lp.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: mppm-reference-lp -title: Property refererence -description: Information about Multiplayer Play Mode properties. ---- - -This section explains the behavior of properties that relate to Multiplayer Play Mode. - -|**Page title**|**Description**| -|-|-| -|[Instances status dropdown reference](play-mode-scenario-dropdown-reference.md)| Describes the meaning of each status icon in the Play Mode Scenarios dropdown.| -|[Play Mode Scenarios window reference](play-mode-scenario-window-reference.md)| Describes the behavior of the properties in the Play Mode Scenarios window.| -|[Play Mode status window reference](play-mode-status-window-reference.md)| Describes the behavior of the properties in the Play Mode status window. | -|[Play Mode scenario instances status reference](play-mode-scenario-instances-status-reference.md)|Describes the meaning of each status icon in the instances status dropdown.| - -## Additional resources -- [Multiplayer Roles reference](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/multiplayer-roles-reference.html) -- [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md) -- [Troubleshoot a test build](troubleshoot/play-mode-scenario-troubleshoot.md) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-dropdown-reference.md b/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-dropdown-reference.md deleted file mode 100644 index 7bda36945..000000000 --- a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-dropdown-reference.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: play-mode-scenario-dropdown-reference -title: Play Mode scenario dropdown reference -description: Descriptions of the status icons in the Play Mode scenario dropdown. ---- -This table explains the meaning of each status icon in the Play Mode Scenarios dropdown that appears next to the Play Mode buttons. - -|**Property**|**Description**| -|-|-| -|![Warning icon](/img/Warning-32.png) Warning|You need to change some settings in the Play Mode Scenarios window for this Play Mode scenario to function correctly. For more information, refer to the error box that appears in the Play Mode Scenarios window. | -|![Scenario icon](/img/d_PlaymodeScenario-32.png) Scenario| A Play Mode scenario that contains Play Mode settings.| - -## Additional resources -* [Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md) -* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-instances-status-reference.md b/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-instances-status-reference.md deleted file mode 100644 index c92c3acbf..000000000 --- a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-instances-status-reference.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: play-mode-scenario-instances-status-reference -title: Play Mode scenario instances status reference -description: Descriptions of the status icons in the instances status dropdown. ---- -This table explains the meaning of each status symbol in the instances status dropdown that appears next to the Play Mode Scenarios dropdown. - -|**Property**|**Description**| -|-|-| -|![Warning icon](/img/Warning-32.png) Warning|This Play Mode scenario is not configured correctly. For more information, refer to the error box that appears in the Play Mode Scenarios window. | -|![Error icon](/img/Error-32.png) Error|This Play Mode scenario does not function correctly. For more information, refer to the error that appears in the console window. | -|![Loading icon](/img/d_Loading-32.png) Loading|Unity is currently performing a building or loading step.| -|![Connected and Running icon](/img/CompletedTask-32.png) Connected and Running|This Play Mode scenario is active with no errors.| -|![Idling icon](/img/d_IdleState-2x.png) Idling|This Play Mode scenario is not yet active. To activate it, enter Play Mode.| -|![Go to dashboard icon](/img/go-to-dashboard-32.png) Go to dashboard|Select this icon to open the Services dashboard in your web browser.| -|![Open status window icon](/img/d_WindowInstance-32.png) Open status window|Select this icon to open the Play Mode Status window to see more information for each instance.| - -## Additional resources -* [Play Mode Scenarios requirements and limitations](play-mode-scenario/play-mode-scenario-req.md) -* [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay) -* [Play Mode scenario window reference](/mppm-reference/play-mode-scenario-window-reference.md) -* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-window-reference.md b/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-window-reference.md deleted file mode 100644 index eeeee0b21..000000000 --- a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-window-reference.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: play-mode-scenario-window-reference -title: Play Mode scenario window reference -description: Descriptions of the properties in the Play Mode Scenario window. ---- - -This table explains the behavior of each property in the Play Mode Scenarios window. - -|**Property**|||**Description**| -|-|-|-|-| -|Description|||Enter a description for this instance. This description exists as a tooltip for this Play Mode Scenario in the [Play Mode scenario dropdown](play-mode-scenario-dropdown-reference.md). | -|Editor|||The instance that exists in the main Unity Editor.| -||Multiplayer Role||The [Multiplayer Role](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/multiplayer-roles.html) that this local instance uses. Unity uses this Multiplayer Role and ignores the Multiplayer Role you assign in the Project Settings window. This property appears when the [Dedicated Server package](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/index.html) exists in your project. -|||Tag||One or more reference words that you can use in a script to assign the main Editor Player to a certain behavior. To control whether a player exists on the client or server, use the **Multiplayer Role** property. -You can change the Multiplayer Role in the **File** > **Build Profiles** window.| -||Initial Scene||The scene that all instances display when you initialize them.| -|Additional Editor Instances|||A [virtual player](https://docs-multiplayer.unity3d.com/mppm/current/virtual-players/) that exists in the Unity Editor.| -||Name||The name for this additional Editor instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md). | -||Multiplayer Role||The [Multiplayer Role](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/multiplayer-roles.html) that this instance uses. Unity uses this Multiplayer Role and ignores the Multiplayer Role you assign in the Project Settings window. This property appears when the [Dedicated Server package](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/index.html) exists in your project| -||Tag||One or more reference words that you can use in a script to assign the main Editor Player to a certain behavior.
To control whether a player exists on the client or server, use the **Multiplayer Role** property.| -|Local Instances|||Instances of this project that run on your local machine.| -||Name||The name of this instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md).| -||Build Profile||The [Build Profile](https://docs.unity3d.com/6000.0/Documentation/Manual/build-profiles.html) that this instance uses. When you build on a Windows device, select the Windows platform. When you build on a MacOS device, select the MacOS platform.| -||Multiplayer Role||The [Multiplayer Role](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/multiplayer-roles.html) that this local instance uses. Unity uses this Multiplayer Role and ignores the Multiplayer Role you assign in the Project Settings window. This property appears when the [Dedicated Server package](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/index.html) exists in your project| -||Advanced Configuration||Optional properties that you can use to debug and control this local instance. | -|||Stream Logs To Main Editor|Select the checkbox to display logs from this instance in the Unity Editor Console.| -|||Logs Color|The color this instance uses to display logs in the Unity Editor.| -|||Arguments|The [UGS launch parameters](https://docs.unity.com/ugs/manual/game-server-hosting/manual/concepts/launch-parameters) that modify this instance.| -|Remote Instances|||Instances that exist in the [Unity Cloud](https://docs.unity.com/cloud/en-us) and use [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay).| -||Name||The name of this instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md).| -||Identifier||The label, in a string, that determines the name of the Multiplay build, fleet, and server. This string field uses the format `CreatedFromTheUnityEditor-[identifier]-[username]`. Don't use any special characters.| -||Multiplayer Role||The [Multiplayer Role](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/multiplayer-roles.html) that this remote instance uses. Unity uses this Multiplayer Role and ignores the Multiplayer Role you assign in the Project Settings window. This property appears when the [Dedicated Server package](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/index.html) exists in your project| -||Advanced Configuration|||Optional properties that you can use to debug and control this remote instance. | -|||Fleet Name|The name of the server fleet to display in the Multiplayer Hosting environment. | -|||Fleet Region|The server region this instance runs from.| -|||Instance Amount of Cores|The amount of CPU cores this remote instance requests from the server.| -|||Instance Memory|The amount of memory, in megabytes, that this instance requests from the server. To learn how much memory your project uses, use the [memory profiler package](https://docs.unity3d.com/Packages/com.unity.memoryprofiler@1.1/manual/index.html).| -|||Instance CPU Clockspeed|The amount of CPU time, in megahertz, that this instance requests from the server.| -|||Stream Logs To Main Editor|Select the checkbox to display logs from this instance in the Unity Editor Console.| -|||Logs Color|The color of text that displays in the Unity Editor for logs that relate to this instance.| -|||Arguments|The [UGS launch parameters](https://docs.unity.com/ugs/manual/game-server-hosting/manual/concepts/launch-parameters) that modify this instance.| - -## Additional resources -* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md) -* [Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md) -* [Play Mode Scenarios requirements and limitations](play-mode-scenario/play-mode-scenario-req.md) diff --git a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-status-window-reference.md b/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-status-window-reference.md deleted file mode 100644 index 7c93e317f..000000000 --- a/mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-status-window-reference.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: play-mode-status-window-reference -title: Play Mode status window reference -description: Descriptions of the properties in the Play Mode status window. ---- -This table explains the behavior of each property in the Play Mode status window. The properties that appear in this window change depending on the Playmode Scenarios that exist for your project. - -|**Property**|**Description**| -|-|-| -|Tags|Displays the tags that you assign to this instance in the **Play Mode Configuration** window. | -|Disconnect|Disconnect this Play Mode instance from the local or remote server.| - -## Additional resources -* [Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md) -* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/mutliplayer-terms.md b/mppm_versioned_docs/version-1.3.2/mutliplayer-terms.md deleted file mode 100644 index 7d0826733..000000000 --- a/mppm_versioned_docs/version-1.3.2/mutliplayer-terms.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: mtt-terms -title: Multiplayer Networking Terminology ---- - -The following are essential, high-level terms used in multiplayer networking and Netcode for GameObjects: - -import MTTterms from '/static/shared/_terminology.md'; - - \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-about.md b/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-about.md deleted file mode 100644 index bb82497d3..000000000 --- a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-about.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: play-mode-scenario-about -title: Test live instances locally and remotely -description: Learn how to use the Play Mode Scenarios window to test a multiplayer project ---- - -To test one or more instances of a multiplayer project on a local machine or a remote server, use the Play Mode Scenarios window. This window replicates the circumstances of a project that multiple users access from different environments that have different limitations. - -## Additional resources -* [Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md) -* [Play Mode scenario window reference](mppm-reference/play-mode-scenario-window-reference.md) -* [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay) -* [Dedicated Server](https://docs.unity3d.com/Manual/dedicated-server.html) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-configure-build.md b/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-configure-build.md deleted file mode 100644 index e045d1874..000000000 --- a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-configure-build.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: play-mode-scenario-configure-build -title: Configure and build local and remote instances -description: Learn how to set up and run instances in the Play Mode Scenario window. ---- - -When you set up a Play Mode scenario, you can create the following type of instances: - -* Additional Editor -* Local -* Remote - -## Configure and build a remote instance - -A remote instance exists in the [Unity Cloud](https://docs.unity.com/cloud/en-us) and uses [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay). You can start using Multiplay Hosting for free, but server use can incur a cost even when it's not running a process or hosting any users. To reduce cost in a project that uses Multiplay Hosting, open the [Unity Cloud Dashboard](http://cloud.unity.com/) and reduce the **Minimum Available Scaling** property value to 0. To learn more about Multiplay Hosting costs, refer to [UGS pricing](https://unity.com/products/gaming-services/pricing). - -You can only have one remote instance in a Play Mode Scenario and it can only run on a Linux platform. - -To learn more about the properties that you can use to configure a remote instance, refer to [Play Mode Scenarios window reference](mppm-reference/play-mode-scenario-window-reference.md). - -## Configure and build a local instance -A local instance exists on the same platform as the Unity Editor. To build a local instance that you have configured in the Play Mode Scenarios window, [enter Play Mode](https://docs.unity3d.com/Manual/GameView.html). All configured Play Mode Scenarios build automatically when you enter Play Mode. - -To learn more about the properties that you can use to configure a local instance, refer to [Play Mode Scenarios window reference](mppm-reference/play-mode-scenario-window-reference.md). - -## Check the status of all instances -The Play Mode status window displays the following information for each Play Mode scenario: -* Status -* Port -* Address -* Errors - -To open the Play Mode status window: - -1. Enter Play Mode. -2. Expand the Play Mode status dropdown. -3. Select the status window icon. - -## Additional resources -* [Play Mode Scenarios requirements and limitations](play-mode-scenario-req) -* [Create a Play Mode scenario](play-mode-scenario-create.md) -* [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay) -* [Troubleshoot a test build](play-mode-scenario-troubleshoot.md) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-create.md b/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-create.md deleted file mode 100644 index e0a8a0eb8..000000000 --- a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-create.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: play-mode-scenario-create -title: Create a Play Mode scenario -description: Add a Play Mode Scenario to your project. ---- - -To create a new Play Mode scenario: -1. [Install the Multiplayer Play Mode package](https://docs-multiplayer.unity3d.com/mppm/current/install/). -2. Select the Play Mode dropdown menu. -3. Select **Configure play mode scenarios…**. -4. In the Play Mode Scenarios window toolbar, select the (**+**) icon to create a new scenario. -5. Select the (**+**) icon under **Editor Instances**, **Local Instances**, or **Remote Instances**. -6. Select the picker for the Build Profiles property. -7. Select the Build Profile to assign to this instance. - -To learn more about the properties in the Play Mode Scenarios window, refer to [Play Mode Scenarios window reference](mppm-reference/play-mode-scenario-window-reference.md). - -## Additional resources - -- [Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md) -- [Play Mode scenario window reference](mppm-reference/play-mode-scenario-window-reference.md) -- [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay) -- [Build Profiles](https://docs.unity3d.com/6000.0/Documentation/Manual/build-profiles.html) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-req.md b/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-req.md deleted file mode 100644 index 0358b132a..000000000 --- a/mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-req.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: play-mode-scenario-req -title: Play Mode Scenarios requirements and limitations -description: Learn how to use the Play Mode Scenarios window to test a multiplayer project ---- - -To use the Play Mode Scenarios window, install the following packages: -* [Multiplayer Play Mode](https://docs-multiplayer.unity3d.com/tools/current/about/) -* [Dedicated server](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.3/manual/index.html) - -A Play Mode Scenario that contains a local or remote instance requires a Build Profile that matches the platform your project exists on. To learn how to assign a Build Profile, refer to [Create a Play Mode scenario](play-mode-scenario-create.md). Use a [Build Profile](https://docs.unity3d.com/6000.0/Documentation/Manual/build-profiles.html) to configure the type of build this scenario uses. To learn what each property in a Build Profile controls, refer to the [Build Profiles reference](https://docs.unity3d.com/6000.0/Documentation/Manual/build-profiles-reference.html). - -Remote instances use [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay). You can get started with a Unity Gaming service for free. To learn how billing works for each Unity Gaming service, refer to [UGS pricing](https://unity.com/products/gaming-services/pricing). - -## Compatibility -Playmode Scenarios is compatible with the following Unity features: -* Unity version 6000.0.3f01 and later -* [Netcode for GameObjects](https://docs-multiplayer.unity3d.com/netcode/1.6.0/about/) -* [Netcode for Entities](https://docs.unity3d.com/Packages/com.unity.netcode@1.0/manual/index.html) -* [Multiplayer Tools](https://docs-multiplayer.unity3d.com/tools/current/about/) - -## Limitations -The Play Mode Scenario window has the following limitations: - -* The Pause and Step icons in the Game View window are not supported for local and remote targets. -* You can only run a remote instance on the Linux platform. -* You can only run a local instance on Mac, Linux, or Windows platforms. -* Play Mode scenarios doesn’t support [Play Mode shortcuts](https://docs.unity3d.com/6000.0/Documentation/Manual/UnityHotkeys.html). - -## Additional resources -* [Netcode for Entities Project Setup](https://docs.unity3d.com/Packages/com.unity.netcode@1.0/manual/installation.html) -* [Multiplayer Play Mode System requirements and compatibility](sys-req.md) -* [Play Mode scenario window reference](mppm-reference/play-mode-scenario-window-reference.md) -* [Create a Play Mode scenario](play-mode-scenario-create.md) diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-attach.md b/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-attach.md deleted file mode 100644 index cd4503194..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-attach.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: player-tags-attach -title: Attach tags to a Player -description: Learn how to attach tags to a Player in Multiplayer Play Mode. ---- - -To assign one or more [tags](../../player-tags) to any Player, do the following: - -1. Open the Multiplayer Play mode window (**Window** > **Multiplayer Play Mode**). -2. Expand the **Tags** dropdown for a Player or the main Editor Player. -3. Select **+ Create Tag**. -4. In the Project Settings window that appears, select the **Add** (**+**) icon. -5. In the New tag field that appears, type a name for your tag. -6. Select **Save**. -7. In the Multiplayer Play Mode window, expand the **Tags** dropdown. -8. Select the tag you just created. diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-configure.md b/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-configure.md deleted file mode 100644 index d34ca202e..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-configure.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: player-tags-configure -title: Configure tags -description: Set up tags to use them to configure the player actions. ---- - -Tags don't do anything until you configure them. To configure a tag, do the following: - -1. Use `CurrentPlayer.ReadOnlyTags()` to target the tag in a script. -2. Attach the script to a [NetworkObject](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkobject/), for example, the **Player**. - -Use the following tag examples as guides for your own scripts: - -- [For a **Player** to run as a server, client, or host](../target-instance) -- [To automatically assign a **Player** to a team](../target-team) -- [To simulate network conditions](../target-network) diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-create.md b/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-create.md deleted file mode 100644 index 4c434df10..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags-create.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: player-tags-create -title: Create a tag -description: Use these steps to create tags to configure the player actions in Multiplayer Play Mode. ---- - -To create a tag, perform the following actions: - -1. To open the Multiplayer Play mode window, navigate to **Window** > **Multiplayer Play Mode**. -2. Expand the Tags dropdown for a Player or the main Editor Player. -3. Select ![plus sign](/img/add.png) Create Tag. -4. Name the tag. -5. Select **Save**. The new tag is automatically added to the local project directory in `...Projects\[example-project-name]\ProjectSettings\VirtualProjectsConfig.json`. -6. The new tag also appears under the **Player Tags** section of the **Multiplayer Play Mode** window and in the dropdown menu for the **Tag** option of each **Player**. diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags.md b/mppm_versioned_docs/version-1.3.2/player-tags/player-tags.md deleted file mode 100644 index c2ed93dfd..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/player-tags.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: player-tags -title: Information about tags -description: Learn how to use tags to configure Player actions in Multiplayer Play Mode. ---- - -Tags are similar to launch arguments for Players (both the main Editor Player and Virtual Players) that you can use to configure Players to behave in a specific way. For example: - -- Run as a client, server, or host automatically -- Automatically run as a member of a specific team (for example, “Red Team” or “Blue Team”) -- Move faster or slower to simulate their network connection - -You can assign multiple tags to a Player. - - - -|**Page** |**Description**| -|-|-| -|[Create tag](../player-tags/player-tags-create)| Learn how to create tags in code.| -|[Configure tag](../player-tags/player-tags-configure)| Learn how to set up tags to work in your project| -|[Attach a tag to a Player](../player-tags/player-tags-attach)| Learn how to assign tags to a specific Player.| diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/target-instance.md b/mppm_versioned_docs/version-1.3.2/player-tags/target-instance.md deleted file mode 100644 index 8290f193d..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/target-instance.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: target-instance -title: Use tags to run a player as a server, client, or host -description: This example shows how you can use Netcode for GameObjects to run a Player as a server, client, or host in Multiplayer Play Mode. ---- - -This example explains how to target tags in your game scripts with `CurrentPlayer.ReadOnlyTags()`. You can place these scripts where you want, but you must attach the scripts to a [NetworkObject](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkobject/) (such as the **Player**). - -You can also use the dedicated server package to set a tag to server, client, or host. For more information, refer to [Use Multiplayer Play Mode with a Dedicated Server](../dedicated-server/play-mode-dedicated-server.md). - -## Set a tag to server, client, or host in a script - -The following script uses the Netcode for GameObjects [NetworkManager](https://docs-multiplayer.unity3d.com/netcode/current/components/networkmanager/) to automatically connect the Virtual Player as a server, client, or host based on their tag. A Player with the `Server` tag automatically runs as a server, and a Player with the `Client` tag automatically runs as a client. - -:::important -This example uses the `Contains` method, which is case-sensitive by default. To make it case-insensitive, pass the `System.StringComparison.CurrentCultureIgnoreCase` method. -::: - -:::note -This example uses [Netcode for GameObjects](https://docs-multiplayer.unity3d.com/netcode/current/about/). -::: - -```csharp -using Unity.Netcode; -using UnityEngine; -using Unity.Multiplayer.Playmode; - -/// A MonoBehaviour to automatically start Netcode for GameObjects -/// clients, hosts, and servers -public class MppmConnect : MonoBehaviour -{ - void Start() - { - var mppmTag = CurrentPlayer.ReadOnlyTags(); - var networkManager = NetworkManager.Singleton; - if (mppmTag.Contains("Server")) - { - networkManager.StartServer(); - } - else if (mppmTag.Contains("Host")) - { - networkManager.StartHost(); - } - else if (mppmTag.Contains("Client")) - { - networkManager.StartClient(); - } - } -} -``` diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/target-network.md b/mppm_versioned_docs/version-1.3.2/player-tags/target-network.md deleted file mode 100644 index 1c52919a4..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/target-network.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: target-network -title: Configure a Player to simulate different network connections example -description: This example shows how you can use the Network Simulator and Players to test different network connections in Multiplayer Play Mode. ---- - -The logic in the following example checks if the tag has a string rather than if it’s equal to a string to allow for more flexibility with the name of the tag. You can change this logic so that it checks for an exact match. - -## Simulate network conditions - -This example script uses the Network Simulation Presets from the [Multiplayer Tools package](https://docs-multiplayer.unity3d.com/tools/current/install-tools/) to automatically simulate a fast or slow network based on the tag. A Player with the `FastNetwork` tag simulates a common [Home Broadband](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#home-broadband-connections) connection, and a Player with the `SlowNetwork` tag simulates a [Mobile 2.5G](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#mobile-25g) connection. - -:::note -This example uses the [Network Simulator](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/) tool from the `com.unity.multiplayer.tools` package. -::: - -```csharp -using System.Collections; -using System.Collections.Generic; -using UnityEngine; -using Unity.Multiplayer.Playmode; -using Unity.Multiplayer.Tools.NetworkSimulator.Runtime; - -public class NetworkSimulation : MonoBehaviour -{ - void Start() - { - var networkSimulator = GetComponent() ?? - gameObject.AddComponent(); - - var connectionPreset = NetworkSimulatorPresets.None; - if (CurrentPlayer.ReadOnlyTags() == "FastNetwork") - { - connectionPreset = NetworkSimulatorPresets.HomeBroadband; - } - else if (CurrentPlayer.ReadOnlyTags() == "SlowNetwork") - { - connectionPreset = NetworkSimulatorPresets.Mobile2_5G; - } - - networkSimulator.ConnectionPreset = connectionPreset; - } -} -``` diff --git a/mppm_versioned_docs/version-1.3.2/player-tags/target-team.md b/mppm_versioned_docs/version-1.3.2/player-tags/target-team.md deleted file mode 100644 index 4189031b9..000000000 --- a/mppm_versioned_docs/version-1.3.2/player-tags/target-team.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: target-team -title: Use tags to assign a player to a team -description: Automatically assign Players to different teams in Multiplayer Play Mode. ---- - -The logic in the following example checks if the tag has a string rather than if it’s equal to a string to allow for more flexibility with the name of the tag. You can change this logic so that it checks for an exact match. - -:::important -The following example uses the `Contains` method, which is case-sensitive by default. You can make it case-insensitive by passing the `System.StringComparison.CurrentCultureIgnoreCase` method. -::: - -## Automatically assign a Player to a team - -The following script automatically sets a [NetworkVariable](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkvariable/) called `Team` based on the tag. - -A Player with a `Red` tag automatically sets the `Team` NetworkVariable to `Red`. A Player with a `Blue` tag automatically sets the `Team` NetworkVariable to `Blue`. - -```csharp -using Unity.Netcode; -using UnityEngine; -using Unity.Multiplayer.Playmode; - -public enum Team { Blue, Red, } - -/// A player with a team that is automatically assigned -/// based on the tag of the client that owns them -public class Player : NetworkBehaviour -{ - public NetworkVariable team = new (writePerm: NetworkVariableWritePermission.Owner); - - void Start() - { - var localClientId = NetworkManager.Singleton.LocalClientId; - if (!team.CanClientWrite(localClientId)) - { - return; - } - var mppmTag = CurrentPlayer.ReadOnlyTags(); - if (mppmTag.Contains("Blue")) - { - team.Value = Team.Blue; - } - if (mppmTag.Contains("Red")) - { - team.Value = Team.Red; - } - } -} -``` diff --git a/mppm_versioned_docs/version-1.3.2/release-notes/release-notes.md b/mppm_versioned_docs/version-1.3.2/release-notes/release-notes.md deleted file mode 100644 index 9499d1266..000000000 --- a/mppm_versioned_docs/version-1.3.2/release-notes/release-notes.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -id: mppm-release-notes -title: Release notes -description: Release notes for Multiplayer Play Mode including new features, updates, bug fixes, and known issues. ---- - -## [1.3.2] - 2024-11-14 - -### Fixed -- Fixed clones so that they correctly deactivate when you stop a play mode scenario during the clone activation. -- Fixed the clone editor's layout configuration so that it displays correctly when you enable Playmode Tools. -- Fixed the compilation error "'UnityPlayer' does not contain a definition for 'Role'" when the Dedicated Server package version doesn't match. - -### Added -- On Windows devices, the Virtual Player window now remains anchored when you use the same layout in Play mode and Edit mode. - -## [1.3.1] - 2024-10-21 - -### Fixed - -- Fixed an issue where the "Player [X] failed to sync" window appeared without a synchronization issue. -- The Virtual Player folder now refreshes when you update the package, Unity Editor, or Editor changeset version. - -### Added - -- Added a help box to the Multiplayer window to stop package imports while the virtual player(s) are activating. The help box remains visible until all virtual player(s) are ready. -- Added Multiplayer Menu links to the **Scenario Configuration** and the **Scenarios** status in **Windows** > **Multiplayer**. - -## [1.3.0] - 2024-09-26 - -### Changed - -- Updated `com.unity.services.multiplayer` to release version 1.3.0. - -### Fixed - -- Increased the minimum Engine version to 6000.0.22f1 to fix a crash that happened when you use virtual players and a build profile. - -## [1.3.0-pre.3] - 2024-09-20 - -### Changed - -- Replaced the **Original Name** property in the **Remote Instances** > **Advance Configuration** section with the **Identifier** property. The **Identifier** string field creates a unique name for the Multiplay Build, Build Configuration, and Fleet. This name uses the format `CreatedFromTheUnityEditor-[identifier]-[username]`. - -### Added - -- Added stream logs to main editor option for additional editor instances. -- Fixed an issue where domain reloads caused streaming logs from local instances to stop. -- Added a percentage progress to the Play mode Status Window for the preparing, deploying, and launching stages. - -### Fixed - -- Removed the compilation warning "This async method lacks 'await' operators and will run synchronously". -- Enabled log streaming from remote instances. -- Code changes now sync consistently between the Main editor and the virtual player when you use Rider. -- Fixed the "Asset out of sync" error that appeared when the virtual player didn't start in the correct build target. - -## [1.3.0-pre.2] - 2024-08-14 - -### Fixed -- Fixed an issue where the virtual player called `OpenScene()` and `CloseScene()` during Play mode when multiple scenes existed in the project. -- Fixed the error "Type is not a supported string value" that appeared when you add a tag to the Main editor instance. -- Tags now persist in the **Tag** dropdown after you navigate away from the **Scenario configuration** window. -- Fixed the error "Multiplayer Play Mode can't spawn virtual player" in Play mode. - -### Changed -- The Multiplayer Play Mode Window is now disabled when you select a Play Mode Scenario. - -## [1.3.0-pre.1] - 2024-07-26 - -### Changed -- Reduced the time it takes to enter Play mode with remote instances on consecutive runs that create the same build files. -- Added the **Editor** property to the **Play mode scenario** window that you can use to disable the Main editor instance. -- Updated the remote deployment dependency to `com.unity.services.multiplayer@1.0.0-pre.1`. -- Removed UPM from the clones to improve performance and so clones rely on library redirect as originally intended. - -### Fixed -- Added a window that gives you the option to **Save**, **Don’t Save**, or **Cancel** when you initiate a virtual player with an unsaved scene. -- Fixed the "Asset database is out of sync" error that appeared when virtual player opened. - -## [1.3.0-exp.4] - 2024-07-16 - -### Changed -- Updated the remote deployment dependency to `com.unity.services.multiplayer@0.6.0`. - -## [1.3.0-exp.3] - 2024-07-11 - -### Changed -- Moved the Multiplayer Window from **Window** > **Multiplayer Playmode** to **Window** > **Multiplayer** > **Multiplayer Playmode** to ensure consistency with the other Multiplayer packages. -- Scenario status popup title changed from **Connection Status** to **Instances Status**. - -### Added -- Added the Playmode Status Window that gives more information about each instance in the scenario - -### Fixed -- Removed warning log when the multiplay package is not installed. Information message now appears only in the UI in the "configure play mode scenarios" window. -- Fixed remote instances default arguments from `-log` to `-logFile`. - -## [1.3.0-exp.2] - 2024-07-03 - -### Fixed -- Fixed an issue to make the **Stream logs to main editor** property work in local instances. - -## [1.3.0-exp.1] - 2024-06-24 - -### Added -- Added the Playmode Scenarios window that you can use to configure Editor, local and remote instances. - -### Fixed -- No longer hit an exception when launching the standalone profiler. - -## [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 -- Added a new layout option to each Multiplayer Play Mode clone in projects that include the Netcode For Entities package. -- Updated the **Close** button to display a warning dialog prompt that deactivates a Virtual Player. -- Added the mute setting to mute specific users. -- Added a setting that changes the Asset Database refresh timeout. -- Updated the focus shortcut behavior to focus on other individual Virtual Player windows from inside an individual Player. -- Updated the message that appears when a Symlink failure (on FAT32) happens because it isn't supported. - -### Fixed -- The local clone cache clears automatically when you update the Multiplayer Play Mode package. -- Fixed a crash caused by devices set to certain regions. -- Changed the default multiplayer role of Player clones to Client and Server. -- Added a minimum width for the main view of the Multiplayer Play Mode window. -- 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 - -- A Multiplayer development workflow aiming to offer a more efficient development cycle for multiplayer games. The tool enables opening multiple Unity Editor instances simultaneously on the same development device, using the same source assets on disk. - -## [1.0.0-pre.2] - 2023-12-21 - -### Fixed - -- Better handling of custom implicit packages on the clones. - -## [1.0.0-pre.1] - 2023-11-17 - -### Fixed - -- Some compatibility fixes with Dedicated Server. - -## [0.6.0] - 2023-11-08 - -### Fixed - -- Some fixes for Clone heartbeats. -- More fixes for persistent window layouts. - -### Features - -- Can now focus Player with hotkeys (CTRL+F9-F12). -- Just show the layout view toggles as disabled during playmode. -- Automatically focus Players after activating. - -## [0.5.0] - 2023-09-27 - -### Fixed - -- Fix broken links in documentation. - -### Features - -- Moved PlayerTags to the project settings window. -- Players can now have multiple PlayerTags. -- Updated `CurrentPlayer.ReadOnlyTag` to be `CurrentPlayer.ReadOnlyTags`. - -## [0.4.0] - 2023-08-26 - -### Fixed - -- Fixed an issue where a Player could still show up as active after it had exited. -- Fixed an issue where you could have multiple add tag views. -- Fixed an issue where `CurrentPlayer.ReadOnlyTag` would not return the correct value when domain reload on play mode is disabled. -- Fixed an issue where clones were crashing when scrolling mouse over menu top bar - -### Features - -- Debug workflows now has dynamic layouts that persist between runs. -- Players that are unresponsive will now result in a prompt appearing in the main Editor Player asking if they should be restarted. (Only on Windows for now.) -- Now support for content selection in your Players (Requires dedicated server package to be installed). - -## [0.3.0] - 2023-07-26 - -### Fixed - -- Fixed PlayerTags starting and ending with whitespace. -- Fixed handling of relative paths in the package.json of a Player. - -### Features - -- Can now have your Players reboot if they fail to import or stop unexpectedly (e.g. crash). A prompt will appear asking what action to take. -- Debugging workflows is now enabled (giving users more access to the editor in Players). It can be accessed by using the Layout Dropdown in the top left of a Player to enable more views (Scene, Game, etc). -- Can disable Multiplayer Play Mode in settings. -- Updated Tag to be ReadOnlyTag to better communicate how tags as a feature works. - -## [0.2.0] - 2023-06-26 - -### Fixed - -* Fixed null exception when loading into a new scene with unsaved changes. -* Fixed exception triggered on Players when changing scene in play mode. -* Updated text to "Show in Finder" on MacOS for revealing Players location on disk. -* Fixed issues with the Asset Database syncing. - -### Features - -* Display a message to the console log when opening Clones that don't have the required symlinked folders. -* Trigger play mode for clones before main Editor Player starts entering play mode. -* Clone Players will have the same behaviour as the main Editor Player regarding the "Stop playing and compile" option. - -## [0.1.1] - 2023-01-26 - -### Fixed - -- Reduced GC allocations in the messaging system loop. -- Fixed CurrentPlayer.ReadOnlyTags() returning "Untagged" instead of an empty string if a tag is not assigned. -- Fixed bug where pressing Return or Enter would not submit a created tag to the UI. -- Fixed missing XMLDoc for CurrentPlayer API. -- Fixed broken links in the package documentation. - -### Features - -* Added support for additive scenes. - -## [0.1.0] - 2022-11-15 - -This release adds the Multiplayer Play Mode, which is a multiplayer development workflow aiming to offer a more efficient and quick development cycle of multiplayer games. The tool enables opening multiple Unity Editor instances simultaneously on the same development device, using the same source assets on disk. - -### Known issues - -* Player windows can't be reopened if they're closed during Play Mode -* Virtual Players can remain in Play Mode after the main Editor Player has exited in certain circumstances, such as if script changes are made during Play Mode and the “Stop Playing and Recompile” option is active. -* Entering Play Mode with multiple scenes open isn't currently supported -* Virtual Players lose some Game view settings, such as Aspect Ratio, when exiting and entering Play Mode -* Opening a Virtual Player with unresolved script updater issues will cause an API Update prompt to appear -* Scripts won't be reloaded correctly in Virtual Players with “Enter Play Mode” settings set with “Reload Domain” disabled -* In some cases, an error may appear in Virtual Player windows indicating that assets were imported when they weren't supposed to be -* Non-Prefab assets like Scriptable Objects aren't synced to Virtual Players unless you save your scene or invoke the Save Project command -* Authentication with UGS won't work without manually overriding configuration values at runtime diff --git a/mppm_versioned_docs/version-1.3.2/sync-play-mode.md b/mppm_versioned_docs/version-1.3.2/sync-play-mode.md deleted file mode 100644 index 9a0e7e59e..000000000 --- a/mppm_versioned_docs/version-1.3.2/sync-play-mode.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: synchronize -title: Synchronize with Play mode -description: Understand how Multiplayer Play Mode synchronizes with Play mode for multiplayer testing. ---- - -Multiplayer Play Mode syncs the main Editor Player and [Virtual Players](../virtual-players) when you enter [Play Mode](https://docs.unity3d.com/Manual/GameView.html) in the Unity Editor. You control Multiplayer Play Mode the same way you control Play Mode with the Toolbar buttons. - -| Toolbar Button | Function | -| --- | --- | -| **Play** | Runs all activated Players (main Editor Player and Virtual Players) | -| **Pause** | Pauses all activated Players (main Editor Player and Virtual Players) | -| **Step** | Performs a single-frame step for all activated Players (main Editor Player and Virtual Players) | - -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. -::: diff --git a/mppm_versioned_docs/version-1.3.2/sys-req.md b/mppm_versioned_docs/version-1.3.2/sys-req.md deleted file mode 100644 index b6c13cc60..000000000 --- a/mppm_versioned_docs/version-1.3.2/sys-req.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: sys-req -title: System requirements and compatibility ---- - -The Multiplayer Play Mode package requires the following: - -- Unity Editor version 2023.1 or later. -- An active Project in the Unity Hub. - -## Compatibility -Multiplayer Play Mode is compatible with the following multiplayer packages and services: -- [Netcode for GameObjects](https://docs-multiplayer.unity3d.com/netcode/1.6.0/about/) -- [Netcode for Entities](https://docs.unity3d.com/Packages/com.unity.netcode@1.2/manual/index.html) -- [Multiplayer Tools](https://docs-multiplayer.unity3d.com/tools/current/about/) -- [Dedicated Server](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/index.html) -- [Unity Game Services that use Multiplayer](https://docs.unity.com/ugs/en-us/manual/overview/manual/unity-gaming-services-home) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/troubleshoot/debug-mppm.md b/mppm_versioned_docs/version-1.3.2/troubleshoot/debug-mppm.md deleted file mode 100644 index e8d4f90ef..000000000 --- a/mppm_versioned_docs/version-1.3.2/troubleshoot/debug-mppm.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: debug-mppm -title: Debug Multiplayer Play Mode -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/com.unity.test-framework@2.0/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**. - -To learn how to run a test in Unity, refer to [Running Play Mode tests in a player](https://docs.unity3d.com/Packages/com.unity.test-framework@2.0/manual/workflow-run-playmode-test-standalone.html). - -When you run a test with Multiplayer Play Mode installed the test runner indicates which player passed or failed a test. To learn more about test results in the test runner, use the [TestStatus enum](https://docs.unity3d.com/Packages/com.unity.test-framework@2.0/api/UnityEditor.TestTools.TestRunner.Api.TestStatus.html). diff --git a/mppm_versioned_docs/version-1.3.2/troubleshoot/play-mode-scenario-troubleshoot.md b/mppm_versioned_docs/version-1.3.2/troubleshoot/play-mode-scenario-troubleshoot.md deleted file mode 100644 index 0b5a86337..000000000 --- a/mppm_versioned_docs/version-1.3.2/troubleshoot/play-mode-scenario-troubleshoot.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: play-mode-scenario-troubleshoot -title: Troubleshoot a test build -description: Learn about errors that can happen when you build a play mode scenario ---- -To troubleshoot an error that appears when you enter Play Mode, refer to the error message that appears in the console window. You can also open the [Play Mode scenario status dropdown](play-mode-scenario-dropdown-reference.md) for more information. - -To fix the error **Build Profile needs to match the current platform**: -1. Open the Build Profile window ( **File** > **Build Profiles**). -2. In the **Platforms** list, select the platform that matches the platform that the Unity Editor is running on. - -## Additional resources -* [Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md) -* [Play Mode scenario window reference](play-mode-scenario-window-reference.md) -* [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay) -* [Build Profiles](https://docs.unity3d.com/6000.0/Documentation/Manual/build-profiles.html) \ No newline at end of file diff --git a/mppm_versioned_docs/version-1.3.2/troubleshoot/troubleshooting.md b/mppm_versioned_docs/version-1.3.2/troubleshoot/troubleshooting.md deleted file mode 100644 index 7c8932c1c..000000000 --- a/mppm_versioned_docs/version-1.3.2/troubleshoot/troubleshooting.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: troubleshooting -title: Troubleshooting -description: Learn how to use tags to configure player actions in Multiplayer Play Mode. ---- - -This section contains information to help you test, debug, and fix issues with Multiplayer Play Mode. - -To learn more about writing and running tests in Unity, refer to [Write and run tests](docs.unity3d.com/2023.3/Documentation/Manual/testing-editortestsrunner.html). - - - -|**Page** |**Description**| -|-|-| -|[Debug Multiplayer Play Mode](debug-mppm.md)| Learn how to use Unity Test Framework to test a project with Multiplayer Play Mode. | diff --git a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-enable.md b/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-enable.md deleted file mode 100644 index 8bee0d4d9..000000000 --- a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-enable.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: virtual-players-enable -title: Activate a Virtual Player -description: Enable up to three additional Virtual Players to your main Editor Player in Multiplayer Play Mode. ---- - -To use a Virtual Player to test multiplayer gameplay, activate at least one Virtual Player. - -The first time you enable a Virtual Player, Unity creates a new folder within your project folder at `...[ProjectName]/Library/VP`. This folder stores the data for each Virtual Player you activate. When you deactivate a Virtual Player, Unity caches its corresponding folder to use again when you re-activate it. - -:::info -You can only attach tags to inactive Players (including the main Editor Player). To use tags, [create and configure your tags](../player-tags/player-tags-create.md) before you enable virtual Players. -::: - -## Activate a Virtual Player - -:::note -You must activate a **Virtual Player** before you enter **Play mode**. -::: - -To activate a **Virtual Players** for **Play mode**, do the following. - -1. In the Unity Editor, open the Multiplayer Play Mode window by navigating to **Window** > **Multiplayer Play Mode**. -2. Select the checkbox for the Virtual Player (**Player 2**, **Player 3**, or **Player 4**) to open when you enter Play Mode. -3. Wait for the Player status to change from inactive to active for each Virtual Player you selected. -4. When active, the Virtual Player(s) appear in Play Mode in the main Editor Player window. A separate window opens for each enabled Player with the Player name as the window title. - -To understand how **Multiplayer Play Mode** works with **Play mode**, refer to [**Synchronize with Play mode**](../sync-play-mode.md). - -## Deactivate a Virtual Player - -Virtual Players do not automatically deactivate when you close the Virtual Player window. -To deactivate a **Virtual Player**. - -1. In the Unity Editor, open the Multiplayer Play Mode window by navigating to **Window** > **Multiplayer Play Mode**. -2. Deselect the checkbox for the active Virtual Player (**Player 2**, **Player 3**, or **Player 4**). - -:::note -When you deactivate a Virtual Player, Unity doesn't delete its corresponding folder. To remove a Virtual Player folder, navigate to `C://Users/[YourName]/[ProjectName]Library/VP` and delete the folder for this Virtual Player. -::: diff --git a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-focus.md b/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-focus.md deleted file mode 100644 index cb72cb74e..000000000 --- a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-focus.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: virtual-players-focus -title: Focus the view on a Virtual Player -description: Select which Virtual Player to view in the Multiplayer Play Mode window. ---- - -To switch between Virtual Player views in the Multiplayer Play Mode window, use one of the following methods: - -* [Select **Focus on Player** in the Multiplayer Play Mode window](#focus-play-mode). -* [Use the focus player keyboard shortcuts](#focus-shortcuts). - -## Focus on a Virtual Player in the Multiplayer Play Mode window {#focus-play-mode} - -1. Open the Multiplayer Play Mode window. -2. Navigate to the Virtual Players section. -3. Open a player's **More** (**⋮**) menu. -4. In the drop-down, select **Focus on Player**. - -## Use the focus player keyboard shortcuts {#focus-shortcuts} - -Use the following keyboard shortcuts to switch focus to a specific Virtual Player view: - - - -| **Shortcut** | **Description** | -|-------------------------------------------|---------------------------| -| **Ctrl**+**F9** (macOS: **Cmd**+**F9**) | Focus on **Player 1**. | -| **Ctrl**+**F10** (macOS: **Cmd**+**F10**) | Focus on **Player 2**. | -| **Ctrl**+**F11** (macOS: **Cmd**+**F11**) | Focus on **Player 3**. | -| **Ctrl**+**F12** (macOS: **Cmd**+**F12**) | Focus on **Player 4**. | diff --git a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-layout.md b/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-layout.md deleted file mode 100644 index 1a734ad08..000000000 --- a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players-layout.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: virtual-players-layout -title: Change the layout of a Virtual Player -description: Learn how to change the layout of a Virtual Player window. ---- - -The Virtual Player can display and use the following parts of the [Unity Interface](https://docs.unity3d.com/Manual/UsingTheEditor.html): -- [Console](https://docs.unity3d.com/Manual/Console.html) -- [Game](https://docs.unity3d.com/Manual/GameView.html) -- [Hierarchy](https://docs.unity3d.com/Manual/Hierarchy.html) -- [Inspector](https://docs.unity3d.com/Manual/UsingTheInspector.html) -- [Scene](https://docs.unity3d.com/Manual/UsingTheSceneView.html) -- [PlayMode Tools](https://docs.unity3d.com/Packages/com.unity.netcode@1.2/manual/playmode-tool.html). This Window only appears in projects that use Netcode for Entities. - -:::note -You can only use the Hierarchy, Inspector, and Scene windows in Play Mode. -::: - -## Display a window in a Virtual Player - -To display a window in a Virtual Player, perform the following actions: - -1. [Activate](../virtual-players/virtual-players-enable) a Virtual Player. -2. Select the **Layout** dropdown. -3. Select the box next to the window(s) you want to add to this Virtual Player. -4. Select **Apply**. - -## Hide a window in a Virtual Player - -To hide a window in a Virtual Player, perform the following actions: - -1. [Activate](../virtual-players/virtual-players-enable) a Virtual Player. -2. Select the **Layout** dropdown. -3. Deselect the checked box next to the window(s) you want to hide in this Virtual Player. -4. Select **Apply**. diff --git a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players.md b/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players.md deleted file mode 100644 index b84feb6f3..000000000 --- a/mppm_versioned_docs/version-1.3.2/virtual-players/virtual-players.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: virtual-players -title: Virtual Players -description: Add Virtual Players to your main Editor Player in Multiplayer Play Mode. ---- - -Unity's [**Play mode**](https://docs.unity3d.com/Manual/GameView.html) uses the main Editor Player to test your gameplay. By adding the **Multiplayer Play Mode (MPPM)** package, you can enable up to three additional Virtual Players*to the **Play mode** for a total of four Players to test projects with multiple Players. - -This section contains the following information: - - - -| **Page** | **Description** | -|-|-| -| [Activate a Virtual Player](../virtual-players/virtual-players-enable) | Set up Virtual Players. | -| [Focus the Multiplayer Play Mode view on a Virtual Player](../virtual-players/virtual-players-focus) | Switch the Multiplayer Play Mode view between Players. | -| [Change the layout of a Virtual Player](../virtual-players/virtual-players-layout)| Control which parts of the [Unity Interface](https://docs.unity3d.com/Manual/UsingTheEditor.html) appear in a Virtual Player. | \ No newline at end of file diff --git a/mppm_versioned_sidebars/version-1.3.2-sidebars.json b/mppm_versioned_sidebars/version-1.3.2-sidebars.json deleted file mode 100644 index e70877aab..000000000 --- a/mppm_versioned_sidebars/version-1.3.2-sidebars.json +++ /dev/null @@ -1,177 +0,0 @@ -{ - "mppm": [ - { - "type": "doc", - "id": "release-notes/mppm-release-notes" - }, - { - "type": "doc", - "id": "about" - }, - { - "type": "doc", - "id": "sys-req" - }, - { - "type": "doc", - "id": "install" - }, - { - "collapsed": true, - "type": "category", - "label": "Virtual players", - "link": { - "type": "doc", - "id": "virtual-players/virtual-players" - }, - "items": [ - { - "type": "doc", - "id": "virtual-players/virtual-players-enable" - }, - { - "type": "doc", - "id": "virtual-players/virtual-players-focus" - }, - { - "type": "doc", - "id": "virtual-players/virtual-players-layout" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Test live instances locally and remotely", - "link": { - "type": "doc", - "id": "play-mode-scenario/play-mode-scenario-about" - }, - "items": [ - { - "type": "doc", - "id": "play-mode-scenario/play-mode-scenario-req" - }, - { - "type": "doc", - "id": "play-mode-scenario/play-mode-scenario-create" - }, - { - "type": "doc", - "id": "play-mode-scenario/play-mode-scenario-configure-build" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Information about tags", - "link": { - "type": "doc", - "id": "player-tags/player-tags" - }, - "items": [ - { - "type": "doc", - "id": "player-tags/player-tags-create" - }, - { - "collapsed": true, - "type": "category", - "label": "Configure tags", - "link": { - "type": "doc", - "id": "player-tags/player-tags-configure" - }, - "items": [ - { - "type": "doc", - "id": "player-tags/target-instance" - }, - { - "type": "doc", - "id": "player-tags/target-team" - }, - { - "type": "doc", - "id": "player-tags/target-network" - } - ] - }, - { - "type": "doc", - "id": "player-tags/player-tags-attach" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Use Multiplayer Play mode with a Dedicated Server", - "link": { - "type": "doc", - "id": "dedicated-server/play-mode-dedicated-server" - }, - "items": [ - { - "type": "doc", - "id": "dedicated-server/multiplayer-role" - } - ] - }, - { - "type": "doc", - "id": "synchronize" - }, - { - "type": "doc", - "id": "mtt-terms" - }, - { - "collapsed": true, - "type": "category", - "label": "Troubleshooting", - "link": { - "type": "doc", - "id": "troubleshoot/troubleshooting" - }, - "items": [ - { - "type": "doc", - "id": "troubleshoot/debug-mppm" - }, - { - "type": "doc", - "id": "troubleshoot/play-mode-scenario-troubleshoot" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Reference", - "link": { - "type": "doc", - "id": "mppm-reference/mppm-reference-lp" - }, - "items": [ - { - "type": "doc", - "id": "mppm-reference/play-mode-scenario-dropdown-reference" - }, - { - "type": "doc", - "id": "mppm-reference/play-mode-scenario-instances-status-reference" - }, - { - "type": "doc", - "id": "mppm-reference/play-mode-scenario-window-reference" - }, - { - "type": "doc", - "id": "mppm-reference/play-mode-status-window-reference" - } - ] - } - ] -} diff --git a/mppm_versions.json b/mppm_versions.json index 1f25891c1..e68701584 100644 --- a/mppm_versions.json +++ b/mppm_versions.json @@ -1,7 +1,5 @@ [ - "1.4.0-pre", "current", - "1.3.2", "1.2.0", "1.1.0", "1.0.0",