Use the Matchmaker multiplayer widget

Use the Matchmaker multiplayer widget to test the Matchmaker service. This service adds players to a matchmaking session and uses rules to manage them.

To test Matchmaker in a complete project, install the Dedicated game server sample project.

Create a Matchmaker multiplayer widget

To add a Matchmaker multiplayer widget to your scene:

  1. In the menu, go to GameObject > Multiplayer Widgets > Join and leave > Join Session By Matchmaker.
  2. In the Hierarchy window, select the Join session by Matchmaker widget.

You can also use the Multiplayer Center to create and set up the Matchmaker multiplayer widget. For more information, refer to Use the Multiplayer widgets quickstarts.

Set up the Matchmaker multiplayer widget

To use a Matchmaker multiplayer widget, set up the following:

  • Set the production environment.
  • Configure Matchmaker on the Cloud Dashboard.
  • Create and deploy a matchmaker Queue asset.

Set the production environment

The Matchmaker multiplayer widget requires an assigned Environment. To test Matchmaker, you can use the Production environment.

  1. Set environment in Project settings > Service > Environments > Environment selector.
  2. Select Production.
  3. Open the Deployment Window: Services > Deployment.
  4. Select Deploy all.

To learn more, refer to Managing environments.

Configure Matchmaker on the Cloud Dashboard

Matchmaker operates on the Unity Cloud, which means you need to perform the following setup steps to use it in your project:

  1. Go to cloud.unity.com.
  2. Select the Products tab from the sidebar.
  3. Under Gaming Services > Multiplayer, go to Matchmaker.
  4. Select Launch.

Create and deploy a matchmaker Queue asset

Matchmaker uses matchmaker queue script assets to define the rules for that matchmaker session.

You can generate a matchmaker queue script for a two player session in the Matchmaker multiplayer widget Inspector:

  1. Select the Join Session with Matchmaker GameObject.
  2. In the Inspector window, select Create new Matchmaker Queue Asset.

To use this with the Matchmaker widget, deploy it:

  1. Select the matchmaker queue asset to open it in the Inspector window.
  2. In the Deployment section, select View in Deployment Window.
  3. In the Deployment window, select the checkbox for the matchmaker queue asset.
  4. Select Deploy Selected.

To learn how to set up Matchmaker and create a custom queue, refer to Get started with Matchmaker.

Set a queue as default

When you deploy a Matchmaker Queue asset, it appears in the Queues List on the Unity Cloud dashboard. To use this queue with the Matchmaker multiplayer widget, set it as default:

  1. Go to cloud.unity.com.
  2. Select Matchmaker > Queues
  3. Locate a deployed queue asset in the list.
  4. Select the three dots next to the matchmaker queue asset.
  5. Select Make Default.

Assign a queue to the Matchmaker multiplayer widget

To apply the rules contained in a Matchmaker queue asset, assign it to the Matchmaker multiplayer widget:

  1. Select the Matchmaker widget asset.
  2. In the Inspector, find the Queues property.
  3. Select Refresh remote queues.
  4. Select a queue from the dropdown.

Additional resources