Configuration Options #
Core Config #
pragma.config.CoreConfig
#
- Node-wide configuration.
- type:
Object
field description type values/restrictions clusterName
the name of this cluster String min: 1 nodeName
the name of this node, to be used as value in nodeByInstanceId of distributedServices String min: 0 openTelemetryServiceName
service name for open telemetry tracing String min: 0 logging
logging (logback) configuration Object of type LoggingConfig LoggingConfig session
session configuration Object of type SessionConfig SessionConfig portalUrl
hostname of the portal String min: 0 enableHistogramMetrics
enables histograms for metrics, uses a large number of tags per metric Boolean options: true
,false
enableKtorMetrics
enables standard ktor metrics for HTTP request Boolean options: true
,false
startupTimeoutMillis
maximum milliseconds to wait during startup before forcibly exiting Long min: 0, max: 9223372036854775807 shutdownTimeoutMillis
maximum milliseconds to wait during shutdown before forcibly exiting Long min: 0, max: 9223372036854775807 gatewayManager
enabling/disabling gateways Object of type GatewayManagerConfig GatewayManagerConfig distributedServices
map of services and node they run on Map of DistributedServiceConfig DistributedServiceConfig remoteNodeConfigs
map of remote node names to their host:port Map of RemoteNodeConfig RemoteNodeConfig nettyPendingTasksCheckPeriodMillis
determines how often to check pending tasks and emit a metric Long min: -9223372036854775808, max: 9223372036854775807 allowWorkInProgressAccess
allows access to methods that are works in progress Boolean options: true
,false
enableVersionWithBuildSlug
adds build slug info to version output Boolean options: true
,false
shardId
The unique uuid of this shard UUIDv4
pragma.config.LoggingConfig
#
- Logback configuration.
- type:
Object
field description type values/restrictions rootLoggerLevel
level of the root logger Enum LogLevel allowed values: OFF
,ERROR
,WARN
,INFO
,DEBUG
,TRACE
,ALL
logFormat
default log format String min: 0 consoleLoggerEnabled
enable logging to stdout/stderr Boolean options: true
,false
fileLoggerEnabled
enable logging to file Boolean options: true
,false
fileLoggerCurrentFilename
file name (including path) to use for logs String min: 0 fileLoggerRolledFilename
file name (including path) to use for rotated logs String min: 0 fileLoggerRolledTotalSizeCap
size cap of all rolled compressed log files String min: 0 loggers
logback log level per logger Map of Enum LogLevel allowed values: OFF
,ERROR
,WARN
,INFO
,DEBUG
,TRACE
,ALL
logLayout
type of layout to log Enum LogLayout allowed values: TEXT
,JSON
pragma.session.SessionConfig
#
- Session configuration.
- type:
Object
field description type values/restrictions httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807
pragma.config.GatewayManagerConfig
#
- Available gateways on this node.
- type:
Object
field description type values/restrictions player
whether the player gateway is enabled on this node Boolean options: true
,false
operator
whether the operator gateway is enabled on this node Boolean options: true
,false
partner
whether the partner gateway is enabled on this node Boolean options: true
,false
pragma.config.DistributedServiceConfig
#
- Distributed services configuration.
- type:
Object
field description type values/restrictions nodeByInstanceId
map of instances of distributed services and the node they are running on Map of String minLength: 0
pragma.config.RemoteNodeConfig
#
- Individual PragmaNodes and their gateway ports configuration.
- type:
Object
field description type values/restrictions host
the host that the node is running on String min: 0 port
the port that the remote node is listening on Int min: -2147483648, max: 2147483647
Service Configs #
pragma.gamedata.GameDataServiceConfig
#
- GameDataService configuration.
- type:
Object
field description type values/restrictions waitForMatchEndEventTimeoutMillis
time to wait to aggregate player match end events before sending the partial payload Long min: -9223372036854775808, max: 9223372036854775807 loginDataCollectionTimeout
time to wait to aggregate login data Long min: -9223372036854775808, max: 9223372036854775807
pragma.gateway.SocialPlayerGatewayConfig
#
- Social Player gateway configuration.
- type:
Object
field description type values/restrictions protocol
protocol of the host/port String min: 0 webSocketProtocol
protocol of the WebSocket host/port String min: 0 authenticateHost
authentication backend host String min: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 loginQueueEnabled
feature toggle for login queue Boolean options: true
,false
socialHost
social backend host advertised to clients String min: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536
pragma.auth.TokenSignerConfig
#
- Token Signer configuration.
- type:
Object
field description type values/restrictions partnerExpirationHours
length of time the partner token is valid for (hours) Long min: -9223372036854775808, max: 9223372036854775807 operatorExpirationMinutes
length of time the operator token is valid for (minutes) Long min: -9223372036854775808, max: 9223372036854775807 emailTokenExpirationMinutes
length of time the email validation token is valid for (minutes) Long min: -9223372036854775808, max: 9223372036854775807 playerTokenExpirationMinutes
length of time the player token is valid for (minutes) Double min: 4.9E-324, max: 1.7976931348623157E308 playerTokenRefreshMinutes
time before the player token expires that we tell clients to refresh Long min: -9223372036854775808, max: 9223372036854775807 playerTokenRefreshVarianceWindowMinutes
variance in refresh time to smooth the refresh load over time Long min: -9223372036854775808, max: 9223372036854775807 jwtPrivateKey
private key used to signed JWTs EncryptedString min: 1
pragma.account.config.GameDaoConfig
#
- GameDaoNodeService configuration.
- type:
Object
field description type values/restrictions databaseConfig
database config for the game dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
demo.echo.EchoServiceConfig
#
- Echo service configuration.
- type:
Object
field description type values/restrictions
pragma.auth.TokenDecoderConfig
#
- Token validator service configuration.
- type:
Object
field description type values/restrictions jwtPublicKey
JWT used to validate String min: 1
pragma.inventory.InventoryServiceConfig
#
- Inventory service configuration.
- type:
Object
field description type values/restrictions enableDeleteAllInventory
whether to allow making a cache/db delete call Boolean options: true
,false
enableDeletePlayerInventory
whether to allow players to delete their inventory Boolean options: true
,false
legacyItemLoadBehavior
on item retrieval do not filter out items with invalid catalogId Boolean options: true
,false
contentAccessByTags
content filtering on player endpoints by tags Object of type ContentAccessByTagsConfig ContentAccessByTagsConfig inventoryCacheConfig
Config for inventory data cache. Object of type InventoryCacheConfig InventoryCacheConfig
pragma.account.AccountServiceConfig
#
- Account service configuration.
- type:
Object
field description type values/restrictions gameManagementPollingFrequencyInMillis
frequency with which Account service checks for updated game management data Long min: -9223372036854775808, max: 9223372036854775807 verificationEmailEndpoint
URL to send the verification email requests to, which is passed into the email sender plugin when templating your email String min: 0
pragma.inventory.InventoryDaoConfig
#
- InventoryDaoConfig configuration.
- type:
Object
field description type values/restrictions databaseConfig
database config for the inventory dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.GameOperatorGatewayConfig
#
- Game Operator gateway configuration.
- type:
Object
field description type values/restrictions protocol
protocol of the host/port String min: 0 webSocketProtocol
protocol of the WebSocket host/port String min: 0 authenticateHost
authentication backend host String min: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 loginQueueEnabled
feature toggle for login queue Boolean options: true
,false
loginQueueHost
login queue host advertised to clients String min: 0 loginQueuePort
login queue port advertised to clients Int min: 1, max: 65536 socialHost
social backend host advertised to clients String min: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHost
game backend host advertised to clients String min: 0 gamePort
game backend port advertised to clients Int min: 1, max: 65536 gameBindPort
game backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536 sdkCoreEnabled
temporary feature toggle for Core SDK until it is stable Boolean options: true
,false
pragma.account.config.AccountDaoConfig
#
- AccountDaoNode service configuration.
- type:
Object
field description type values/restrictions databaseConfig
database config for the account dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.payment.PaymentDaoConfig
#
- Configuration for the PaymentDaoNodeService
- type:
Object
field description type values/restrictions databaseConfig
the database config for the payment dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.SocialOperatorGatewayConfig
#
- Social Operator gateway configuration.
- type:
Object
field description type values/restrictions protocol
protocol of the host/port String min: 0 webSocketProtocol
protocol of the WebSocket host/port String min: 0 authenticateHost
authentication backend host String min: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 loginQueueEnabled
feature toggle for login queue Boolean options: true
,false
socialHost
social backend host advertised to clients String min: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536
pragma.matchlifecycle.MatchLifecycleServiceConfig
#
- Configuration for the Match Lifecycle Service
- type:
Object
field description type values/restrictions createMatchTimeout
Milliseconds to wait for a game server to send a match ready request before releasing the players attached to the match. Long min: -9223372036854775808, max: 9223372036854775807 matchEndTimeout
Milliseconds to wait to gather match end data to be sent on the match end notification to the players from the match. Long min: -9223372036854775808, max: 9223372036854775807 enableMatchAbsoluteTimeout
Enables the match absolute timeout that will end a match after a specific amount of time has elapsed. Boolean options: true
,false
matchAbsoluteTimeoutMillis
Milliseconds to wait before ending a match. 0 or negative values means matches will never timeout. Will be ignored if enableMatchAbsoluteTimeout is false. Long min: -9223372036854775808, max: 9223372036854775807 enableKeepAlive
Enables the match keep alive loop requiring game servers to send a keep alive request in a specified interval or else the match will be ended. Boolean options: true
,false
keepAliveIntervalMillis
Milliseconds to wait between keep alive requests. This interval gets passed to the game server. Will be ignored if enableKeepAlive is false. Long min: -9223372036854775808, max: 9223372036854775807 keepAliveMissesLimit
Number of keep alive request misses before ending the match. Will be ignored if enableKeepAlive is false. Long min: -9223372036854775808, max: 9223372036854775807 enableMatchReconnect
enables the match reconnect flow Boolean options: true
,false
matchReconnect
Set match reconnect to required, optional, or off to determine a player client flow when recovering from an unexpected disconnect during a match Enum MatchReconnectOption allowed values: OFF
,REQUIRED
,OPTIONAL
pragma.telemetry.db.TelemetryDaoConfig
#
- DbTelemetryDao configuration.
- type:
Object
field description type values/restrictions databaseConfig
database config for the game dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.matchcapacity.MatchCapacityServiceConfig
#
- Match Capacity service configuration.
- type:
Object
field description type values/restrictions matchCapacityConfig
values controlling match capacity Object of type MatchCapacityConfig MatchCapacityConfig
pragma.telemetry.TelemetryServiceConfig
#
- The Telemetry service collects events and forwards them to a configured data store.
- type:
Object
field description type values/restrictions
pragma.gateway.GamePartnerGatewayConfig
#
- Game Partner gateway configuration.
- type:
Object
field description type values/restrictions protocol
protocol of the host/port String min: 0 webSocketProtocol
protocol of the WebSocket host/port String min: 0 authenticateHost
authentication backend host String min: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 loginQueueEnabled
feature toggle for login queue Boolean options: true
,false
loginQueueHost
login queue host advertised to clients String min: 0 loginQueuePort
login queue port advertised to clients Int min: 1, max: 65536 socialHost
social backend host advertised to clients String min: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHost
game backend host advertised to clients String min: 0 gamePort
game backend port advertised to clients Int min: 1, max: 65536 gameBindPort
game backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536 sdkCoreEnabled
temporary feature toggle for Core SDK until it is stable Boolean options: true
,false
pragma.matchmaking.MatchmakingConfig
#
- Matchmaking service configuration.
- type:
Object
field description type values/restrictions matchmakingDelayMillis
delay between matchmaking runs Long min: -9223372036854775808, max: 9223372036854775807 enableGetMatchmakingInfo
enables the player-facing endpoint to retrieve operational info about the matchmaking service Boolean options: true
,false
pragma.account.config.UnsafeIdentityDaoConfig
#
- UnsafeIdentityDaoNode service configuration.
- type:
Object
field description type values/restrictions databaseConfig
database config for the unsafe identity provider Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig canAuthenticate
can be used to authenticate players Boolean options: true
,false
canFederate
can be used to federate players Boolean options: true
,false
pragma.SocialBackendPartnerClientConfig
#
- Partner client configuration used to communicate with a Pragma Social backend from a Game backend.
- type:
Object
field description type values/restrictions bearerToken
The bearer token to use when making partner calls to the social backend EncryptedString min: 0
pragma.payment.PaymentServiceConfig
#
- Configuration for the PaymentService
- type:
Object
field description type values/restrictions
pragma.gateway.BackendGatewayConfig
#
- Backend gateway configuration.
- type:
Object
field description type values/restrictions port
port utilized for service-to-service communication Int min: -2147483648, max: 2147483647
pragma.gateway.GamePlayerGatewayConfig
#
- Game Player gateway configuration.
- type:
Object
field description type values/restrictions protocol
protocol of the host/port String min: 0 webSocketProtocol
protocol of the WebSocket host/port String min: 0 authenticateHost
authentication backend host String min: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 loginQueueEnabled
feature toggle for login queue Boolean options: true
,false
loginQueueHost
login queue host advertised to clients String min: 0 loginQueuePort
login queue port advertised to clients Int min: 1, max: 65536 socialHost
social backend host advertised to clients String min: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHost
game backend host advertised to clients String min: 0 gamePort
game backend port advertised to clients Int min: 1, max: 65536 gameBindPort
game backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536 sdkCoreEnabled
temporary feature toggle for Core SDK until it is stable Boolean options: true
,false
pragma.party.PartyConfig
#
- Party service configuration.
- type:
Object
field description type values/restrictions maxPlayersPerParty
maximum players allowed in each party Int min: -2147483648, max: 2147483647 disableMaxPlayerCount
whether to disable maximum player count limits in each party Boolean options: true
,false
enableLocalGameServerVersions
whether to allow local game clients to override their game server version for local development purposes Boolean options: true
,false
repeatInviteDelaySeconds
defines the delay between a player inviting another player consecutive times Int min: -2147483648, max: 2147483647 inventoryTagsToInclude
tags used to filter player inventories, and items that match one or more tags will be included Map of String minLength: 0 enableTransferPartyLeader
whether to transfer party leader status from one to another when invoking AssignPartyLeaderV1 Boolean options: true
,false
pragma.gateway.SocialPartnerGatewayConfig
#
- Social Partner gateway configuration.
- type:
Object
field description type values/restrictions protocol
protocol of the host/port String min: 0 webSocketProtocol
protocol of the WebSocket host/port String min: 0 authenticateHost
authentication backend host String min: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 loginQueueEnabled
feature toggle for login queue Boolean options: true
,false
socialHost
social backend host advertised to clients String min: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536
pragma.databases.UnpartitionedDatabaseConfig
#
- Standard Pragma Engine database connection configuration.
- type:
Object
field description type values/restrictions driver
which driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDB
username
username to use String min: 1 password
password to use EncryptedString min: 0 hikariConnectionTimeoutMillis
connection timeout in millis for Hikari connection pool, default: 20,000ms Long min: -9223372036854775808, max: 9223372036854775807 hikariMinimumIdleConnections
minimum number of connections to hold open for Hikari connection pool, default: 0 Int min: -2147483648, max: 2147483647 hikariConfigMaximumPoolSize
maximum connection pool size for Hikari connection pool, default: 10 Int min: -2147483648, max: 2147483647 hikariConfigIdleTimeoutMillis
idle timeout in millis for Hikari connection pool, default: 300,000ms Long min: -9223372036854775808, max: 9223372036854775807 dynamicShardingSupport
enables virtual nodes and sharding support, default:false Boolean options: true
,false
hostPortSchema
schema String min: 0
pragma.inventory.ContentAccessByTagsConfig
#
- Content filtering configuration on player endpoints by tags.
- type:
Object
field description type values/restrictions hidden
content filtering configuration on player endpoints by tags. Map of String minLength: 0
pragma.inventory.InventoryCacheConfig
#
- Config for inventory data cache.
- type:
Object
field description type values/restrictions maxTimeBetweenAccessMillis
If an entry has not been accessed in this amount of time, it is a candidate for removal in the next eviction sweep. Long min: -9223372036854775808, max: 9223372036854775807 sizeBeforeExpirationEnforced
Size of cache before eviction sweeping will start removing entries. Int min: -2147483648, max: 2147483647 sweepIntervalMillis
Time in millis between calling sweep for the cache. Long min: -9223372036854775808, max: 9223372036854775807
pragma.databases.PartitionedDatabaseConfig
#
- Standard Pragma Engine database connection configuration.
- type:
Object
field description type values/restrictions driver
which driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDB
username
username to use String min: 1 password
password to use EncryptedString min: 0 hikariConnectionTimeoutMillis
connection timeout in millis for Hikari connection pool, default: 20,000ms Long min: -9223372036854775808, max: 9223372036854775807 hikariMinimumIdleConnections
minimum number of connections to hold open for Hikari connection pool, default: 0 Int min: -2147483648, max: 2147483647 hikariConfigMaximumPoolSize
maximum connection pool size for Hikari connection pool, default: 10 Int min: -2147483648, max: 2147483647 hikariConfigIdleTimeoutMillis
idle timeout in millis for Hikari connection pool, default: 300,000ms Long min: -9223372036854775808, max: 9223372036854775807 dynamicShardingSupport
enables virtual nodes and sharding support, default:false Boolean options: true
,false
columnNameOfPropertyToConsistentHash
property to shard by (ie playerId) String min: 0 hostPortSchemas
schemas by index Map of String minLength: 0
pragma.matchcapacity.MatchCapacityConfig
#
- Match Capacity service requirement configuration.
- type:
Object
field description type values/restrictions floor
empty system minimum match capacity Int min: -2147483648, max: 2147483647 ceiling
absolute maximum number of matches Int min: -2147483648, max: 2147483647 headroomPercent
desired available capacity defined by % of existing matches Int min: -2147483648, max: 2147483647 serverMaxStartDurationMillis
maximum duration, in milliseconds, a game server can take to start before the allocation is declared failed Long min: -9223372036854775808, max: 9223372036854775807 serverHeartbeatPeriodMillis
expected heartbeat period a game server should report its state Long min: -9223372036854775808, max: 9223372036854775807 serverHeartbeatExpiryFactor
number as a float of heartbeats before a game server is considered timed out Double min: 4.9E-324, max: 1.7976931348623157E308 matchReadyTimeoutMillis
maximum duration, in milliseconds, the platform will wait for a MatchReady call for a specific match before tearing down the match Long min: -9223372036854775808, max: 9223372036854775807
Plugin Configs #
pragma.inventory.SteamEntitlementConfig
#
- Steam entitlement provider plugin configuration.
- type:
Object
field description type values/restrictions appConfig
Steam app config for entitlement processing Object of type SteamAppConfig SteamAppConfig
demo.account.FakeAuthIdentityProviderPlugin$Config
#
- Fake Auth Identity Provider plugin configuration.
- type:
Object
field description type values/restrictions identityProvider
The enum that this id provider is faking Enum IdProvider allowed values: UNUSED
,UNSAFE
,EPIC
,DISCORD
,STEAM
,EMAIL
,GOOGLE
,PLAYSTATION
,TWITCH
,CUSTOM
,UNRECOGNIZED
pragma.gateway.FilePortalModulePlugin$Config
#
- File Portal Router plugin configuration.
- type:
Object
field description type values/restrictions portalSource
path to portal resource files String min: 0 modules
modules enabled for the portal Map of String minLength: 0 defaultModule
first module loaded when the portal is opened String min: 0 discordClientId
client id for Discord authentication String min: 0 googleClientId
client id for Google authentication String min: 0 twitchClientId
client id for Twitch authentication String min: 0 authenticationIdProviders
id providers enabled for portal login Map of Enum IdProvider allowed values: UNUSED
,UNSAFE
,EPIC
,DISCORD
,STEAM
,EMAIL
,GOOGLE
,PLAYSTATION
,TWITCH
,CUSTOM
,UNRECOGNIZED
redirectSignInToSocial
can be used to disable the social sign-in redirect Boolean options: true
,false
pragma.gateway.ResourcePortalModulePlugin$Config
#
- Resource Portal Router plugin configuration
- type:
Object
field description type values/restrictions basePackage
resource package for portal files String min: 0 modules
modules enabled for the portal Map of String minLength: 0 defaultModule
first module loaded when the portal is opened String min: 0 discordClientId
client id for Discord authentication String min: 0 authenticationIdProviders
id providers enabled for portal login Map of Enum IdProvider allowed values: UNUSED
,UNSAFE
,EPIC
,DISCORD
,STEAM
,EMAIL
,GOOGLE
,PLAYSTATION
,TWITCH
,CUSTOM
,UNRECOGNIZED
redirectSignInToSocial
can be used to disable the social sign-in redirect Boolean options: true
,false
pragma.matchmaking.FreeForAllWarmBodyMatchmakingStrategy$Config
#
- FreeForAllWarmBodyMatchmakingStrategy configuration.
- type:
Object
field description type values/restrictions numberOfPlayers
number of players in the FFA match Int min: 1, max: 2147483647
pragma.config.EmptyPluginConfig
#
- Empty plugin config for configless plugins.
- type:
Object
field description type values/restrictions
pragma.account.config.TwitchIdProviderConfig
#
- Twitch Id Provider configuration.
- type:
Object
field description type values/restrictions clientSecret
your app’s secret key (provided by Twitch) EncryptedString min: 0 clientId
your app’s id (provided by Twitch) String min: 0 redirectUri
your app’s redirect URI, as defined with Twitch String min: 0
pragma.payment.steam.SteamPaymentConfig
#
- Steam payment plugin configuration.
- type:
Object
field description type values/restrictions appConfig
Steam app config for payment processing Object of type SteamAppConfig SteamAppConfig defaultCurrencyCode
the default currency code to use when a player’s configured currency is not configured for a product entry. Enum CurrencyCode allowed values: UNUSED_CURRENCY
,USD
,EUR
,CAD
,AED
,ARS
,AUD
,BRL
,CHF
,CLP
,CNY
,COP
,CRC
,GBP
,HKD
,ILS
,IDR
,INR
,JPY
,KRW
,KWD
,KZT
,MXN
,MYR
,NOK
,NZD
,PEN
,PHP
,PLN
,QAR
,RUB
,SAR
,SGD
,THB
,TRY
,TWD
,UAH
,UYU
,VND
,ZAR
,UNRECOGNIZED
demo.matchcapacity.SkeletonCapacityProvider$Config
#
- Generic skeleton match capacity provider configuration.
- type:
Object
field description type values/restrictions loadTestClient
type of client to use for making game launch requests, localhost loadtest only or remote capable [true false] Boolean capacityPerServer
amount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 startProcessCommandStrategy
Class.JvmName of the start process command implementation class String min: 0 matchLauncher
type of match launcher [demo.matchcapacity.LocalMatchLauncher demo.matchcapacity.ForkProcessMatchLauncher String partnerConnectionInfo
Pragma Engine partner connection info for games to report their existence Object of type PartnerConnectionInfoConfig PartnerConnectionInfoConfig clientInitialHeartbeatPeriodMillis
heartbeat period used when the server has not yet responded Long min: -9223372036854775808, max: 9223372036854775807
pragma.party.DefaultGameServerCompatibilityPlugin$Config
#
- Pragma Engine Nomad match capacity provider configuration.
- type:
Object
field description type values/restrictions gameServerVersion
hardcoded game server version to return, default value: GameServerVersion1 String min: 0
pragma.account.config.EmailIdProviderConfig
#
- Email Id Provider configuration.
- type:
Object
field description type values/restrictions privateKey
an encrypted private key used for encrypting emails in Pragma Engine’s database EncryptedString min: 0
pragma.account.SendInBlueEmailSenderPlugin$SendInBlueEmailSenderConfig
#
- EmailSender plugin configuration.
- type:
Object
field description type values/restrictions providerAPIKey
the API key that will enable you to send emails with your provider EncryptedString min: 0 apiUrl
base URL for the provider API to interact with String min: 0 route
the HTTP route for the provider String min: 0 verificationTemplateId
id of the email template to send String min: 0 fromEmail
verified email address associated with the account in sendinblue that this email will be sent from String min: 0 fromName
name displayed String min: 0
pragma.metrics.StatsdRegistryProvider$Config
#
- Statsd metrics registry provider configuration.
- type:
Object
field description type values/restrictions flavor
flavor of statsd Enum StatsdFlavor allowed values: ETSY
,DATADOG
,TELEGRAF
,SYSDIG
host
host to send stats String min: 0 port
port to send stats Int min: -2147483648, max: 2147483647 protocol
protocol to send stats Enum StatsdProtocol allowed values: UDP
,TCP
maxPacketLength
max packet length to send stats Int min: -2147483648, max: 2147483647 pollingFrequencySeconds
polling frequency to send stats Int min: -2147483648, max: 2147483647 stepSeconds
step size to compute windowed statistics Int min: -2147483648, max: 2147483647 publishUnchangedMeters
whether to publish unchanged meters Boolean options: true
,false
buffered
whether to buffer metrics sent Boolean options: true
,false
pragma.matchcapacity.MultiplayCapacityProvider$Config
#
- MultiplayClientNode service configuration.
- type:
Object
field description type values/restrictions capacityPerServer
amount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 regionId
regionId for Multiplay API calls String min: 0 fleetId
fleetId for Multiplay API calls String min: 0 profileId
profileId for Multiplay API calls String min: 0 projectGuid
project guid for Multiplay API calls String min: 0 accessKey
Clanforge Access Key for signing REST API calls to Multiplay String min: 0 secretAccessKey
Clanforge Secret Access Key for signing REST API calls to Multiplay EncryptedString min: 0 useAllocateV2
feature toggle to enable using Multiplay AllocateV2 Boolean options: true
,false
pragmaGamePartnerBackendAddress
tells the Multiplay game server where the Pragma Game Partner gateway is, and is only used when AllocateV2 is enabled String min: 0 gameServerZoneToMultiplayRegionId
map of gameServerZone to Multiplay region id Map of String minLength: 0
pragma.matchmaking.CooperativeWarmBodyMatchmakingStrategy$Config
#
- CooperativeWarmBodyMatchmakingStrategy configuration.
- type:
Object
field description type values/restrictions numberOfPlayers
number of players in the cooperative match Int min: 1, max: 2147483647
pragma.metrics.DatadogRegistryProvider$Config
#
- Datadog metrics registry provider configuration
- type:
Object
field description type values/restrictions apiKey
Datadog API key EncryptedString min: 0 applicationKey
Datadog application key EncryptedString min: 0 descriptions
whether to send descriptions metadata Boolean options: true
,false
hostTag
host tag when shipping metrics String min: 0 uri
URI to ship metrics to String min: 0
pragma.inventory.TwitchDropsEntitlementConfig
#
- Twitch Drop entitlement provider plugin configuration.
- type:
Object
field description type values/restrictions clientId
ID of your client in the Twitch Dev Portal String min: 0 clientSecret
Secret of your client in the Twitch Dev Portal EncryptedString min: 0 gameId
The game ID associated with the drops to sync String min: 0
pragma.matchcapacity.PragmaNomadCapacityProvider$Config
#
- Pragma Engine Nomad match capacity provider configuration.
- type:
Object
field description type values/restrictions url
full URL (including protocol and port) to reach the Nomad API URL capacityPerServer
amount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 executableName
name of the executable such as ‘gameServer.sh’ String min: 0 args
command line args to pass to the start game server script, and chains together map values, ordered by key Map of String minLength: 0 jobCpu
Amount of cpu to allocate per task instance in MHz. See https://developer.hashicorp.com/nomad/docs/job-specification/resources#cpu Int min: -2147483648, max: 2147483647 jobDatacenter
Nomad Datacenter to allocate new task instance. See https://developer.hashicorp.com/nomad/api-docs/json-jobs#datacenters String min: 0 jobMemory
Amount of memory to allocate per task instance in MB. See https://developer.hashicorp.com/nomad/docs/job-specification/resources#memory Int min: -2147483648, max: 2147483647
pragma.account.config.DiscordIdProviderConfig
#
- Discord Id Provider configuration.
- type:
Object
field description type values/restrictions clientSecret
your app’s secret key (provided by Discord) EncryptedString min: 0 clientId
your app’s id (provided by Discord) String min: 0 guildId
your guild id, also known as server id String min: 0 redirectUri
your app’s redirect URI, as defined with Discord String min: 0 botToken
bot token associated with your Discord Server’s bot EncryptedString min: 0 authorizedRoleIds
set of guild role ids that provide access to Pragma Engine social backend Map of String minLength: 0
pragma.shared.SteamAppConfig
#
- Steam application configuration.
- type:
Object
field description type values/restrictions steamWebAPIKey
your app’s secret web API key (provided by Steam) EncryptedString min: 0 appId
your app’s id (provided by Steam) String min: 0
pragma.matchcapacity.LocalProcessCapacityProvider$Config
#
- Generic Local Process match capacity provider configuration.
- type:
Object
field description type values/restrictions processCommand
full command line including parameters run the process Map of String minLength: 0 serverIdParam
name of the command line param to append with the allocated server id String min: 0 logPathParam
name of the command line param to append with the program log path, and this will result in a file inside logOutputPath String min: 0 logOutputPath
path to a folder where to redirect log output String min: 0 maximumLocalServers
maximum number of local servers this provider can support Int min: -2147483648, max: 2147483647 portParam
name of the command line param to append with the allocated host port value String min: 0 gameServerZoneParam
name of the command line param to append with the game server zone String min: 0 minPort
minimum value of the game server host port Int min: -2147483648, max: 2147483647 maxPort
maximum value of the game server host port Int min: -2147483648, max: 2147483647
pragma.party.OrderedGameServerCompatibilityPlugin$Config
#
- OrderedGameServerCompatibility plugin configuration.
- type:
Object
field description type values/restrictions versionCompatibility
map of all the server versions to compatible game client versions Map of VersionCompatibility VersionCompatibility
pragma.inventory.EpicEntitlementConfig
#
- Epic entitlement provider plugin configuration.
- type:
Object
field description type values/restrictions sandboxId
ID of the sandbox to operate on String min: 0 deploymentId
ID of the corresponding deployment in the Epic Dev Portal String min: 0 clientId
ID of your client in the Epic Dev Portal String min: 0 clientSecret
Secret of your client in the Epic Dev Portal EncryptedString min: 0
demo.matchlifecycle.GameFlowMatchFoundPlugin$Config
#
- GameFlowMatchFoundPlugin plugin configuration.
- type:
Object
field description type values/restrictions matchDurationMillis
the duration of match in milliseconds Long min: -9223372036854775808, max: 9223372036854775807
pragma.matchmaking.WarmBodyMatchmakingPlugin$Config
#
- WarmBodyMatchmakingPlugin configuration.
- type:
Object
field description type values/restrictions numberOfTeams
number of teams required for the match Int min: 1, max: 2147483647 playersPerTeam
number of players required for each team Int min: 1, max: 2147483647
pragma.shared.SteamAppConfig
#
- Steam application configuration.
- type:
Object
field description type values/restrictions steamWebAPIKey
your app’s secret web API key (provided by Steam) EncryptedString min: 0 appId
your app’s id (provided by Steam) String min: 0
pragma.matchcapacity.PartnerConnectionInfoConfig
#
- Connection configuration for Pragma Partner endpoints.
- type:
Object
field description type values/restrictions gameToken
authentication token to the Pragma Engine Game platform EncryptedString min: 0 socialToken
authentication token to the Pragma Engine Social platform EncryptedString min: 0 protocol
Pragma Engine partner protocol (http/https) String min: 0 host
Pragma Engine partner host name String min: 0 port
Pragma Engine partner port Int min: -2147483648, max: 2147483647
pragma.party.VersionCompatibility
#
- clientVersions to serverVersion support configuration.
- type:
Object
field description type values/restrictions serverVersion
game server version string, must not be empty String min: 0 clientVersions
game client versions supported by this server version Map of String minLength: 0