Skip to content

Commit e8270ce

Browse files
Vic-CooperVic-Cooper
authored
Cut version 1.4.0-pre (#1391)
1 parent c6279bc commit e8270ce

34 files changed

+1213
-1
lines changed

‎docusaurus.config.js

+5-1
Original file line numberDiff line numberDiff line change
@@ -385,9 +385,13 @@ module.exports = {
385385
lastVersion: "current",
386386
versions: {
387387
current: {
388-
label: "1.3.2",
388+
label: "1.4.0-pre",
389389
path: "current",
390390
},
391+
"1.3.2": {
392+
label: "1.3.2",
393+
path: "1.3.2",
394+
},
391395
"1.2.0": {
392396
label: "1.2.0",
393397
path: "1.2.0",

‎mppm_versioned_docs/version-1.3.2/about.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: about
3+
title: About Multiplayer Play Mode
4+
description: Overview of Multiplayer Play Mode
5+
---
6+
7+
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.
8+
9+
## Compatibility
10+
11+
Multiplayer Play Mode version 1.3.0 is compatible with Unity Editor versions 6000.0.22f1 or later.
12+
13+
## Multiplayer Play Mode terminology
14+
15+
The following have specific meaning in relation to Multiplayer Play Mode:
16+
17+
* main Editor Player: The original instance of the project in the Unity Editor. This is the only instance with full authoring capabilities.
18+
* 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).
19+
* Players: All Player instances, including the main Editor Player and all Virtual Players.
20+
21+
## Limitations
22+
23+
Multiplayer Play Mode has some inherent technical limitations, specifically around [scale](#scale) and [authoring](#authoring).
24+
25+
### Scale
26+
27+
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).
28+
29+
### Authoring
30+
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.
31+
:::note
32+
You can't access any main Editor Player functionality from Virtual Players.
33+
:::
34+
35+
## Performance impact
36+
37+
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.

‎mppm_versioned_docs/version-1.3.2/dedicated-server/multiplayer-role.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
id: multiplayer-role
3+
title: Assign Virtual Players to a Multiplayer Role
4+
description: Learn how to use the dedicated server package to assign Virtual Players to a Multiplayer Role.
5+
---
6+
7+
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.
8+
9+
::: Important
10+
To avoid errors, install the Dedicated Server package version that is the same as the Multiplayer Play mode version that exists in your project.
11+
:::
12+
13+
## Set the main Editor Player Multiplayer Role
14+
15+
To set the role of a the main Editor Player, do the following:
16+
17+
1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**).
18+
2. In the **main Editor Player** section, expand the **Multiplayer Role** dropdown.
19+
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.
20+
21+
## Set the Multiplayer Role of a Virtual Player
22+
23+
To set the role of a [Virtual Player](../../virtual-players), do the following:
24+
25+
1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**).
26+
2. In the **Virtual Players** section, expand a Virtual Player's **Multiplayer Role** dropdown.
27+
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.

‎mppm_versioned_docs/version-1.3.2/dedicated-server/play-mode-dedicated-server.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
id: play-mode-dedicated-server
3+
title: Use Multiplayer Play mode with a Dedicated Server
4+
description: Use the dedicated server package with multiplayer play mode.
5+
---
6+
7+
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.
8+
9+
<!--
10+
<div className="table-columns-plain" >
11+
| Page | Description |
12+
</div>
13+
-->
14+
15+
|**Page** |**Description**|
16+
|-|-|
17+
|[Debug Multiplayer Play Mode](debug-mppm.md)| Learn how to use Unity Test Framework to test a project with Multiplayer Play Mode. |

‎mppm_versioned_docs/version-1.3.2/install.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: install
3+
title: Install Multiplayer Play Mode
4+
description: How to install Multiplayer Play Mode
5+
---
6+
7+
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.
8+
To install the Multiplayer Play Mode package, follow these steps:
9+
10+
1. Open Unity Hub.
11+
2. Select a Project to open it.
12+
3. In the Editor's menu bar, navigate to **Window** > **Package Manager**.
13+
4. Select **Unity Registry**.
14+
5. Select the **Multiplayer Play Mode** package.
15+
6. Select **Install**.
16+
17+
## Next steps
18+
19+
You can now access and configure your [Virtual Players](../virtual-players) and their [tags](../player-tags).

‎mppm_versioned_docs/version-1.3.2/mppm-reference/mppm-reference-lp.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: mppm-reference-lp
3+
title: Property refererence
4+
description: Information about Multiplayer Play Mode properties.
5+
---
6+
7+
This section explains the behavior of properties that relate to Multiplayer Play Mode.
8+
9+
|**Page title**|**Description**|
10+
|-|-|
11+
|[Instances status dropdown reference](play-mode-scenario-dropdown-reference.md)| Describes the meaning of each status icon in the Play Mode Scenarios dropdown.|
12+
|[Play Mode Scenarios window reference](play-mode-scenario-window-reference.md)| Describes the behavior of the properties in the Play Mode Scenarios window.|
13+
|[Play Mode status window reference](play-mode-status-window-reference.md)| Describes the behavior of the properties in the Play Mode status window. |
14+
|[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.|
15+
16+
## Additional resources
17+
- [Multiplayer Roles reference](https://docs.unity3d.com/Packages/com.unity.dedicated-server@1.0/manual/multiplayer-roles-reference.html)
18+
- [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md)
19+
- [Troubleshoot a test build](troubleshoot/play-mode-scenario-troubleshoot.md)

‎mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-dropdown-reference.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
id: play-mode-scenario-dropdown-reference
3+
title: Play Mode scenario dropdown reference
4+
description: Descriptions of the status icons in the Play Mode scenario dropdown.
5+
---
6+
This table explains the meaning of each status icon in the Play Mode Scenarios dropdown that appears next to the Play Mode buttons.
7+
8+
|**Property**|**Description**|
9+
|-|-|
10+
|![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. |
11+
|![Scenario icon](/img/d_PlaymodeScenario-32.png) Scenario| A Play Mode scenario that contains Play Mode settings.|
12+
13+
## Additional resources
14+
* [Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md)
15+
* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md)

‎mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-instances-status-reference.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: play-mode-scenario-instances-status-reference
3+
title: Play Mode scenario instances status reference
4+
description: Descriptions of the status icons in the instances status dropdown.
5+
---
6+
This table explains the meaning of each status symbol in the instances status dropdown that appears next to the Play Mode Scenarios dropdown.
7+
8+
|**Property**|**Description**|
9+
|-|-|
10+
|![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. |
11+
|![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. |
12+
|![Loading icon](/img/d_Loading-32.png) Loading|Unity is currently performing a building or loading step.|
13+
|![Connected and Running icon](/img/CompletedTask-32.png) Connected and Running|This Play Mode scenario is active with no errors.|
14+
|![Idling icon](/img/d_IdleState-2x.png) Idling|This Play Mode scenario is not yet active. To activate it, enter Play Mode.|
15+
|![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.|
16+
|![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.|
17+
18+
## Additional resources
19+
* [Play Mode Scenarios requirements and limitations](play-mode-scenario/play-mode-scenario-req.md)
20+
* [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay)
21+
* [Play Mode scenario window reference](/mppm-reference/play-mode-scenario-window-reference.md)
22+
* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md)

‎mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-scenario-window-reference.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: play-mode-scenario-window-reference
3+
title: Play Mode scenario window reference
4+
description: Descriptions of the properties in the Play Mode Scenario window.
5+
---
6+
7+
This table explains the behavior of each property in the Play Mode Scenarios window.
8+
9+
|**Property**|||**Description**|
10+
|-|-|-|-|
11+
|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). |
12+
|Editor|||The instance that exists in the main Unity Editor.|
13+
||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.
14+
|||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.
15+
You can change the Multiplayer Role in the **File** > **Build Profiles** window.|
16+
||Initial Scene||The scene that all instances display when you initialize them.|
17+
|Additional Editor Instances|||A [virtual player](https://docs-multiplayer.unity3d.com/mppm/current/virtual-players/) that exists in the Unity Editor.|
18+
||Name||The name for this additional Editor instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md). |
19+
||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|
20+
||Tag||One or more reference words that you can use in a script to assign the main Editor Player to a certain behavior.<br/>To control whether a player exists on the client or server, use the **Multiplayer Role** property.|
21+
|Local Instances|||Instances of this project that run on your local machine.|
22+
||Name||The name of this instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md).|
23+
||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.|
24+
||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|
25+
||Advanced Configuration||Optional properties that you can use to debug and control this local instance. |
26+
|||Stream Logs To Main Editor|Select the checkbox to display logs from this instance in the Unity Editor Console.|
27+
|||Logs Color|The color this instance uses to display logs in the Unity Editor.|
28+
|||Arguments|The [UGS launch parameters](https://docs.unity.com/ugs/manual/game-server-hosting/manual/concepts/launch-parameters) that modify this instance.|
29+
|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).|
30+
||Name||The name of this instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md).|
31+
||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.|
32+
||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|
33+
||Advanced Configuration|||Optional properties that you can use to debug and control this remote instance. |
34+
|||Fleet Name|The name of the server fleet to display in the Multiplayer Hosting environment. |
35+
|||Fleet Region|The server region this instance runs from.|
36+
|||Instance Amount of Cores|The amount of CPU cores this remote instance requests from the server.|
37+
|||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).|
38+
|||Instance CPU Clockspeed|The amount of CPU time, in megahertz, that this instance requests from the server.|
39+
|||Stream Logs To Main Editor|Select the checkbox to display logs from this instance in the Unity Editor Console.|
40+
|||Logs Color|The color of text that displays in the Unity Editor for logs that relate to this instance.|
41+
|||Arguments|The [UGS launch parameters](https://docs.unity.com/ugs/manual/game-server-hosting/manual/concepts/launch-parameters) that modify this instance.|
42+
43+
## Additional resources
44+
* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md)
45+
* [Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md)
46+
* [Play Mode Scenarios requirements and limitations](play-mode-scenario/play-mode-scenario-req.md)

‎mppm_versioned_docs/version-1.3.2/mppm-reference/play-mode-status-window-reference.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
id: play-mode-status-window-reference
3+
title: Play Mode status window reference
4+
description: Descriptions of the properties in the Play Mode status window.
5+
---
6+
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.
7+
8+
|**Property**|**Description**|
9+
|-|-|
10+
|Tags|Displays the tags that you assign to this instance in the **Play Mode Configuration** window. |
11+
|Disconnect|Disconnect this Play Mode instance from the local or remote server.|
12+
13+
## Additional resources
14+
* [Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md)
15+
* [Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md)

‎mppm_versioned_docs/version-1.3.2/mutliplayer-terms.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
id: mtt-terms
3+
title: Multiplayer Networking Terminology
4+
---
5+
6+
The following are essential, high-level terms used in multiplayer networking and Netcode for GameObjects:
7+
8+
import MTTterms from '/static/shared/_terminology.md';
9+
10+
<MTTterms/>

‎mppm_versioned_docs/version-1.3.2/play-mode-scenario/play-mode-scenario-about.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
id: play-mode-scenario-about
3+
title: Test live instances locally and remotely
4+
description: Learn how to use the Play Mode Scenarios window to test a multiplayer project
5+
---
6+
7+
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.
8+
9+
## Additional resources
10+
* [Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md)
11+
* [Play Mode scenario window reference](mppm-reference/play-mode-scenario-window-reference.md)
12+
* [Unity Gaming Services (UGS) Multiplay Hosting](https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/welcome-to-multiplay)
13+
* [Dedicated Server](https://docs.unity3d.com/Manual/dedicated-server.html)

0 commit comments

Comments
 (0)