Skip to content
Gameye Docs

Getting Started

Quickstart

Section titled “Quickstart”

The fastest path to a running session: get a token, push a Docker image, make one API call.

Terminal window
curl -X POST https://api.production-gameye.gameye.net/session \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "location": "europe",
    "image": "your-application",
    "env": {
      "MAP": "arena_01",
      "MAX_PLAYERS": "16"
    },
    "labels": {
      "matchId": "abc123"
    },
    "ttl": 3600
  }'

The response includes a session ID, IP address, and ports your game clients can connect to immediately. When the match ends, call DELETE /session or let the TTL terminate the container.

What you need before starting:

Five-step setup

Section titled “Five-step setup”

There are five steps to start using the orchestrator. It should only take a few hours to get set up, but before you start, make sure that you’ve got everything you need:

  • A working game server executable that runs on Linux.
  • An automated build pipeline, like Jenkins or CircleCI.
  • A machine with Docker installed (Linux or Windows build).
  • Team or Large Docker Hub account. (hub.docker.com/pricing)

We use Docker to containerize your game

Section titled “We use Docker to containerize your game”

Our orchestrator uses containers to split the load evenly across the world. Docker is an open-source platform that lets you build, deploy, run, update and manage these containers.

Following best practices

Section titled “Following best practices”

There are a few best practices you should follow if you want to get the most out of our platform.

Add versioning to your builds

Section titled “Add versioning to your builds”

Versions are essential. We use these to determine which image to pull, based on what’s already available on a machine.

Give each image a unique tag

Section titled “Give each image a unique tag”

While there are several different ways you can approach tags, we recommend using unique tagging. Every image that you use should have a completely different tag. And you should never reuse tags.

Keeping your Dockerfiles trim and tidy

Section titled “Keeping your Dockerfiles trim and tidy”

We recommend you go through the best practices for writing Dockerfiles to optimize your container and build efficient images.