Dependencies

• High-level understanding of Metaplay Cloud - We recommend reading the Introduction to Cloud Deployments to understand the key concepts of cloud deployments.
• An environment in the Metaplay Portal - To be able to deploy a game server to the Metaplay Cloud, you need a project with an environment to deploy to. Contact us to get started!
• Metaplay CLI - Install the Metaplay CLI if you haven't already.
• Docker - You need to have Docker installed on your machine.

Overview

This guide walks you through the steps to build and deploy your game server to a target environment.

Build a Container Image

First, build a container image of your game server:

MyGame$ metaplay build image

The build command will generate a container image named <projectID>:<timestamp>, like lovely-wombats-build:1739529676, for example.

Deploy the Game Server

Then, deploy the built image to the desired cloud environment:

MyGame$ metaplay deploy server

The CLI will ask for the target environment and the container image version to deploy.

You can also specify the targets explicitly with:

MyGame$ metaplay deploy server lovely-wombats-build-quickly lovely-wombats-build:1739529676

Check the Deployment

You can check what happened with the deployment by checking the game server logs:

MyGame$ metaplay logs [ENVIRONMENT]

Configure the Unity Client

You need to configure your client to know about the cloud environments. You can do this by following the Setup section of the Environment Configs guide.

Next, select the deployed environment as the active environment in Unity's Metaplay → Environment Configs menu.

Then, press play in Unity and your client will connect to the deployed game server.

Further Reading

The Setup CI Pipeline guide helps you set up CI pipelines that automatically deploy new versions of the game server directly from your source control.

A game server can end up in an unhealthy state due to various reasons. For troubleshooting, please visit the Troubleshooting page for more details.