Developer Documentation
Our new developer documentation is now available. Please check it out!

Manual

Welcome to the ODIN Fleet manual! Here you will find detailed information about the concepts and features of the ODIN Fleet platform. Whether you are a game developer, publisher, or server operator, this manual will help you understand how to use ODIN Fleet to deploy and manage your game servers.

Basic Flow

The basic flow of using ODIN Fleet involves the following steps:

1Create Image

The first thing you need to do is to provide your server to the ODIN Fleet platform. This is done by creating a Docker image that contains your server software and all the necessary files. You can create an image from a public or private registry or use Steamworks to create an image from files stored in your Steamworks account and we will create the image automatically for you.

2Create Configuration

Once you have created an image, you need to create a server configuration that defines how your server should run. This includes setting up ports, environment variables, and persistent folders, among other things. You can create multiple server configurations for the same image to run different types of servers. This is useful if you want to run multiple game modes or different versions of your game.

3Create Deployment

After creating a server configuration, you need to create a deployment that specifies which server configuration to use and how many instances of the server to run. You can also set up auto-scaling rules to automatically scale the number of server instances based on the load.

4Monitor & Manage

Once your deployment is up and running, you can monitor and manage your servers using the ODIN Fleet dashboard. You can view server logs, metrics, and events, as well as perform actions like restarting, stopping, or scaling your servers.

The manual is divided into the following sections: