Documentation

Support

Multiplayer

Multiplayer

Deploy a Matchmaker environment

Use the Deployment window in the Unity Editor to deploy a Matchmaker environment.
Read time 2 minutesLast updated 12 hours ago
An environment is a global container that represents an instance of a matchmaker (including development, staging, and production instances). You can deploy a Matchmaker environment configuration directly from the Unity editor.

Prerequisites

Before you start, make sure you meet the following prerequisites:
  1. You have a Unity Dashboard account with at least one project.
  2. You have linked your cloud project to an active Unity project.

Install the required packages

To enable the integration between the Multiplayer Services SDK and Deployment, install the following packages:
  1. In the Unity Editor, navigate to Window > Package Manager.
  2. Select Unity Registry.
  3. Search for Deployment.
  4. Select Install.
  5. Still in the Unity Registry, search for Multiplayer Services.
  6. Select Install.

Set up the Deployment window

You can deploy Matchmaker environment configurations to your cloud environment using the Deployment window. Once you install the Deployment package, you can access the Deployment window from the Unity Editor by selecting Services > Deployment. To select the deployment environment, follow these steps before you can use the Deployment window:
  1. In the Unity Editor, select Services > Deployment.
  2. Select Deployment Settings.
  3. In the Environments window that opens, select an Editor Environment.

Create a Matchmaker environment configuration

To create an editable Queue configuration:
  1. In the Unity Editor's Project window, right-click (macOS: Ctrl+click) in the 
    Assets
    folder.
  2. Select Create > Services > Matchmaker Environment Config.

Edit a Matchmaker environment configuration

To edit the Matchmaker environment configuration either directly from the Unity Editor or from an IDE of your choice, do the following:
  1. In the Project window, select the 
    MatchmakerEnvironment
    scriptable object you created above.
  2. In the Inspector window, edit the properties of the queue configuration for the Matchmaker Environment (Matchmaker Asset).
Alternatively, you can open the asset file directly in your favourite IDE, and edit the contents manually. Refer to Filters for more information about the environment configuration.

Deploy the Matchmaker environment configuration

To deploy the Matchmaker environment configuration:
  1. In the Deployment window, double-click on the environment configuration.
  2. Right-click (macOS: Ctrl+click) an environment configuration, then select Deploy.
  3. Enable the checkbox next to the environment that you are ready to deploy.
  4. Select Deploy Selected.

Additional resources