Get started
Learn how to set up Multiplay Hosting and deploy your first game server.
Read time 3 minutesLast updated 3 days ago
This guide walks you through setting up Multiplay Hosting as your project's game server orchestration platform. You’ll learn how to:
- Integrate your game server
- Create a build
- Create a build configuration
- Create a fleet
- Create a test allocation
Tip
Check out our YouTube video How to set up Game Server Hosting.
Prerequisites
Before you start, make sure you meet the following prerequisites:- You have a Unity Dashboard account with at least one project.
- You have a game server executable that meets Multiplay Hosting’s integration requirements.
Set up Multiplay Hosting
You can set up and manage Multiplay Hosting through the Unity Dashboard:- In the Unity Dashboard, select the Products tab from the sidebar.
- Under Gaming Services > Multiplayer, go to Multiplay Hosting and select Launch.
- Select Setup guide.
Note
When you launch Multiplay Hosting for the first time, this adds Multiplay Hosting to the Shortcuts section on the sidebar and opens the Overview page.
Integrate your game server
The first step in the process of setting up Multiplay Hosting is to integrate your game server executable. Multiplay Hosting also refers to this executable as the build executable.Select your game engine
- In the Setup guide, select Integrate game server.
- Select the game engine your game server executable supports. Multiplay Hosting is engine-agnostic, meaning you can use Unity, Unreal, or a custom engine.
- Select the engine, then select Next to continue.
Link a Unity project
Before you continue, you must link your project with the Unity Dashboard using the Unity Editor.Note
You can skip this step if you’ve already linked your project in the Unity Editor, or you are using Unreal or a custom engine.
- Sign in to the Editor before linking the project to the Unity Dashboard.
- Select File > Project Settings > Services.
- If you already have a Unity project, select Use an existing Unity project ID. To create a project from the Unity Editor, select your Organization, then Create project ID.
- Select Link project ID.
- After you’ve linked your project in the Unity Editor, select Next in the Unity Dashboard.
Tip
Refer to the Game Server SDK for Unity documentation to learn how to integrate your game with the Game Server SDK.
Install the Multiplay Hosting package
After you’ve linked your project to the Unity Dashboard, you can install the latest version of the Multiplay Hosting package. Use the Unity Package Manager to import the Multiplay Hosting package in the Unity Editor:- In the Unity Editor's Package Manager, select Unity Registry.
- Search for the following package:
- For Unity 2022 LTS and later:
com.unity.services.multiplayer - For earlier versions of Unity:
com.unity.services.multiplayNoteFor most users, the unified Multiplayer Services package replaces the Multiplay standalone package, which is deprecated in Unity 6. Consider migrating to the unified package to facilitate a smooth transition. Visit the migration guide for a step-by-step transition process.
- For Unity 2022 LTS and later:
- After importing the Multiplay Hosting package in the Unity Editor, select Finish in the Unity Dashboard.
Create a build
The following sections guide you through creating your first build, and supplement the embedded guide on the Unity Dashboard. You can create a build in the following ways:- With a direct upload
- With a container image
- With an Amazon S3 bucket
- With a Google Cloud Storage bucket
Create a build configuration
Create a build configuration for the build you created in the earlier step, and set the server density. Refer also to Build configurations.Create a fleet
After you've created a build configuration, create your first fleet and define the following settings:Create a test allocation
Finally, create a test allocation to make sure everything is working correctly. Refer to Test allocation documentation.Next steps
Congratulations! You’ve successfully set up Multiplay Hosting. You can continue to Multiplay Hosting in the Unity Dashboard to:- View analytics about your fleet.
- Configure more builds, build configurations, and fleets.
- Create more test allocations.