Query protocols

Note: The content on this page pertains to Game Server Hosting (Multiplay) available on the Unity Dashboard. If you’re using Game Server Hosting (Clanforge), see the Game Server Hosting (Clanforge) documentation.

A server query protocol is a protocol that facilitates querying information from a server. Game Server Hosting requires all builds to implement a server query protocol.

Note: Although you implement the query protocol in the build, you specify the query protocol in the build configuration.

Game Server Hosting uses the information supplied by the server query protocol to:

The analytic data is available per fleet and per server. The query protocol type might include concurrently connected players (CCU)ClosedConcurrently connected users (CCU) is the number of players simultaneously connected to a fleet, region, or server at a given point in time., players per platform, total available server slots, and current map.

The best server query protocol for your game depends on the unique characteristics of your game, such as the game engine. SQP works best with Unity Engine, and the A2S protocol might suit your needs better if you use Unreal Engine.

Tip: See go-svrquery for an example implementation of SQP. go-svrquery is a Golang client or talking to game serversClosedA server, also known as a game server, is an instance of a build executable running on a machine within a fleet. using various query protocols, including SQP.