Requirements and best practices

To ensure your players have the best possible experience with GameFabric, we recommend adhering to the following requirements and best practices.

Requirements

The following are essential for deploying your game server on GameFabric.

Server Requirements

• Linux Build: Your game server must be built for a Linux environment (amd64) to be compatible with GameFabric's containerized infrastructure. For more details on creating a compatible container, see Building a Container Image.

• Agones SDK Integration: Integrating the Agones SDK is crucial for your game server to communicate its state with the GameFabric platform. This includes:

  • Ready State: Signaling when the server is ready to accept players.
  • Allocated State: Signaling when the server is in use with active players. Any other state might get terminated by the system if necessary.
  • Health Checks: Periodically pinging to indicate the server is alive and healthy.

See Using the Agones SDK for implementation details.

Lifecycle management

Armadas

After a session ends (for example, when the last player leaves), the game server should either return to an Agones Ready state if it's meant to be reused for new sessions, or shut down if it's no longer needed. Additionally, the maximum lifetime of any game server should be limited to 24 hours.

Formations

For Formations, you must provide shutdown hints as described in running your game server.

Refer to Vessel Shutdown Behavior for additional details.

Best practices

• Keep your game server image as small as possible: A small game server image makes everything faster and also saves money in the long run.

• Log to stdout: Whenever possible, configure your game server to write logs directly to the standard output (stdout) and standard error (stderr) streams. This allows for seamless integration with GameFabric's log aggregation and monitoring systems. If your server can only write to a file, use the Game Server Wrapper to tail your log files and forward them to stdout/stderr.

• Handle network issues gracefully: Full network reliability is not guaranteed; nodes can occasionally experience network issues. Implement retry logic for failed connections and gracefully terminate the game server after multiple connection attempts fail.