Set up a project | Introduction

This guide takes you through setting up hosting for a session-based game project with zeuz server hosting orchestration tools.

Before you begin

Complete the Get started tutorial. It uses a test project to demonstrate zeuz server hosting orchestration, the zeuz control panel (ZCP) and zeuz tool CLI, as well as explaining the zeuz utilities, the SDK download and zeuz concepts.


In addition to the prerequisites covered in the Get started tutorial, note the following:

  • Your game server executable file must run on Linux.
  • The zeuz tool CLI runs on Windows 10, MacOS 10.x, or Linux.


You need to have the following downloaded and set up. (Note that the Get started tutorial gives guidance on how to meet these requirements.)

Find out more:

Download the latest version of one of the following packages:

  • The omnibus package (approximately 200MB), which includes everything available to download.
  • The package for your operating system.
Info: What is in the zeuz SDK download? Why do I need it?

Contents of the zeuz SDK download (omnibus):

  • The API Reference - the zeuz base API documentation

  • API wrappers for Unreal and Unity

  • zeuz tool - a CLI you use for zeuz orchestration, specifically to upload your game server executable file and its dependencies (referred to as your “game assembly”). (You can use zeuz tool to run commands with the zeuz base API from the command line on your development machine.)

  • Example implementations of zeuz integrations in the following:

    • An Unreal Sample .uproject
    • A Unity Test Scene
  • A zeuz game integration with Unreal Blueprints.

  • An SDK in Go.

  • JavaScript example scripts that call the zeuz base API.

  • zeuz sample - an example of how to work with allocations and payloads with the SDK in Go.

    You can run this example on a variety of operating systems.

  • zeuz tutorial assets including the zeuz test project game server image.

See the zeuz glossary entry for Omnibus package for more information.

About the zeuz base API:

  • Setting up your game and the zeuz base API

    You can integrate your game project with zeuz from any game engine or programming language through the zeuz base API, which uses HTTP. You can find API reference documentation in the SDK download or on the zeuz documentation website.

    The SDK download also contains zeuz base API wrappers for Unity and Unreal, an SDK in Go and JavaScript examples using the base API.

    Note that if you are using Unity, Unreal or Go, you can use the base API directly. You do not have to use the Unity or Unreal wrappers, or the SDK in Go.

  • Using the API as an alternative to zeuz tool

    You can upload a game image with the zeuz base API endpoint ImageManager.

    See the API Reference for further information.

Find out more:

Unreal users

There are two ways to use an Unreal project with zeuz:

  • With the zeuz base API.

    This works with a project made in any version of Unreal.

  • With the zeuz C# API wrapper, zeuz with Blueprints, and ZeuzSample.uproject. To use these, you import a zeuz Unreal plugin into your game project. This is in the zeuz SDK download, available from the zeuz download page.

    This works with the following Unreal Engine versions: 4.23, 4.24, 4.25 and 4.26.

For more information, see Set up zeuz in Unreal Engine.

Unity users

There are two ways to use a Unity project with zeuz:

  • With the zeuz base API.

    This works with a project made in any version of Unity.

  • With the zeuz C# API wrapper and Test scene.

    These are in the zeuz SDK download, available from the zeuz download page.

    To use both, import them as a Unity package into your game project. This works with the following Unity versions: 2019.1, 2019.2, 2019.3, 2020.1, and 2020.2.

Now go to 1 - Set up your game and hosting.

2021-sep-24 Page upated with editorial review.

2021-aug-02 Page updated: added link to omnibus package glossary term.

2021-jun-30 Page updated: updated url for ZCP.

2021-may-05 Page updated with editorial review: clarified and updated terms

Last edited on: October 18, 2021 (66851b24)