Build configurations

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.

Game Server Hosting uses build configurations to manage how servers run builds by specifying the query protocol, the application executable path, the usage settings, the configuration variables, and the launch parameters.

Each build configuration has the following associated information:

  • Build configuration name: The name of the build configuration.

  • Build configuration ID: The unique identifier of the build configuration.

  • Assigned build: The build assigned to the build configuration.

  • Fleet: The fleet the build configuration is linked to.

  • Query types: The type of query protocol the build supports.

  • Application executable path: The relative path to the executable within the linked build.

  • Launch parameters: The start-up parameters Game Server Hosting sends to the build executable when it's started.

  • Configuration variables: A set of built-in and custom variables Game Server Hosting uses to generate each server’s server.json file.

  • Usage settings: The settings that control the resources available to each server. These settings control the server density.

  • Last updated: The date and time the build was last updated.

Build configuration variables

Build configurations allow your game server to accept variables as launch parameters or as configuration variables injected into the server.json file. These two methods are entirely separate, and neither takes priority over the other. The best method for your situation depends on the implementation of your game server. However, there are some cases in which launch parameters make more sense than configuration variables and vice versa. See the following topics to learn more:

Build configurations and servers

Build configurations provide the servers using them with information about how to run. A server’s active build configuration tells the server:

Note: Removing a build configuration from a fleet does not affect the servers using the build configuration. The servers continue to use the build configuration until you (or your matchmakerClosedA multiplayer networking feature in games that groups players into a game session.) allocate them with a different build configuration.

Build configurations and fleets

The relationship between fleets and build configurations is one-to-many (one fleet to many build configurations). However, each fleet can only have one active build configuration.

There is no direct link between a build and a fleet, but when you link a build configuration to a fleet, it implicitly ties the build to the fleet. The relationship between builds and configurations is one-to-one.

When you remove a build configuration from a fleet, the fleet will no longer have access to the builds assigned to that build configuration.