Config templates
Config templates are a set of configurations, that can attach to one or more game servers. This lets you customize multiple servers at once.
Create templateโ
Blank templateโ
To create a new config template that is empty click + Add Config template
on the Config template page.
Enter a name
and select which game
the config template is for.
Optionally can you change the blueprint. When unsure, it's best to go with the Default blueprint
.
Click Create
to create a new Config template.
Default config / templateโ
For every game we created a Default config
, which is a good starting point for new game servers. The Default config
can also be used during troubleshooting, to rule out any issues with your configs.
Some games have multiple examples. Click a Default config
to add it to your dashboard.
Config templatesโ
Game configโ
Each game comes with different configuration files and settings on the Game
tab. You can manage all relevant files and settings from there.
Use Config variables for added flexibility.
Use the Shortcut navigation
on the right to quickly navigate to the right file / setting.
Easy & Advanced-modeโ
While all games support Advanced-mode
, some games support Easy-mode
. With Easy-mode
the settings are converted into a form with switches for easy management.
Switch between modes using the icon in the top-right corner and clicking Switch to Advanced-mode
or Switch to Easy-mode
.
Easy-mode exampleโ
Easy-mode presents a form with switches and input fields where you can manage a select group of settings.
Advanced-mode exampleโ
Advanced-mode shows all relevant files and settings that you may want to change for game servers.
Mod / Plugin configsโ
General / Framework configsโ
Some frameworks have general settings that determine how the framework functions, like PaperMC.
For frameworks with general settings you can, in most cases, manage the framework settings from the Mod / Plugin
tab too.
Configs for specific mods / pluginsโ
Manage configs for individual mods / plugins from the Config template.
You can only manage configs for mods / plugins that were installed via the dashboard. Manually installed mods / plugins won't have their configs updated by Config templates.
Use Config variables for added flexibility.
Click + Add mod / plugin
in the sidebar (right) to add more mods / plugins to your Config template.
Besides adding the config to your config template is it also possible to install mods / plugins on game servers from here.
Settingsโ
Edit the Config template name, change the blueprint, manage Admin ID's, configure automations and more advanced settings.
Blueprintโ
With blueprints, you can change which config files are listed on the config template.
This is useful for games that aren't officially supported on GameServerApp, but also for existing games that miss certain config files.
Change blueprint for Config templateโ
On the "Change blueprint for Config template" popup you can (optionally) also update the blueprint for all connected game servers. So the Config template and all connected game servers use the same blueprint.
Accessโ
Admin ID'sโ
Grant admin privileges to all ID's listed in the field. This automatically deploys to all connected game servers.
Automationโ
The automation settings in a Config template can be used to automate game servers.
See the Game server automation section for more details.
Special settingsโ
Settings under Special settings
are potentially breaking and should not be used unless you understand what you are doing. This might break your game server when used irresponsibly.
SteamCMD branchโ
Load any public SteamCMD branch.
Custom launch scriptโ
Add custom scripts to the gsa-control.ps1
and gsa-control.sh
files.
Generalโ
Config variablesโ
Adds extra flexibility to Config templates. Can be used to automatically load in installed mods, for example.
Game config variablesโ
%%BANLIST%%
replaced with ban list URL for game server%%MODIDS%%
replaced with id's of all installed mods%%ADMINLISTURL%%
replaced with the admin list URL for game server
Blueprint variablesโ
The more advanced variables listed on the blueprint variables section are also available in Config templates. These will replace the variables above entirely in the future.
Keep notesโ
Help everyone on the team stay updated about what changed for each Config template.
When editing a config, click Notes
in the top-right corner.
In the popup you can write text using Markdown styling. Hit Save
to save your changes.
Configs with notes show a little icon at the Config template overview. Hover over the icon to see a summary.
Cloningโ
Archiveโ
Game server actionsโ
Activate on game serversโ
Besides choosing a Config template from the game server settings can you also activate a config template on game servers from a Config template.
Click the icon in the top-right corner and click Activate on servers
.
In the popup you can see which servers already have the Config template activated and select other servers (for the game) to activate it on.
Restart game serversโ
Apply changes directly from the Config template.
Click the icon in the top-right corner and click Restart servers
.
In the popup you select which game servers should restart.
Groupsโ
Config template groups help keep config templates organised and tidy. You can add existing templates to a group or change the group for a template.
Create template groupโ
Click next to "Config templates" to create a new group.
Enter a name for the new group and hit Create
.
Change group for templateโ
Add existing templates to a group or change the group for a template by selecting the desired group in the dropdown.
Manage template groupsโ
Reorder, rename or delete template groups by clicking .
Third party appsโ
Beaconโ
For ARK: Survival Evolved & ARK: Survival Ascended you can use Beacon to manage your config template. Check out the video below to learn how to set it up.