Skip to content

Session Templates

Version: Updated: 2023-11-29 16:56:05


Documentation for the Session Templates Page

Session Templates Schema

session_typestringYesUnique name for this type of session
engine_session_typestringYesThe engine name for this session type
can_join_matchmakingbooleanNoIf sessions of this type can be entered into the matchmaking system
can_be_created_by_playersbooleanNoIf players can create this session directly
publicly_joinablebooleanNoIf the session should be publicly joinable without invites
attempt_auto_joinbooleanNoShould we attempt to automatically join an existing session before creating a new one
default_publicbooleanNoIf the session should be publicly joinable without invites
auto_add_to_browserbooleanNoIf the session should be automatically added to the public session browser
auto_browser_paramsobjectNoParameters added to the session when it is automatically added to the public session browser
can_be_added_to_browserbooleanNoCan this session type be added to the public session browser
keep_alive_on_emptybooleanNoIf the session should be kept alive when there are no players actively in it
auto_startup_paramsobjectNoSee schema
min_session_countintegerNoThe minimum number of these sessions that should be kept alive at all times
default_num_teamsintegerNoDefault number of teams this session type will have
default_players_per_teamintegerNoDefault number of players allowed per team
can_player_change_teambooleanNoCan a player change their own team without elevated permissions
custom_dataobjectNoCustom passthrough data that will be added to all sessions of this type
sandbox_idstringNoID of the Sandbox
session_template_idstringYesUUID to identify this specific session template
platform_session_templatesarrayNoList of PlatformSessionTemplates that belong to this session type
last_modified_account_idstringNoAccount ID of the user who last modified the resource
last_modified_timestampstringNoTimestamp of when the resource was last modified

Auto_startup_params Schema

mapstringYesName of the map for the instance to spawn with
modestringNoGame mode for the instance to spawn in
misc_paramsstringNoAdditional commandline parameters for the instance
custom_dataobjectNoCustom data to pass through to the instance