zeuz Multiplayer Operations documentation

Welcome to the zeuz Multiplayer Operations documentation. Here, you'll find the zeuz User Manual and API reference. You can also check out the Helpdesk and Knowledge Base.

User Manual    API Reference

Get started

Get started: Introduction

This tutorial guides you through setting up hosting for a session-based game with zeuz server hardware orchestration tools.

The tutorial uses an empty "test" project which consists of a non-playable game server executable file which runs on Linux, and assets for HTTP game clients for Windows, macOS, and Linux. You download the test project as part of the tutorial. You can use the test project to evaluate zeuz.

We recommend that you follow this tutorial before setting up your own project with zeuz orchestration. When you're ready to set up your own project, see Set up a project.

Tutorial time: Approximately 60-90 minutes, depending on your internet access speed and whether you have an existing cloud server provider account.


Operating systems

Your local development machine

Your local development machine must run on one of the following operating systems:

  • Windows 10
  • macOS 10.x
  • Linux

The zeuz tool CLI, which you use on your local development machine to upload your game server executable file and its dependencies (referred to as a "game assembly"), runs on Windows, macOS, or Linux.

Your game server executable file

Your game server executable file must run on:

  • Linux

Note: You do not need your own game server executable file to complete this tutorial.

zeuz services include:

  • Server hardware orchestration.
  • Server hardware hosting: Bare-metal machines and zeuz-managed cloud server.

Info: What are bare-metal machines, cloud server, and orchestration?

Bare-metal machine
Computer server hardware that hosts a game’s server software for one account (usually one game studio) only. When you use zeuz services, you can use zeuz-managed bare-metal machines to host your game.

Cloud server
Computer server hardware that hosts a game’s server software where more than one cloud customer shares the same hardware. Each customer has a virtual machine, discrete from other customers on the same machine. Cloud servers provide the same functionality and support the same operating systems and applications as bare-metal machines. When you use zeuz services, you can use zeuz-managed cloud servers (provided by Amazon Web Services, Azure, Google Cloud Platform, or Tencent Cloud) or your own cloud server account which you organise directly with cloud service providers. There is more information on cloud service providers later in this tutorial.

You can use zeuz services to scale your server hardware requirements between bare-metal machines or cloud servers. This is orchestration.

Info: What is zeuz tool?

zeuz tool is a CLI you use for zeuz orchestration. It uploads your game server executable file and its dependencies (referred to as a "game assembly").

Find out more:

Info: What’s a "game assembly"?

A game assembly is a directory that contains all the files needed to run your game server. The game assembly includes details of your game’s executable (binary) file and its dependencies. When you upload your game assembly to the zeuz orchestration service, you also containerize the game assembly. Then it becomes a "game image" (sometimes referred to as "an image" or a "game server image"). A game image includes the settings that zeuz uses during your game server's deployment to start and stop the game server.

Find out more:

Now go to 1 - Set up a zeuz account.

2021-may-19 Page updated with editorial review: clarification of zeuz terms
2021-jan-19 Page created with editorial review

Updated 3 months ago

Get started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.