Configuration variables
Documentation for Configuration variables
Read time 1 minuteLast updated 3 hours ago
Configuration variables are variables you define that Clanforge uses to generate a server.json file for each server instance. Clanforge uses a set of built-in variables (listed below), but you can extend these variables with any custom data, such as a difficulty modifier or the game mode.
Note: If you need to load information before the configuration variables, consider using launch parameters instead.
Configuration variable | Description |
| The unique UUID of the allocation. |
| The unique identifier of the server instance. |
| The query protocol the server instance uses. |
| The port at which you can access the query protocol data. |
| The port at which the specific server instance is accessible. |
| The file path to where the build stores logging information. It’s relative to the server ID folder. |
{ “allocationUUID”: “434af841-586d-4403-939b-db19f77611a6”, “serverID”: “12345”, “queryType”: “sqp”, “queryPort”: “9010”, “port”: “9000”, “serverLogDirectory”: “12345/logs/” }
Example configuration variables
The following table has descriptions and example values for each built-in configuration variable.Variable | Type | Description | Example |
| uuid | The universally unique identifier for an allocation to the game server. |
|
| string | A string of the launch parameters passed to the game server or application on launch. |
|
| string | The path to the directory that has the configuration files for the game server. |
|
| uuid | The universally unique identifier for the parent fleet of the game server. |
|
| string | The name of the primary executable for the game server. |
|
| string | The directory in which a game server should send log files. |
|
| integer | The network port on which the game server should bind for traffic. |
|
| string | The ID of the profile that's used to run a game server. |
|
| integer | The network port on which the game server should bind for query protocol traffic. |
|
| string | The query protocol supported by the game server. |
|
| uuid | The universally unique identifier for the region the game server is running in. |
|
| integer | The internal Clanforge ID for this instance of the game server. |
|