Skip to content

Commit

Permalink
Develop into main (#1298)
Browse files Browse the repository at this point in the history
Co-authored-by: Vic Cooper <[email protected]>
Co-authored-by: Dominick <[email protected]>
Co-authored-by: Rémi MACH <[email protected]>
Co-authored-by: LagowiecDev <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Griffin of Innatical <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Steve Diniro <[email protected]>
Co-authored-by: s-omeilia-unity <[email protected]>
Co-authored-by: Alex Martin <[email protected]>
Co-authored-by: Monaxys <[email protected]>
Co-authored-by: Flap27 <[email protected]>
Co-authored-by: NRTnarathip <[email protected]>
Co-authored-by: Elfi0Kuhndorf <[email protected]>
Co-authored-by: CodeSmile <[email protected]>
Co-authored-by: Frank Luong <[email protected]>
Co-authored-by: Sue Arkin <[email protected]>
  • Loading branch information
19 people authored Jul 8, 2024
1 parent 23b7ab8 commit 3c3afe1
Show file tree
Hide file tree
Showing 91 changed files with 516 additions and 509 deletions.
19 changes: 11 additions & 8 deletions docs/learn/distributed-authority-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Before you begin, you need the following:
```cs
using System;
using System.Threading.Tasks;
using Unity.Netcode;
using Unity.Services.Authentication;
using Unity.Services.Core;
using Unity.Services.Multiplayer;
Expand Down Expand Up @@ -136,8 +137,9 @@ public class ConnectionManager : MonoBehaviour
AuthenticationService.Instance.SwitchProfile(_profileName);
await AuthenticationService.Instance.SignInAnonymouslyAsync();

var options = new CreateSessionOptions(_maxPlayers) {
Name = _sessionName
var options = new SessionOptions() {
Name = _sessionName,
MaxPlayers = _maxPlayers
}.WithDistributedConnection();

_session = await MultiplayerService.Instance.CreateOrJoinSessionAsync(_sessionName, options);
Expand Down Expand Up @@ -278,15 +280,16 @@ public class PlayerCubeController : NetworkTransform
![create PlayerCube object](/img/learn/distributed-authority-quick-start/player-cube.png)
3. Add a `NetworkObject` component to the *PlayerCube*.
![add a NetworkObject component](/img/learn/distributed-authority-quick-start/add-networkobject.png)
4. Add the *PlayerCubeController* to the *PlayerCube*.
4. Set the `NetworkObject` Ownership to "None".
5. Add the *PlayerCubeController* to the *PlayerCube*.
![add the PlayerCubeController component](/img/learn/distributed-authority-quick-start/add-playercubecontroller.png)
5. Create a Prefabs folder in the root Assets folder.
6. Drag and drop the *PlayerCube* object into the newly created Prefabs folder.
6. Create a Prefabs folder in the root Assets folder.
7. Drag and drop the *PlayerCube* object into the newly created Prefabs folder.
![create the player cube prefab](/img/learn/distributed-authority-quick-start/create-playercube-prefab.png)
6. Delete the *PlayerCube* object from your scene.
5. Open the Network Manager, navigate to **Prefab Settings**, and set the **Default Player Prefab** to be the newly created *PlayerCube*.
8. Delete the *PlayerCube* object from your scene.
9. Open the Network Manager, navigate to **Prefab Settings**, and set the **Default Player Prefab** to be the newly created *PlayerCube*.
![set the default player prefab](/img/learn/distributed-authority-quick-start/assign-default-player-prefab.png)
6. Save all changes to the scene.
10. Save all changes to the scene.

## Next steps

Expand Down
20 changes: 12 additions & 8 deletions mppm/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ 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 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) simultaneously on the same development device while using the same source assets on disk. Multiplayer Play Mode can help you create multiplayer development workflows that reduce project build times, run it locally, and test the server-client relationship.

## Compatibility

Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 6000.0.3f1 or later.

## Compatibility

Expand All @@ -14,24 +18,24 @@ Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 600

The following have specific meaning in relation to Multiplayer Play Mode:

* Main Editor: 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.
* 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 and three Virtual Players).
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 to make changes and a Virtual Player to test multiplayer functionality. Any changes you make in Play Mode in the Main Editor reset when you exit Play Mode.
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 functionality from Virtual Players.
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 and each Virtual Player.
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.
22 changes: 11 additions & 11 deletions mppm/dedicated-server/multiplayer-role.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
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.
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/[email protected]/manual/index.html) with Multiplayer Play Mode to switch players between the server and client role without a script.
Install the [Dedicated Server package](https://docs.unity3d.com/Packages/[email protected]/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
## Set the main Editor Player multiplayer role

To set the role of a the main editor player, do the following:
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/[email protected]/manual/multiplayer-roles.html) you want the main editor to use.
2. In the **main Editor Player** section, expand the **Multiplayer Role** dropdown.
3. Select the [multiplayer role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want the main Editor Player to use.

## Set the multiplayer role of a virtual player
## Set the multiplayer role of a Virtual Player

To set the role of a [virtual player](../../virtual-players), do the following:
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/[email protected]/manual/multiplayer-roles.html) you want this player to use.
2. In the **Virtual Players** section, expand a Virtual Player's **Multiplayer Role** dropdown.
3. Select the [multiplayer role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want this Player to use.
2 changes: 1 addition & 1 deletion mppm/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ To install the Multiplayer Play Mode package, follow these steps:

## Next steps

You can now access and configure your [Virtual Players](../virtual-players) and their [Player Tags](../player-tags).
You can now access and configure your [Virtual Players](../virtual-players) and their [tags](../player-tags).
10 changes: 5 additions & 5 deletions mppm/player-tags/player-tags-attach.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
id: player-tags-attach
title: Attach Player Tags to a player
description: Learn how to attach Player Tags to a player in Multiplayer Play Mode.
title: Attach tags to a Player
description: Learn how to attach tags to a Player in Multiplayer Play Mode.
---

To assign one or more [Player Tags](../../player-tags) to any player, do the following:
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.
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 Player Tag field that appears, type a name for your tag.
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.
10 changes: 5 additions & 5 deletions mppm/player-tags/player-tags-configure.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
id: player-tags-configure
title: Configure Player Tags
description: Set up Player Tags to use them to configure the player actions.
title: Configure tags
description: Set up tags to use them to configure the player actions.
---

Player Tags don't do anything until you configure them. To configure a player tag, do the following:
Tags don't do anything until you configure them. To configure a tag, do the following:

1. Use `CurrentPlayer.ReadOnlyTags()` to target the Player Tag in a script.
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 **Player Tag** examples as guides for your own scripts:
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)
Expand Down
10 changes: 5 additions & 5 deletions mppm/player-tags/player-tags-create.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: player-tags-create
title: Create a Player Tags
description: Use these steps to create Player Tags to configure the player actions in Multiplayer Play Mode.
title: Create a tag
description: Use these steps to create tags to configure the player actions in Multiplayer Play Mode.
---

To create a **Player Tag**, perform the following actions:
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.
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 **Player 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**.
14 changes: 7 additions & 7 deletions mppm/player-tags/player-tags.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
id: player-tags
title: Player Tags
description: Learn how to use Player Tags to configure player actions in Multiplayer Play Mode.
title: Information about tags
description: Learn how to use tags to configure Player actions in Multiplayer Play Mode.
---

Player 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:
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.
You can assign multiple tags to a Player.

<!--
<div className="table-columns-plain" >
Expand All @@ -20,6 +20,6 @@ You can assign multiple tags to a player.

|**Page** |**Description**|
|-|-|
|[Create Player Tag](../player-tags/player-tags-create)| Learn how to create player tags in code.|
|[Configure Player tag](../player-tags/player-tags-configure)| Learn how to set up player tags to work in your project|
|[Attach a Player Tag to a player](../player-tags/player-tags-attach)| Learn how to assign tags to a specific player.|
|[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.|
10 changes: 5 additions & 5 deletions mppm/player-tags/target-instance.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
id: target-instance
title: Use Player Tags to run a player as a server, client, or host
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 **Player 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**).
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 player 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).
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 player tag to server, client, or host in a script
## 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 Player Tag. A Player with the `Server` Player Tag automatically runs as a server, and a Player with the `Client` Player Tag automatically runs as a client.
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.
Expand Down
4 changes: 2 additions & 2 deletions mppm/player-tags/target-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ 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 **Player Tag** has a string rather than if it’s equal to a string to allow for more flexibility with the name of the **Player Tag**. You can change this logic so that it checks for an exact match.
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 Player Tag. A Player with the `FastNetwork` Player 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` Player Tag simulates a [Mobile 2.5G](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#mobile-25g) connection.
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.
Expand Down
Loading

0 comments on commit 3c3afe1

Please sign in to comment.