Get started
The following instructions teach you how to install and configure the Multiplay Game Server SDK plug-in. After you’ve installed and configured the Multiplay Game Server SDK for your project, you can use the C++ or Blueprints integration.
Understand the requirements
The Multiplay Game Server SDK plug-in for Unreal Engine supports the Unreal Engine versions 4.27 to 5.3.
Build the Engine from Source
Unreal Engine requires you to use a source build to set up a dedicated server. Refer to Setting Up Dedicated Servers (Unreal Engine).
Perform the following steps to build the Unreal Engine from source:
- Create an Epic Games account.
- Create a GitHub account.
- Link your Epic Games account to GitHub account.
- Clone the Unreal Engine source code using Git.
- Check out a branch corresponding to one of the engine versions specified above (for example, 4.27).
- Follow the Getting up and running instructions in the
README.md
file for the version of the engine that you have checked out.
At this point, you should have an Unreal Engine binary.
Download the Multiplay Hosting SDK
From the Unreal Engine Marketplace website
- Sign in to the Unreal Engine Marketplace.
- Access the Unity Gaming Services SDK for Unreal Engine Marketplace page.
- Select Open in Launcher.
- Skip to Step 4 in From the Epic Games Launcher
From the Epic Games Launcher
- Sign in to your Epic Games Launcher.
- Search for
Unity Gaming Services SDK for Unreal Engine
in your Epic Games Launcher. - Access the Unity Gaming Services SDK for Unreal Engine page and select Free.
- Select Install to Engine in your Epic Games Launcher.
- Open a new project or an existing one.
- Navigate to the
Plugins
window and check the box next to the Unity Gaming Services SDK for Unreal Engine. - Restart Unreal Engine
- Access your Marketplace folder by doing the following:
- If you're using Windows, then 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 projectPlugins
folder. If it doesn't exist yet, create it at the root of your project.
Building the project including the SDK
- Right-click (macOS: Ctrl+click) the
.uproject
file, then select Generate Visual Studio project files. - Wait for the generation to finish.
- Open the
.sln
file using Visual Studio. - Add the module as dependency in the
.build.cs
file (MultiplayGameServerSDK
). - Add a new
.target.cs
file with the server target configuration.
Refer to Building Plugins (Unreal Engine)
Configure the Multiplay Game Server SDK
Multiplay generates the server.json
file from information about the game server instance, such as the IP address, port number, and server ID. It also includes any configuration variables from the active build configuration.
The Multiplay Game Server SDK uses the server.json
file to access the server query port variable ($$query_port$$
) and the server ID variable ($$serverid$$
).
To configure the server.json
file in the Unity Cloud Dashboard, access Multiplay Hosting, then select Build Configurations.
You must include at least the queryPort
and the serverID
in the server.json
file for your project. Refer to the following example server.json
file.
{
"queryPort": "$$query_port$$",
"serverID": "$$serverid$$"
}
Note: Refer to the server.json
documentation.
What's next ?
Proceed with either integrations: