Skip to main content

Blueprints

Customize how game servers work under the hood and control what fields are listed on Config templates. Blueprints can also be used to host games that are not officially supported by GSA.

This feature is mostly intended for advanced users, with some experience hosting game servers.

Go to Blueprints >

Work in progress

This section is currently being developed.

Variablesโ€‹

These variables are available in blueprint and Config templates files. Variables can be useful in cases where you want to replace a static (hardcoded) setting, like a port number, with a dynamic one. For example to make the game port automatically adjust to whatever GSA assigns to the container.

Machineโ€‹

{machine.ip}โ€‹

Returns the machine's public ip.
Example: 5.78.80.72

{machine.nas_root}โ€‹

Returns the path for the NAS folder.
Example: /home/GameServerApp/nas

{machine.cluster_root}โ€‹

Returns the path for the cluster folder.
Example: /home/GameServerApp/nas/cluster

{machine.backup_root}โ€‹

Returns the path for the backup folder.
Example: /home/GameServerApp/nas/backup

Containerโ€‹

{container.name}โ€‹

Returns the name of the container.
Example: sd03kdwd

{container.uid}โ€‹

Returns the UID of the container user.
Example: 1004

{container.gid}โ€‹

Returns the GID of the container user.
Example: 1004

{container.home_root}โ€‹

Returns the path for the container folder.
Example: /home/GameServerApp/containers/sd03kdwd

{container.temp_backup_dir}โ€‹

Returns the path for the container backup dir, this is a temporary directory created during the backup process.

Game serverโ€‹

{gameserver.list_name}โ€‹

Returns the in-game server browser list name for the game server.
Example: My Game Server

{gameserver.slot_limit}โ€‹

Returns the slot limit for the game server.
Example: 70

{gameserver.map}โ€‹

Returns the map for the game server.
Example: TheIsland

{gameserver.seed}โ€‹

Returns the map for the game server.
Example: 49385948383

{gameserver.query_port}โ€‹

Returns the assigned query port for the game server.
Example: 27015

{gameserver.game_port}โ€‹

Returns the assigned game port for the game server.
Example: 7777

{gameserver.raw_port}โ€‹

Returns the assigned raw port for the game server.
Example: 7778

{gameserver.rcon_port}โ€‹

Returns the assigned RCON / Telnet / Websocket port for the game server.
Example: 37015

{gameserver.rcon_password}โ€‹

Returns the RCON / Telnet / Websocket password for the game server.
Example: CLzvR035

{gameserver.banlist_url}โ€‹

Returns the banlist url for the game server.

{gameserver.adminlist_url}โ€‹

Returns the adminlist url for the game server.

Clusterโ€‹

{cluster.id}โ€‹

Returns the connected cluster ID for the game server.
Example: cb0440e7-d2e0-4eed-809c-16fa812ea928

Config templateโ€‹

{config_template.settings.branch}โ€‹

Returns the branch settings, that were entered on the Settings page for the selected Config template.
Example: public

{config_parameter id=""}โ€‹

Returns the content of the parameter, that was set on the Config template.
Example: when the config template has a parameter (id) end, you can reference it like so: {config_parameter id="end"}