Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Android compatability to Multiplayer Play Mode.| #1398

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions mppm/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ 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.
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.

## Compatibility

Multiplayer Play Mode version 1.3.0 is compatible with Unity Editor versions 6000.0.22f1 or later.
Multiplayer Play Mode version 1.3.0 is compatible with the following:

* Unity Editor versions 6000.0.22f1 or later.
* Windows, Linux, MacOS, and Android platforms.

## Multiplayer Play Mode terminology

Expand Down
10 changes: 5 additions & 5 deletions mppm/mppm-reference/play-mode-scenario-dropdown-reference.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
id: play-mode-scenario-dropdown-reference
title: Play Mode scenario dropdown reference
description: Descriptions of the status icons in the Play Mode scenario dropdown.
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.|
|![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)
* [Create a Play Mode Scenario](play-mode-scenario/play-mode-scenario-create.md)
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
id: play-mode-scenario-instances-status-reference
title: 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. |
|![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.|
|![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)
* [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)
20 changes: 10 additions & 10 deletions mppm/mppm-reference/play-mode-scenario-window-reference.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
---
id: play-mode-scenario-window-reference
title: 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.|
|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). |
|Main Editor|||The instance that exists in the main Unity Editor.|
||Multiplayer Role||The [Multiplayer Role](https://docs.unity3d.com/Packages/[email protected]/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/[email protected]/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.|
||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.|
||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.|
|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/[email protected]/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/[email protected]/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.<br/>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.|
||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/>&#8226; Mac Client <br/>&#8226; Android Build Profile <br/>&#8226; Windows|
||Multiplayer Role||The [Multiplayer Role](https://docs.unity3d.com/Packages/[email protected]/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/[email protected]/manual/index.html) exists in your project|
||Advanced Configuration||Optional properties that you can use to debug and control this local instance. |
||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.** |
||Advanced Settings||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/[email protected]/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/[email protected]/manual/index.html) exists in your project|
||Advanced Configuration|||Optional properties that you can use to debug and control this remote instance. |
||Advanced Settings|||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.|
Expand All @@ -41,6 +41,6 @@ You can change the Multiplayer Role in the **File** > **Build Profiles** window.
|||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)
* [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)
2 changes: 1 addition & 1 deletion mppm/mppm-reference/play-mode-status-window-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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.
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.

|**Property**|**Description**|
|-|-|
Expand Down
12 changes: 11 additions & 1 deletion mppm/play-mode-scenario/play-mode-scenario-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ 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.
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.
You can use Play Mode Scenarios to test multiplayer gameplay on different platforms at the same time.

## Compatibility

Play Mode Scenareios supports the following platforms:

* Windows
* Linux
* MacOS
* Android

## Additional resources
* [Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md)
Expand Down
19 changes: 12 additions & 7 deletions mppm/play-mode-scenario/play-mode-scenario-configure-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,31 @@ 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:
When you set up a Play Mode Scenario, you can create the following type of instances:

* Additional Editor
* 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).
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 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).

:::info
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).
:::

## 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.
A local instance can run on the same platform as the Unity Editor, or on an Android device that is connected to that platform. 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:
The Play Mode status window displays the following information for each Play Mode Scenario:
* Status
* Port
* Address
Expand All @@ -37,7 +41,8 @@ To open the Play Mode status window:
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)
* [Play Mode Scenario window reference](mppm-reference/play-mode-scenario-window-reference.md)
* [Play Mode Scenarios requirements and limitations](play-mode-scenario-req.md)
* [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)
Loading