Deploy a Matchmaker queue
Learn how to use the Deployment window in the Unity Editor to deploy a Matchmaker queue.
A queue represents a predefined logical separation of matchmaking tickets within an environment. A queue has one or more pools. You can deploy a Matchmaker queue configuration directly from the Unity editor.
Prerequisites
Before you start, ensure you have done the following:
- Set up a Unity Cloud Dashboard account with at least one project.
- Linked your cloud project to the active Unity project.
Install the required packages
To enable the integration between the Multiplayer Services SDK and Deployment, install the following packages:
- In the Unity Editor, navigate to Window > Package Manager.
- Select Unity Registry.
- Search for Deployment.
- Select Install.
- Still in the Unity Registry, search for Multiplayer Services.
- Select Install.
Set up the Deployment window
You can deploy Matchmaker queue 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.
Before you can use the Deployment window, select the environment to which you want to deploy.
- In the Unity Editor, select Services > Deployment.
- Select Deployment Settings.
- In the Environments window that opens, select an Editor Environment.
Create a Matchmaker queue configuration
To create an editable Queue configuration:
- In the Unity Editor's Project window, right-click (macOS: Ctrl+click) in the
Assets
folder. - Select Create > Services > Matchmaker Queue Config.
Edit a Matchmaker queue configuration
You can edit the Mathcmaker queue configuration directly from the Unity Editor or from an IDE of your choice.
- In the Project window, select the
MatchmakerQueue
scriptable object you created above. - In the Inspector window, edit the properties of the queue configuration for the Matchmaker Queue (Matchmaker Asset). Alternatively, you can open the asset file in your favourite IDE and edit the contents manually.
It is the recommended best practice to configure file type associations (Unity Services Web API Docs) in your IDE to work with Matchmaker files. This makes authoring the files significantly easier by providing auto-complete functionality in your preferred IDE. Refer to the Matchmaker queue schema.
Refer to Filters for more information about the queue configuration.
Deploy the Matchmaker queue configuration
To deploy the Matchmaker queue configuration:
- In the Deployment window, double-click on the queue configuration.
- Right-click (macOS: Ctrl+click) a queue configuration, then select Deploy.
- Enable the checkbox next to the queue that you are ready to deploy.
- Select Deploy Selected.
Troubleshooting
Matchmaker configuration assets don't appear in the Deployment window
If your configuration assets don't appear in the Deployment window, make sure domain reloading is activated.
- In the Unity Editor, go to Edit > Project Settings.
- Select Editor.
- Verify that the Enter Play Mode Settings > When entering Play Mode setting is Reload Domain and Scene or Reload Domain only.