Get started

Use the following instructions to learn how to install and configure the Unity Gaming Services SDK plugin. After you’ve installed and configured the Unity Gaming Services SDK for your project, you can use C++ or Blueprints for Unity Matchmaker.

What's included

The Unity Gaming Services SDK includes three of Unity’s services built into one plugin:

Understand the requirements

The Matchmaker SDK plug-in for Unreal Engine supports the Unreal Engine versions 4.27 to 5.3.

Important: Currently, the Unity Matchmaker only supports matchmaking players into dedicated servers hosted using Unity Multiplay Hosting. Multiplay Hosting may incur costs. For pricing details, see Pricing.

Important: Unity Matchmaker uses a protocol called Centrifuge to handle events on the server. This is contained in the plugin module MatchmakerServer. Centrifuge is not supported on non-PC platforms. Exclude the MatchmakerServer module from Client builds using Multiple Game Modules and TargetAllowList in the .uproject file.

Download the Matchmaker SDK

From the Unreal Engine Marketplace website

  1. Sign in to the Unreal Engine Marketplace.

  2. Access the Unity Gaming Services SDK for Unreal Engine Marketplace page. Unity Gaming Services SDK for Unreal Engine Marketplace page

  3. Select Open in Launcher.

  4. Skip to Step 4 in From the Epic Games Launcher.

From the Epic Games Launcher

  1. Sign in to your Epic Games Launcher.
  2. Search for Unity Gaming Services SDK for Unreal Engine in your Epic Games Launcher. Search for Unity Gaming Services SDK for Unreal Engine
  3. Access the Unity Gaming Services SDK for Unreal Engine page and select Free. Unity Gaming Services SDK for Unreal Engine Launcher page
  4. Select Install to Engine in your Epic Games Launcher. Unity Gaming Services SDK for Unreal Engine install button
  5. Open a new project or an existing one.
  6. Navigate to the Plugins window and check the box next to the Unity Gaming Services SDK for Unreal Engine. Unity Gaming Services SDK for Unreal Engine plugins window
  7. Restart Unreal Engine.

Note: If you use a version of the engine built from sources then you can access your Marketplace folder by doing the following:

  • If you're using Windows, then the default path is: C:\Program Files\Epic Games\UE_5.3\Engine\Plugins\Marketplace. MacOS and Linux also have similar paths.
  • Copy the UnityGamingServicesSDK folder into your project Plugins folder. If it doesn't exist yet, create it at the root of your project.

Configure the Matchmaker SDK

Unity Matchmaker relies on the Unity Authentication service, which is included in the Unity Gaming Services SDK.

Before you start calling the Matchmaker APIs and start allocating players using the Matchmaker, configure your Unity Matchmaker settings on the Unity Cloud Dashboard. Otherwise, all matchmaking requests fail. Unity Matchmaker requires a minimum of one queue with a default pool.

Configure backfill

Backfill enables you to place players into an existing match that’s below the maximum player count. See backfill documentation to learn more.

Before using backfill, ensure you enable backfill on the Unity Cloud Dashboard for your queue.

  1. Visit the Unity Cloud Dashboard and select your project.
  2. Go to the Multiplayer tab.
  3. Go to the Matchmaker tab and select Queues.
  4. Select your Queue. See Create Pools and Queues.
  5. Go to the Pools tab and select the Pool to use within the Queue.
  6. Go to the Rules tab, find the field for Backfill enabled, and make sure it’s set to True.

What's next ?

Proceed with either integrations:

Unity logo Documentation
Copyright © 2024 Unity Technologies
"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.