Profiles and mods
Documentation for Profiles and mods
Read time 2 minutesLast updated a day ago
Profiles and mods work together to apply settings and configuration values to game servers within a fleet.
Profiles
Profiles are game server configurations under an account service that point to specific game image versions and contain configuration information that Clanforge's system reads and applies to machines within a fleet. The configuration information includes identifiers for game images, command-line parameters, and game server instance settings. Refer to Profiles. When a matchmaker allocates a game server, it specifies the profile ID that the game server should use. After receiving the allocation request from the matchmaker, Clanforge loads the specified profile and configures the game server with the information in the profile to prepare for the game session. This preparation includes:- Changing the game image version
- Updating settings
- Changing configuration options
- Restarting the game server process
Game images
Clanforge links each profile to a specific game image version. Part of the preparation Clanforge does for a game server is restarting the game server process with the game image version specified by the profile. In fact, when you change active game images in an allocation-based fleet, you do so by creating allocations with the profile ID that's linked to the specific game image version you want to change to.Settings
Settings are configuration key-value pairs that you can set onto a profile. These settings are then applied during server start or allocation time. You can create settings during game integration and you can modify these values at any time using the Clanforge UI or API.Configuration files
Besides settings and configuration options, profiles link game configuration files to the game image version they point to. These files include the initialization file, which is typically named GAME.init, and theserver.json
- The log output directory
- The map difficulty level
- Encryption keys
- Runtime settings
- The connection information (the port number and IP address)
server.json
- The allocation UUID
- The session authentication information
- The connection IP address
- The connection port
server.json
Mods
Mods are containers of configuration information and settings that profiles inherit from. Mods work like templates for profiles; they offer a set of base settings that includes:- Map lists
- Game types
- Exposed files
- Available game images
- Resource usage specification
- Custom settings
- Configuration files
- Command-line parameters