Game server query protocols

A game server query protocol is a protocol that facilitates querying information from a game server instance. Clanforge uses the information supplied by the game server query protocol to detect unresponsive game servers and to create live dashboards of analytic data.

Clanforge requires all game titles to implement a game server query protocol. The information from the game server query protocol enables Clanforge to capture advanced analytic data on your game and feed it into Grafana dashboards to allow your team to monitor the game metrics and statistics. Depending on the query protocol, the statistics might include concurrently connected players (CCU), players by platform, total available server slots, and current map.

The game server query protocol also allows Clanforge to determine whether an instance of your game server is running properly. If Clanforge detects that a game server instance isn’t responding to queries, Clanforge restarts the game server to correct any issues.

Each game server must respond to queries regardless of the allocation status. If the game server doesn’t have any players on it or is otherwise unallocated, it should respond with “players=0” to ensure Clanforge doesn’t incorrectly detect that the game server is offline or unresponsive.

Types of game server query protocols

There are a variety of game server query protocols available. The two most common are:

  • SQP (Unity's Server Query Protocol)
  • A2S (Valve's Server Query Protocol)

The recommended protocol is SQP, which integrates well with Clanforge. It is supported by both the Unity and Unreal Engine SDKs.

Clanforge supports A2S. This may be useful if you are already using a library providing A2S, such as the Steam SDK. In future, this may not have feature parity with SQP.