HiveMP Game Servers Quickstart

How did we do?

This quickstart shows you how to create a game server cluster, define a basic game server template, and then launch a game server instance on HiveMP Game Servers.

Before you begin

To demonstrate how to use HiveMP Game Servers, we'll be launching a dedicated game server for Xonotic through HiveMP Game Servers. Xonotic is an open source, multiplayer game. In order to complete this quickstart, you should download the Xonotic game client from their website.

Create a game server cluster

To complete this quickstart, you'll need to create a game server cluster to deploy game servers into. Refer to one of the following How-to Guides:

Amazon Web Services' managed Kubernetes service (EKS) is not currently supported by HiveMP. Refer to Creating a game server cluster for more information.

Define a game server template

Once you've configured a game server cluster, you'll need to define a game server template. Templates define how HiveMP Game Servers launches your game server instances.

As an example to demonstrate how game servers can be launched on HiveMP Game Servers, we'll configure a template to launch a Xonotic game server.

  1. Open Game Server Templates in the Admin Console.
  2. Click Create Game Server Template.
  3. For Name, enter "Xonotic".
  4. For Docker Image, enter "detrate/xonotic-docker".
  5. Leave Image Pull Credential blank.
  6. For Resources per Game Server Instance, enter "4"
  7. Under Public Ports, click Add, then select "UDP" with a port number of "26000".
  8. Click Create.

Launch a game server

You can now launch an instance of the Xonotic game server through the Admin Console.

  1. Open Game Server Instances in the Admin Console.
  2. Click Provision Instance.
  3. For Game Server Template, search for and select the "Xonotic" game server template you set up in the previous section.
  4. For Game Server Cluster, select the game server cluster you set up in the previous section.
  5. For Version, enter "stable". If you leave it as the default of "latest", the game server will not provision correctly.
  6. Click Create.

It can take up to 10 minutes for the game server to provision the first time, as your game server cluster will need to download the game image to the node it is running on. With HiveMP Game Servers, subsequent launches of game server instances on the same node can start in under 10 seconds.

Wait until the game server instance moves into the "Active" status before continuing with the next section.

Testing the game server

In the Admin Console, locate the game server instance you provisioned. It should indicate the IP address that the game server is available on, and the port mappings that have been applied as part of launching the game server instance.

  1. Open Game Server Templates in the Admin Console.
  2. Locate the game server instance that you previously launched, and which is now in the "Active" status.
  3. Make note of the IP address and the port that udp/26000 has been mapped to.
  4. Launch the Xonotic game client on your own computer.
  5. Go through the initial set up of the Xonotic game client until you're at the main menu.
  6. Click Multiplayer.
  7. In the Address field located at the bottom of the screen, enter <ipaddr>:<port>, where <ipaddr> is the IP address of the game server and <port> is the port that udp/26000 was mapped to.
  8. Click Join.
  9. Your game client should then successfully connect to the game server you provisioned after about 20 seconds.

After you've connected, you can click Terminate in the Admin Console to terminate the game server instance you launched. You should observe the game client warning about a disconnection after about 30 seconds.

Cleaning up

Once you've completed this quickstart, you might want to cleanup resources that you've created in HiveMP, such as:

  • Terminating any active game server instances you provisioned.
  • Shutting down clusters on Google Cloud, AWS or Azure that you created during this quickstart.
  • Disconnecting game server clusters you created in HiveMP.

Further reading