README.md

Agones

Agones is a library for hosting, running and scaling dedicated game servers on Kubernetes.

Agones, is derived from the Greek word agōn which roughly translates to “contest”, “competition at games” and “gathering”. (source)

Disclaimer

This software is currently alpha, and subject to change. Not to be used in production systems.

Major Features

• Be able to define a GameServer within Kubernetes - either through yaml or via the API
• Manage GameServer lifecycles - including health checking and connection information.
• Client SDKs for integration with dedicated game servers to work with Agones.

Why does this project exist?

For more details on why this project was written, read the announcement blog post.

Requirements

• Kubernetes cluster version 1.9+
  • Minikube, Google Kubernetes Engine and Azure Kubernetes Service have been tested
  • If you are creating and managing your own Kubernetes cluster, the MutatingAdmissionWebhook, and ValidatingAdmissionWebhook admission controllers are required. We also recommend following the recommended set of admission controllers.
• Firewall access for the range of ports that Game Servers can be connected to in the cluster.
• Game Servers must have the project SDK integrated, to manage Game Server state, health checking, etc.

Installation

Follow these instructions to create a cluster on Google Kubernetes Engine (GKE), Minikube or Azure Kubernetes Service (AKS), and install Agones.

Usage

Documentation and usage guides on how to develop and host dedicated game servers on top of Agones.

Quickstarts:

• Create a Game Server
• Create a Game Server Fleet
• Edit Your First Game Server (Go)

Guides

• Integrating the Game Server SDK
• GameServer Health Checking
• Accessing Agones via the Kubernetes API