Documentation

Support

Multiplay Hosting

Multiplay Hosting

Configuration variables

Learn how configuration variables pass runtime values to your game servers without redeploying.
Read time 1 minuteLast updated 3 days ago
Configuration variables are variables defined on build configurations that Multiplay Hosting uses to generate a 
server.json
file for each server. Each build configuration has a set of built-in variables, but you can create any number of custom configuration variables to track data that’s important to your build. You might want to track a difficulty modifier, the game mode, or the game map. You can define configuration variables per build configuration. These custom configuration variables allow you to track data, such as a difficulty modifier, the game mode, or the game map. Multiplay Hosting uses your custom variables and the built-in variables to generate a 
server.json
for each game server.

Built-in Configuration variables

Each build configuration has the following built-in configuration variables:

Configuration variable

Description

allocatedUUID
The unique ID of the allocation.
fleetID
The ID of the fleet of which the server is a member.
ip
The IP address of the server instance.
ipv6
The IPv6 address of the server instance, if available.
machineID
The ID of the machine on which the server is running.
port
The port at which the specific server instance is accessible.
queryType
The query protocol the server instance uses.
queryPort
The port at which you can access the query protocol data.
regionID
The ID of the region of which the server is a member.
regionName
The name of the region of which the server is a member.
serverFilesDir
The path where game server files should be written to be usable with the Unity Dashboard file collection and download functionality.
serverID
The unique identifier of the server instance.
serverLogDir
The path where log files should be written to be usable with the Unity Dashboard file collection and download functionality.