You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: mppm/about.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,14 @@ title: About Multiplayer Play Mode
4
4
description: Overview of Multiplayer Play Mode
5
5
---
6
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.
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) at the same time, 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
8
9
9
## Compatibility
10
10
11
-
Multiplayer Play Mode version 1.4.0 is compatible with Unity Editor versions 6000.1.0b6 or later.
11
+
Multiplayer Play Mode version 1.4.0-pre is compatible with the following:
description: Descriptions of the status icons in the Play Mode scenario dropdown.
3
+
title: Play Mode Scenario dropdown reference
4
+
description: Descriptions of the status icons in the Play Mode Scenario dropdown.
5
5
---
6
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
7
8
8
|**Property**|**Description**|
9
9
|-|-|
10
-
| 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| A Play Mode scenario that contains Play Mode settings.|
10
+
| 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| A Play Mode Scenario that contains Play Mode settings.|
12
12
13
13
## Additional resources
14
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)
15
+
*[Create a Play Mode Scenario](play-mode-scenario/play-mode-scenario-create.md)
title: Play Mode scenario instances status reference
3
+
title: Play Mode Scenario instances status reference
4
4
description: Descriptions of the status icons in the instances status dropdown.
5
5
---
6
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
7
8
8
|**Property**|**Description**|
9
9
|-|-|
10
-
| 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|This Play Mode scenario does not function correctly. For more information, refer to the error that appears in the console window. |
10
+
| 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|This Play Mode Scenario does not function correctly. For more information, refer to the error that appears in the console window. |
12
12
| Loading|Unity is currently performing a building or loading step.|
13
-
| Connected and Running|This Play Mode scenario is active with no errors.|
14
-
| Idling|This Play Mode scenario is not yet active. To activate it, enter Play Mode.|
13
+
| Connected and Running|This Play Mode Scenario is active with no errors.|
14
+
| Idling|This Play Mode Scenario is not yet active. To activate it, enter Play Mode.|
15
15
| Go to dashboard|Select this icon to open the Services dashboard in your web browser.|
16
16
| Open status window|Select this icon to open the Play Mode Status window to see more information for each instance.|
17
17
18
18
## Additional resources
19
19
*[Play Mode Scenarios requirements and limitations](play-mode-scenario/play-mode-scenario-req.md)
description: Descriptions of the properties in the Play Mode Scenario window.
5
5
---
6
6
7
7
This table explains the behavior of each property in the Play Mode Scenarios window.
8
8
9
9
|**Property**|||**Description**|
10
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.|
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
+
|Main Editor|||The instance that exists in the main Unity Editor.|
13
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.|
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. <br/>You can change the Multiplayer Role in the **File** > **Build Profiles** window.|
16
15
||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.|
16
+
|Editor Instances|||A [virtual player](https://docs-multiplayer.unity3d.com/mppm/current/virtual-players/) that exists in the Unity Editor.|
18
17
||Name||The name for this additional Editor instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md). |
19
18
||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
19
||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
20
|Local Instances|||Instances of this project that run on your local machine.|
22
21
||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.|
22
+
||Build Profile||The [Build Profile](https://docs.unity3d.com/6000.0/Documentation/Manual/build-profiles.html) that this instance uses. Select the Build Profile that matches the device you want to build this instance on:<br/>• Mac Client <br/>• Android Build Profile <br/>• Windows|
24
23
||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. |
24
+
||Run Device||The device this instance builds to and runs on. For information on how to connect an android device to Unity, refer to [Debug on Android devices](https://docs.unity3d.com/Manual/android-debugging-on-an-android-device.html).<br/><br/>This property only appears when you select the **Android Build Profile.**|
25
+
||Advanced Settings||Optional properties that you can use to debug and control this local instance. |
26
26
|||Stream Logs To Main Editor|Select the checkbox to display logs from this instance in the Unity Editor Console.|
27
27
|||Logs Color|The color this instance uses to display logs in the Unity Editor.|
28
28
|||Arguments|The [UGS launch parameters](https://docs.unity.com/ugs/manual/game-server-hosting/manual/concepts/launch-parameters) that modify this instance.|
29
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
30
||Name||The name of this instance that appears in the [Play Mode status window](play-mode-scenario-window-reference.md).|
31
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
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. |
33
+
||Advanced Settings|||Optional properties that you can use to debug and control this remote instance. |
34
34
|||Fleet Name|The name of the server fleet to display in the Multiplayer Hosting environment. |
35
35
|||Fleet Region|The server region this instance runs from.|
36
36
|||Instance Amount of Cores|The amount of CPU cores this remote instance requests from the server.|
@@ -41,6 +41,6 @@ You can change the Multiplayer Role in the **File** > **Build Profiles** window.
41
41
|||Arguments|The [UGS launch parameters](https://docs.unity.com/ugs/manual/game-server-hosting/manual/concepts/launch-parameters) that modify this instance.|
42
42
43
43
## Additional resources
44
-
*[Create a Play Mode scenario](play-mode-scenario/play-mode-scenario-create.md)
44
+
*[Create a Play Mode Scenario](play-mode-scenario/play-mode-scenario-create.md)
45
45
*[Test live instances locally and remotely](play-mode-scenario/play-mode-scenario-about.md)
46
46
*[Play Mode Scenarios requirements and limitations](play-mode-scenario/play-mode-scenario-req.md)
description: Descriptions of the properties in the Play Mode status window.
5
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.
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 Play Mode Scenarios that exist for your project.
Copy file name to clipboardExpand all lines: mppm/play-mode-scenario/play-mode-scenario-about.md
+11-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,17 @@ title: Test live instances locally and remotely
4
4
description: Learn how to use the Play Mode Scenarios window to test a multiplayer project
5
5
---
6
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.
7
+
To test one or more instances of a multiplayer project on a local device 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
+
You can use Play Mode Scenarios to test multiplayer gameplay on different platforms at the same time.
9
+
10
+
## Compatibility
11
+
12
+
Play Mode Scenareios supports the following platforms:
13
+
14
+
* Windows
15
+
* Linux
16
+
* MacOS
17
+
* Android
8
18
9
19
## Additional resources
10
20
*[Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md)
Copy file name to clipboardExpand all lines: mppm/play-mode-scenario/play-mode-scenario-configure-build.md
+13-14
Original file line number
Diff line number
Diff line change
@@ -4,33 +4,31 @@ title: Configure and build local and remote instances
4
4
description: Learn how to set up and run instances in the Play Mode Scenario window.
5
5
---
6
6
7
-
When you set up a Play Mode scenario, you can create the following type of instances:
7
+
When you set up a Play Mode Scenario, you can create the following type of instances:
8
8
9
-
*Additional Editor
9
+
* Editor
10
10
* Local
11
11
* Remote
12
12
13
13
## Configure and build a remote instance
14
14
15
-
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).
16
-
17
-
:::tip Multiplay Hosting cost
18
-
19
-
You can start using Multiplay Hosting for free, but server use can cost money 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).
20
-
21
-
:::
15
+
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).
22
16
23
17
You can only have one remote instance in a Play Mode Scenario and it can only run on a Linux platform.
24
18
25
19
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).
26
20
21
+
:::tip Multiplay Hosting cost
22
+
You can start using Multiplay Hosting for free, but it can cost money to use a server 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 pricing, refer to [UGS pricing](https://unity.com/products/gaming-services/pricing).
23
+
:::
24
+
27
25
## Configure and build a local instance
28
-
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.
26
+
A local instance can run on the same platform as the Unity Editor, or on an Android device that is connected to that platform wirelessly or by a USB cable. 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.
29
27
30
28
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).
31
29
32
30
## Check the status of all instances
33
-
The Play Mode status window displays the following information for each Play Mode scenario:
31
+
The Play Mode status window displays the following information for each Play Mode Scenario:
34
32
* Status
35
33
* Port
36
34
* Address
@@ -43,7 +41,8 @@ To open the Play Mode status window:
43
41
3. Select the status window icon.
44
42
45
43
## Additional resources
46
-
*[Play Mode Scenarios requirements and limitations](play-mode-scenario-req)
47
-
*[Create a Play Mode scenario](play-mode-scenario-create.md)
0 commit comments