Configuration Options #

Core Configurations #

pragma.config.CoreConfig #

Node-Wide Configuration

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    clusterNameThe name of the cluster.StringminLength: 1
    nodeNameThe name of the node, to be used in nodeByInstanceId of distributedServices.StringminLength: 0
    openTelemetryServiceNameService name for open telemetry tracing.StringminLength: 0
    loggingLogback configuration options.Object of type LoggingConfigLoggingConfig
    sessionThe configuration of a connection through a gateway.Object of type SessionConfigSessionConfig
    portalUrlHostname of the operator Pragma portal web interface.StringminLength: 0
    enableHistogramMetricsEnables histograms for metrics. This uses a large number of tags per metric.Booleanoptions: true, false
    enableKtorMetricsEnables standard KTOR metrics for HTTP requests.Booleanoptions: true, false
    metricsDistributionExpiryDurationSecondsThe expiration duration for DistributionStatistics. See https://micrometer.io/docs/concepts#_distribution_summaries for more information.Longmin: -9223372036854775808, max: 9223372036854775807
    startupTimeoutMillisThe maximum time in milliseconds to wait during startup before forcibly exiting.Longmin: 0, max: 9223372036854775807
    shutdownTimeoutMillisThe maximum time milliseconds to wait during shutdown before forcibly exiting.Longmin: 0, max: 9223372036854775807
    gatewayManagerObject that starts or stops player, operator, and partner gateways.Object of type GatewayManagerConfigGatewayManagerConfig
    distributedServicesMap of services running on each node.Map of Object of type DistributedServiceConfigDistributedServiceConfig
    remoteNodeConfigsMap object referencing all remote nodes to their host:port.Map of Object of type RemoteNodeConfigRemoteNodeConfig
    nettyPendingTasksCheckPeriodMillisHow often to check pending tasks and emit a metric.Longmin: -9223372036854775808, max: 9223372036854775807
    allowWorkInProgressAccessAllows access to methods that are works in progress.Booleanoptions: true, false
    enableVersionWithBuildSlugAdds a build slug to the version output.Booleanoptions: true, false
    shardIdThe unique uuid of this shard.UUIDv4

pragma.config.LoggingConfig #

Logback configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    rootLoggerLevellevel of the root loggerEnum LogLevelallowed values: OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL
    logFormatdefault log formatStringminLength: 0
    consoleLoggerEnabledenable logging to stdout/stderrBooleanoptions: true, false
    fileLoggerEnabledenable logging to fileBooleanoptions: true, false
    fileLoggerCurrentFilenamefile name (including path) to use for logsStringminLength: 0
    fileLoggerRolledFilenamefile name (including path) to use for rotated logsStringminLength: 0
    fileLoggerMaxFileSizemax file size for single log file before it is rolledStringminLength: 0
    fileLoggerRolledTotalSizeCapsize cap of all rolled compressed log filesStringminLength: 0
    loggerslogback log level per loggerMap of Enum LogLevelallowed values: OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL
    logLayouttype of layout to logEnum LogLayoutallowed values: TEXT, JSON

pragma.session.SessionConfig #

Session configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing sessionLongmin: -9223372036854775808, max: 9223372036854775807

pragma.config.GatewayManagerConfig #

Available gateways on this node.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerwhether the player gateway is enabled on this nodeBooleanoptions: true, false
    operatorwhether the operator gateway is enabled on this nodeBooleanoptions: true, false
    partnerwhether the partner gateway is enabled on this nodeBooleanoptions: true, false

pragma.config.DistributedServiceConfig #

Distributed services configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    nodeByInstanceIdmap of instances of distributed services and the node they are running onMap of StringminLength: 0

pragma.config.RemoteNodeConfig #

Individual PragmaNodes and their gateway ports configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    hostthe host that the node is running onStringminLength: 0
    portthe port that the remote node is listening onIntmin: -2147483648, max: 2147483647

Service Configurations #

pragma.playerdata.PlayerDataDaoConfig #

InventoryDaoConfig configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigdatabase config for the inventory daoObject of type PartitionedDatabaseConfigPartitionedDatabaseConfig

pragma.gamedata.GameDataServiceConfig #

GameDataService configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    loginDataCollectionTimeoutTime, in milliseconds, to wait to aggregate login dataLongmin: -9223372036854775808, max: 9223372036854775807

pragma.gateway.SocialPlayerGatewayConfig #

Social Player gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolprotocol of the host/portStringminLength: 0
    webSocketProtocolprotocol of the WebSocket host/portStringminLength: 0
    authenticateHostauthentication backend hostStringminLength: 0
    authenticatePortauthentication backend portIntmin: 1, max: 65536
    socialHostsocial backend host advertised to clientsStringminLength: 0
    socialPortsocial backend port advertised to clientsIntmin: 1, max: 65536
    socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort)Intmin: 0, max: 65536
    devLoginQueueBypassEnable to bypass login queue token validation during player authentication or creation.Booleanoptions: true, false

demo.echo.EchoServiceConfig #

Echo service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints

pragma.auth.TokenSignerConfig #

Token Signer configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    partnerExpirationHourslength of time the partner token is valid for (hours)Longmin: -9223372036854775808, max: 9223372036854775807
    operatorExpirationMinuteslength of time the operator token is valid for (minutes)Longmin: -9223372036854775808, max: 9223372036854775807
    emailTokenExpirationMinuteslength of time the email validation token is valid for (minutes)Longmin: -9223372036854775808, max: 9223372036854775807
    playerTokenExpirationMinuteslength of time the player token is valid for (minutes)Doublemin: 4.9E-324, max: 1.7976931348623157E308
    playerTokenRefreshMinutestime before the player token expires that we tell clients to refreshLongmin: -9223372036854775808, max: 9223372036854775807
    playerTokenRefreshVarianceWindowMinutesvariance in refresh time to smooth the refresh load over timeLongmin: -9223372036854775808, max: 9223372036854775807
    jwtPrivateKeyprivate key used to signed JWTsEncryptedStringminLength: 1

pragma.account.config.GameDaoConfig #

GameDaoNodeService configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigdatabase config for the game daoObject of type UnpartitionedDatabaseConfigUnpartitionedDatabaseConfig

pragma.auth.TokenDecoderConfig #

Token validator service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    jwtPublicKeyJWT used to validateStringminLength: 1

pragma.inventory.InventoryServiceConfig #

Inventory service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    enableDeleteAllInventoryDetermines whether to allow making a cache/db delete call.Booleanoptions: true, false
    enableDeletePlayerInventoryDetermines whether to allow players to delete their inventory.Booleanoptions: true, false
    legacyItemLoadBehaviorIf true, do not filter out items with invalid catalogId when retrieving items.Booleanoptions: true, false
    contentAccessByTagsContent filtering on player endpoints by tags.Object of type ContentAccessByTagsConfigContentAccessByTagsConfig
    inventoryCacheConfigConfig for inventory data cache.Object of type InventoryCacheConfigInventoryCacheConfig

pragma.account.AccountServiceConfig #

Account service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    gameManagementPollingFrequencyInMillisfrequency with which Account service checks for updated game management dataLongmin: -9223372036854775808, max: 9223372036854775807
    verificationEmailEndpointURL to send the verification email requests to, which is passed into the email sender plugin when templating your emailStringminLength: 0

pragma.loginqueue.LoginQueueServiceConfig #

Factory for login queue behavior, driven by a feature toggle

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    targetCcuLimitthe target maximum number of concurrent users logged inIntmin: 0, max: 2147483647
    targetLoginRatePerSecondthe target number of users to log in per secondIntmin: 0, max: 2147483647
    estimatedSecondsToLoginthe time between a user login request and the user gaining accessIntmin: 0, max: 2147483647

pragma.inventory.InventoryDaoConfig #

InventoryDaoConfig configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigdatabase config for the inventory daoObject of type PartitionedDatabaseConfigPartitionedDatabaseConfig

pragma.gameinstance.GameInstanceServiceConfig #

Configuration for the Game Instance Service

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    gameReadyTimeoutMillisTime, in milliseconds, to wait for a game server to send a connect players request before releasing the players attached to the game instance.Longmin: -9223372036854775808, max: 9223372036854775807
    enableAbsoluteTimeoutEnables the absolute timeout that will release a game from the service after a specific amount of time has elapsed.Booleanoptions: true, false
    absoluteTimeoutMillisTime, in milliseconds, to wait before releasing a game instance. 0 or negative values means games will never timeout. Will be ignored if enableAbsoluteTimeout is false.Longmin: -9223372036854775808, max: 9223372036854775807
    enableKeepAliveEnables the keep alive interval requiring game servers to send a keep alive request in a specified interval or else the game instance will be released from the service.Booleanoptions: true, false
    keepAliveIntervalMillisInterval, in milliseconds, to wait between keep alive requests. This interval gets passed to the game server. Will be ignored if enableKeepAlive is false.Longmin: -9223372036854775808, max: 9223372036854775807
    keepAliveMissesLimitNumber of keep alive request misses before releasing the game instance from the service. Will be ignored if enableKeepAlive is false.Longmin: -9223372036854775808, max: 9223372036854775807
    reconnectSet to required, optional, or off to determine the player client behavior when recovering from an unexpected disconnect during a game.Enum GameInstanceReconnectallowed values: OFF, REQUIRED, OPTIONAL

pragma.gateway.GameOperatorGatewayConfig #

Game Operator gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolprotocol of the host/portStringminLength: 0
    webSocketProtocolprotocol of the WebSocket host/portStringminLength: 0
    authenticateHostauthentication backend hostStringminLength: 0
    authenticatePortauthentication backend portIntmin: 1, max: 65536
    socialHostsocial backend host advertised to clientsStringminLength: 0
    socialPortsocial backend port advertised to clientsIntmin: 1, max: 65536
    socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort)Intmin: 0, max: 65536
    gameHostgame backend host advertised to clientsStringminLength: 0
    gamePortgame backend port advertised to clientsIntmin: 1, max: 65536
    gameBindPortgame backend port the backend binds to (if 0, defaults to gamePort)Intmin: 0, max: 65536
    sdkCoreEnabledtemporary feature toggle for Core SDK until it is stableBooleanoptions: true, false

pragma.account.config.AccountDaoConfig #

AccountDaoNode service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigdatabase config for the account daoObject of type UnpartitionedDatabaseConfigUnpartitionedDatabaseConfig

pragma.playerdata.PlayerDataServiceConfig #

Configuration for the Echo Service

  • Configuration Values:
    fielddescriptiontypevalues/constraints

pragma.payment.PaymentDaoConfig #

Configuration for the PaymentDaoNodeService

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigthe database config for the payment daoObject of type PartitionedDatabaseConfigPartitionedDatabaseConfig

pragma.gateway.SocialOperatorGatewayConfig #

Social Operator gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolprotocol of the host/portStringminLength: 0
    webSocketProtocolprotocol of the WebSocket host/portStringminLength: 0
    authenticateHostauthentication backend hostStringminLength: 0
    authenticatePortauthentication backend portIntmin: 1, max: 65536
    socialHostsocial backend host advertised to clientsStringminLength: 0
    socialPortsocial backend port advertised to clientsIntmin: 1, max: 65536
    socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort)Intmin: 0, max: 65536

pragma.telemetry.db.TelemetryDaoConfig #

DbTelemetryDao configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigDatabase configuration for the game dao.Object of type UnpartitionedDatabaseConfigUnpartitionedDatabaseConfig

pragma.matchcapacity.MatchCapacityServiceConfig #

Match Capacity service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    matchCapacityConfigThe values controlling match capacity.Object of type MatchCapacityConfigMatchCapacityConfig

pragma.telemetry.TelemetryServiceConfig #

The Telemetry service collects events and forwards them to a configured data store.

  • Configuration Values:
    fielddescriptiontypevalues/constraints

pragma.gateway.GamePartnerGatewayConfig #

Game Partner gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolprotocol of the host/portStringminLength: 0
    webSocketProtocolprotocol of the WebSocket host/portStringminLength: 0
    authenticateHostauthentication backend hostStringminLength: 0
    authenticatePortauthentication backend portIntmin: 1, max: 65536
    socialHostsocial backend host advertised to clientsStringminLength: 0
    socialPortsocial backend port advertised to clientsIntmin: 1, max: 65536
    socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort)Intmin: 0, max: 65536
    gameHostgame backend host advertised to clientsStringminLength: 0
    gamePortgame backend port advertised to clientsIntmin: 1, max: 65536
    gameBindPortgame backend port the backend binds to (if 0, defaults to gamePort)Intmin: 0, max: 65536
    sdkCoreEnabledtemporary feature toggle for Core SDK until it is stableBooleanoptions: true, false

pragma.matchmaking.MatchmakingConfig #

Matchmaking service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    matchmakingDelayMillisDelay, in milliseconds, between matchmaking runs.Longmin: -9223372036854775808, max: 9223372036854775807
    enableGetMatchmakingInfoEnables the player-facing endpoint to retrieve operational info about the matchmaking service.Booleanoptions: true, false

pragma.account.config.UnsafeIdentityDaoConfig #

UnsafeIdentityDaoNode service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigdatabase config for the unsafe identity providerObject of type UnpartitionedDatabaseConfigUnpartitionedDatabaseConfig
    canAuthenticatecan be used to authenticate playersBooleanoptions: true, false
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false

pragma.SocialBackendPartnerClientConfig #

Partner client configuration used to communicate with a Pragma Social backend from a Game backend.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    bearerTokenThe bearer token to use when making partner calls to the social backendEncryptedStringminLength: 0

pragma.payment.PaymentServiceConfig #

Configuration for the PaymentService

  • Configuration Values:
    fielddescriptiontypevalues/constraints

pragma.gateway.BackendGatewayConfig #

Backend gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    portport utilized for service-to-service communicationIntmin: -2147483648, max: 2147483647

pragma.databases.SharedDatabaseConfigServiceConfig #

Configuration lookup for all database connections

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    databaseConfigsByIdentifiermap of database connectionsMap of Object of type SharedDatabaseConfigSharedDatabaseConfig

pragma.gateway.GamePlayerGatewayConfig #

Game Player gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolprotocol of the host/portStringminLength: 0
    webSocketProtocolprotocol of the WebSocket host/portStringminLength: 0
    authenticateHostauthentication backend hostStringminLength: 0
    authenticatePortauthentication backend portIntmin: 1, max: 65536
    socialHostsocial backend host advertised to clientsStringminLength: 0
    socialPortsocial backend port advertised to clientsIntmin: 1, max: 65536
    socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort)Intmin: 0, max: 65536
    gameHostgame backend host advertised to clientsStringminLength: 0
    gamePortgame backend port advertised to clientsIntmin: 1, max: 65536
    gameBindPortgame backend port the backend binds to (if 0, defaults to gamePort)Intmin: 0, max: 65536
    sdkCoreEnabledtemporary feature toggle for Core SDK until it is stableBooleanoptions: true, false

pragma.party.PartyConfig #

Party service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    maxPlayersPerPartymaximum players allowed in each partyIntmin: -2147483648, max: 2147483647
    disableMaxPlayerCountwhether to disable maximum player count limits in each partyBooleanoptions: true, false
    enableLocalGameServerVersionswhether to allow local game clients to override their game server version for local development purposesBooleanoptions: true, false
    repeatInviteDelaySecondsdefines the delay between a player inviting another player consecutive timesIntmin: -2147483648, max: 2147483647
    inventoryTagsToIncludetags used to filter player inventories, and items that match one or more tags will be includedMap of StringminLength: 0
    enableTransferPartyLeaderwhether to transfer party leader status from one to another when invoking AssignPartyLeaderV1Booleanoptions: true, false
    enableGameServerVersionDefaultif enabled, send the default game server version for clients not in gameServerVersionCompatibility mapBooleanoptions: true, false
    gameServerVersionDefaultdefault game server version for clients not in gameServerVersionCompatibility map. used if enableGameServerVersionDefault is true.StringminLength: 0
    gameServerVersionCompatibilitymap of all the server versions to compatible game client versionsMap of Object of type GameServerVersionCompatibilityGameServerVersionCompatibility

pragma.gateway.SocialPartnerGatewayConfig #

Social Partner gateway configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolprotocol of the host/portStringminLength: 0
    webSocketProtocolprotocol of the WebSocket host/portStringminLength: 0
    authenticateHostauthentication backend hostStringminLength: 0
    authenticatePortauthentication backend portIntmin: 1, max: 65536
    socialHostsocial backend host advertised to clientsStringminLength: 0
    socialPortsocial backend port advertised to clientsIntmin: 1, max: 65536
    socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort)Intmin: 0, max: 65536

pragma.databases.DatabaseIdentifierSchema #

Database identifier to schema

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    identifierthe database connection settings defined in your databaseConfig per unique identifierStringminLength: 0
    schemathe database schema to use for connection settingsStringminLength: 0

pragma.databases.PartitionedDatabaseConfig #

Standard Pragma Engine database connection configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    driverwhich driver to use, default: MYSQLDBEnum DatabaseDriverallowed values: MYSQLDB
    usernameusername to useStringminLength: 1
    passwordpassword to useEncryptedStringminLength: 0
    hikariConnectionTimeoutMillisconnection timeout in millis for Hikari connection pool, default: 20,000msLongmin: -9223372036854775808, max: 9223372036854775807
    hikariMinimumIdleConnectionsminimum number of connections to hold open for Hikari connection pool, default: 0Intmin: -2147483648, max: 2147483647
    hikariConfigMaximumPoolSizemaximum connection pool size for Hikari connection pool, default: 10Intmin: -2147483648, max: 2147483647
    hikariConfigIdleTimeoutMillisidle timeout in millis for Hikari connection pool, default: 300,000msLongmin: -9223372036854775808, max: 9223372036854775807
    dynamicShardingSupportenables virtual nodes and sharding support, default:falseBooleanoptions: true, false
    columnNameOfPropertyToConsistentHashproperty to shard by (ie playerId)StringminLength: 0
    hostPortSchemashost and schemas by indexMap of StringminLength: 0
    identifierSchemasdatabase connection settings for each identifierMap of Object of type DatabaseIdentifierSchemaDatabaseIdentifierSchema

pragma.databases.UnpartitionedDatabaseConfig #

Standard Pragma Engine database connection configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    driverwhich driver to use, default: MYSQLDBEnum DatabaseDriverallowed values: MYSQLDB
    usernameusername to useStringminLength: 1
    passwordpassword to useEncryptedStringminLength: 0
    hikariConnectionTimeoutMillisconnection timeout in millis for Hikari connection pool, default: 20,000msLongmin: -9223372036854775808, max: 9223372036854775807
    hikariMinimumIdleConnectionsminimum number of connections to hold open for Hikari connection pool, default: 0Intmin: -2147483648, max: 2147483647
    hikariConfigMaximumPoolSizemaximum connection pool size for Hikari connection pool, default: 10Intmin: -2147483648, max: 2147483647
    hikariConfigIdleTimeoutMillisidle timeout in millis for Hikari connection pool, default: 300,000msLongmin: -9223372036854775808, max: 9223372036854775807
    dynamicShardingSupportenables virtual nodes and sharding support, default:falseBooleanoptions: true, false
    hostPortSchemaschemaStringminLength: 0
    identifierSchemadatabase connection settings for each identifierObject of type DatabaseIdentifierSchemaDatabaseIdentifierSchema

pragma.inventory.ContentAccessByTagsConfig #

Content filtering configuration on player endpoints by tags.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    hiddenContent filtering configuration on player endpoints by tags.Map of StringminLength: 0

pragma.inventory.InventoryCacheConfig #

Config for inventory data cache.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    maxTimeBetweenAccessMillisIf an entry has not been accessed in this amount of time, it is a candidate for removal in the next eviction sweep.Longmin: -9223372036854775808, max: 9223372036854775807
    sizeBeforeExpirationEnforcedSize of cache before eviction sweeping will start removing entries.Intmin: -2147483648, max: 2147483647
    sweepIntervalMillisInterval, in milliseconds, between sweep calls for the cache.Longmin: -9223372036854775808, max: 9223372036854775807

pragma.matchcapacity.MatchCapacityConfig #

Configuration for Match Capacity.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    floorMinimum number of matches targeted to be started by the capacity service.Intmin: -2147483648, max: 2147483647
    ceilingMaximum number of match capacity managed by the capacity service.Intmin: -2147483648, max: 2147483647
    headroomPercentDesired available capacity defined by % of existing matches.Intmin: -2147483648, max: 2147483647
    serverMaxStartDurationMillisMaximum duration, in milliseconds, a game server can take to start before the allocation is declared failed.Longmin: -9223372036854775808, max: 9223372036854775807
    serverHeartbeatPeriodMillisExpected heartbeat period a game server should report its state.Longmin: -9223372036854775808, max: 9223372036854775807
    serverHeartbeatExpiryFactorNumber, as a float, of heartbeats before a game server is considered timed out.Doublemin: 4.9E-324, max: 1.7976931348623157E308
    gameCapacityResolvedTimeoutMillisMaximum duration, in milliseconds, the platform will wait for capacity to resolve for a game instance before ejecting it.Longmin: -9223372036854775808, max: 9223372036854775807

pragma.databases.SharedDatabaseConfig #

Database identifier config

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    usernameusername to useStringminLength: 1
    passwordpassword to useEncryptedStringminLength: 0
    hosthostStringminLength: 0
    portportIntmin: -2147483648, max: 2147483647

pragma.party.GameServerVersionCompatibility #

clientVersions to serverVersion support configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    serverVersiongame server version string, must not be emptyStringminLength: 0
    clientVersionsgame client versions supported by this server versionMap of StringminLength: 0

Plugin Configurations #

pragma.inventory.SteamEntitlementConfig #

Steam entitlement provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    appConfigSteam app configuration for entitlement processing.Object of type SteamAppConfigSteamAppConfig

demo.account.FakeAuthIdentityProviderPlugin$Config #

Fake Auth Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    identityProviderThe string name of the id provider this is fakingStringminLength: 0

pragma.gateway.FilePortalModulePlugin$Config #

File Portal Router plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    portalSourcepath to portal resource filesStringminLength: 0
    modulesmodules enabled for the portalMap of StringminLength: 0
    defaultModulefirst module loaded when the portal is openedStringminLength: 0
    redirectSignInToSocialcan be used to disable the social sign-in redirectBooleanoptions: true, false

pragma.account.GoogleIdentityProviderPlugin$Config #

Google Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    allowedDomainsA map of domains that are allowed to use Google to authenticate (e.g. pragma.gg)Map of StringminLength: 0
    clientSecretyour app’s secret key (provided by Google)EncryptedStringminLength: 0
    clientIdyour app’s id (provided by Google)StringminLength: 0
    redirectUriyour app’s redirect URI, as defined with GoogleStringminLength: 0

pragma.account.config.OidcIdProviderConfig #

OIDC Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    authorizationUriyour app’s user info urlStringminLength: 0
    tokenUriyour app’s authorization token urlStringminLength: 0
    userInfoUriyour app’s user info urlStringminLength: 0
    clientSecretyour app’s secret keyEncryptedStringminLength: 0
    clientIdyour app’s idStringminLength: 0
    redirectUriyour app’s redirect URIStringminLength: 0
    requireEmailVerificationwhether to require email verification for authorizationBooleanoptions: true, false

pragma.config.EmptyPluginConfig #

Empty plugin config for configless plugins.

  • Configuration Values:
    fielddescriptiontypevalues/constraints

pragma.account.config.UnsafeIdProviderConfig #

Unsafe Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false

pragma.account.config.TwitchIdProviderConfig #

Twitch Id Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    clientSecretyour app’s secret key (provided by Twitch)EncryptedStringminLength: 0
    clientIdyour app’s id (provided by Twitch)StringminLength: 0
    redirectUriyour app’s redirect URI, as defined with TwitchStringminLength: 0

pragma.payment.steam.SteamPaymentConfig #

Steam payment plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    appConfigSteam app config for payment processingObject of type SteamAppConfigSteamAppConfig
    defaultCurrencyCodethe default currency code to use when a player’s configured currency is not configured for a product entry.Enum CurrencyCodeallowed 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.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    loadTestClienttype of client to use for making game launch requests, localhost loadtest only or remote capable [truefalse]Boolean
    capacityPerServeramount of matches a server can run concurrentlyIntmin: -2147483648, max: 2147483647
    matchLaunchertype of match launcher [demo.matchcapacity.LocalMatchLauncherdemo.matchcapacity.GameFlowMatchLauncherString
    partnerConnectionInfoPragma Engine partner connection info for games to report their existenceObject of type PartnerConnectionInfoConfigPartnerConnectionInfoConfig
    clientInitialHeartbeatPeriodMillisheartbeat period used when the server has not yet respondedLongmin: -9223372036854775808, max: 9223372036854775807

pragma.account.config.EmailIdProviderConfig #

Email Id Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    privateKeyan encrypted private key used for encrypting emails in Pragma Engine’s databaseEncryptedStringminLength: 0

pragma.account.config.EpicIdProviderConfig #

Epic Id Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false

pragma.account.SendInBlueEmailSenderPlugin$SendInBlueEmailSenderConfig #

EmailSender plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    providerAPIKeythe API key that will enable you to send emails with your providerEncryptedStringminLength: 0
    apiUrlbase URL for the provider API to interact withStringminLength: 0
    routethe HTTP route for the providerStringminLength: 0
    verificationTemplateIdid of the email template to sendStringminLength: 0
    fromEmailverified email address associated with the account in sendinblue that this email will be sent fromStringminLength: 0
    fromNamename displayedStringminLength: 0

pragma.gateway.PostmanRoutePlugin$Config #

Postman Route Plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    pathToPostmanFilespath to postman filesStringminLength: 0
    collectionNamepath to postman filesStringminLength: 0
    environmentNamepath to postman filesStringminLength: 0

pragma.metrics.StatsdRegistryProvider$Config #

Statsd metrics registry provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    flavorflavor of statsdEnum StatsdFlavorallowed values: ETSY, DATADOG, TELEGRAF, SYSDIG
    hosthost to send statsStringminLength: 0
    portport to send statsIntmin: -2147483648, max: 2147483647
    protocolprotocol to send statsEnum StatsdProtocolallowed values: UDP, UDS_DATAGRAM, TCP
    maxPacketLengthmax packet length to send statsIntmin: -2147483648, max: 2147483647
    pollingFrequencySecondspolling frequency to send statsIntmin: -2147483648, max: 2147483647
    stepSecondsstep size to compute windowed statisticsIntmin: -2147483648, max: 2147483647
    publishUnchangedMeterswhether to publish unchanged metersBooleanoptions: true, false
    bufferedwhether to buffer metrics sentBooleanoptions: true, false

pragma.matchcapacity.MultiplayCapacityProvider$Config #

MultiplayClientNode service configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    capacityPerServeramount of matches a server can run concurrentlyIntmin: -2147483648, max: 2147483647
    regionIdregionId for Multiplay API callsStringminLength: 0
    fleetIdfleetId for Multiplay API callsStringminLength: 0
    profileIdprofileId for Multiplay API callsStringminLength: 0
    projectGuidproject guid for Multiplay API callsStringminLength: 0
    accessKeyClanforge Access Key for signing REST API calls to MultiplayStringminLength: 0
    secretAccessKeyClanforge Secret Access Key for signing REST API calls to MultiplayEncryptedStringminLength: 0
    useAllocateV2feature toggle to enable using Multiplay AllocateV2Booleanoptions: true, false
    pragmaGamePartnerBackendAddresstells the Multiplay game server where the Pragma Game Partner gateway is, and is only used when AllocateV2 is enabledStringminLength: 0
    gameServerZoneToMultiplayRegionIdmap of gameServerZone to Multiplay region idMap of StringminLength: 0

pragma.metrics.DatadogRegistryProvider$Config #

Datadog metrics registry provider configuration

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    apiKeyDatadog API keyEncryptedStringminLength: 0
    applicationKeyDatadog application keyEncryptedStringminLength: 0
    descriptionswhether to send descriptions metadataBooleanoptions: true, false
    hostTaghost tag when shipping metricsStringminLength: 0
    uriURI to ship metrics toStringminLength: 0

demo.account.DemoIdentityProviderPlugin$Config #

Demo Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false

pragma.matchcapacity.PragmaNomadCapacityProvider$Config #

Pragma Engine Nomad match capacity provider configuration.

demo.account.DemoExtIdentityProviderPlugin$Config #

Demo Ext Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false

pragma.account.config.DiscordIdProviderConfig #

Discord Id Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    clientSecretyour app’s secret key (provided by Discord)EncryptedStringminLength: 0
    clientIdyour app’s id (provided by Discord)StringminLength: 0
    guildIdyour guild id, also known as server idStringminLength: 0
    redirectUriyour app’s redirect URI, as defined with DiscordStringminLength: 0
    botTokenbot token associated with your Discord Server’s botEncryptedStringminLength: 0
    allowedRoleIdsset of guild role ids that provide access to Pragma Engine social backendMap of StringminLength: 0

pragma.telemetry.s3.Config #

Configuration for the S3 Telemetry Plugin

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    maxEventsPerBatchmax number of events in a batch, if set to <=0, it will only use the time based bucketingIntmin: 1, max: 2147483647
    timeWindowPerBatchMillisthe period in millis that the batch is sent to S3Intmin: 1, max: 2147483647
    awsAccountIdthe aws account to send the data toStringminLength: 0
    awsRegionthe aws region the s3 bucket is inStringminLength: 0

pragma.matchcapacity.LocalProcessCapacityProvider$Config #

Generic Local Process match capacity provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    processCommandfull command line including parameters run the processMap of StringminLength: 0
    serverIdParamname of the command line param to append with the allocated server idStringminLength: 0
    logPathParamname of the command line param to append with the program log path, and this will result in a file inside logOutputPathStringminLength: 0
    logOutputPathpath to a folder where to redirect log outputStringminLength: 0
    maximumLocalServersmaximum number of local servers this provider can supportIntmin: -2147483648, max: 2147483647
    portParamname of the command line param to append with the allocated host port valueStringminLength: 0
    gameServerZoneParamname of the command line param to append with the game server zoneStringminLength: 0
    minPortminimum value of the game server host portIntmin: -2147483648, max: 2147483647
    maxPortmaximum value of the game server host portIntmin: -2147483648, max: 2147483647

pragma.shared.SteamAppConfig #

Steam application configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    steamWebAPIKeyyour app’s secret web API key (provided by Steam)EncryptedStringminLength: 0
    appIdyour app’s id (provided by Steam)StringminLength: 0
    restrictByAppOwnershipPrevent authentication if the player does not own the app specified by appIdBooleanoptions: true, false
    restrictByAccountBanPrevent authentication if the player is bannedBooleanoptions: true, false

pragma.account.GoogleWorkspaceIdentityProviderPlugin$Config #

Google Workspace Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    allowedDomainsA map of domains that are allowed to use Google to authenticate (e.g. pragma.gg)Map of StringminLength: 0
    clientSecretyour app’s secret key (provided by Google)EncryptedStringminLength: 0
    clientIdyour app’s id (provided by Google)StringminLength: 0
    redirectUriyour app’s redirect URI, as defined with GoogleStringminLength: 0

demo.gameinstance.GameFlowGameInstancePlugin$Config #

GameFlowGameInstancePlugin plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    matchDurationMillisthe duration of game in millisecondsLongmin: -9223372036854775808, max: 9223372036854775807

demo.pragmaconfidential.xbox.XboxIdentityProviderPlugin$Config #

XBox Id Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    relyingPartyCertificateThe base64 encoded RelyingParty certificate.StringminLength: 0
    relyingPartyPrivateKeyThe base64 encoded RelyingParty private key.EncryptedStringminLength: 0
    privateKeyPasswordThe password to decrypt the private key.EncryptedStringminLength: 0

pragma.inventory.EpicEntitlementConfig #

Epic entitlement provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    sandboxIdID of the sandbox to operate on.StringminLength: 0
    deploymentIdID of the corresponding deployment in the Epic Dev Portal.StringminLength: 0
    clientIdID of your client in the Epic Dev Portal.StringminLength: 0
    clientSecretEncrypted string representing your client’s secret in the Epic Dev Portal.EncryptedStringminLength: 0

demo.pragmaconfidential.playstation.PlaystationApiConfig #

Playstation Id Provider configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    redirectUriyour app’s redirect URI, as defined with PlaystationStringminLength: 0
    ps4ClientIdyour app’s id (provided by Playstation)StringminLength: 0
    ps4ClientSecretyour app’s client secret (provided by Playstation)EncryptedStringminLength: 0
    ps5ClientIdyour app’s id (provided by Playstation)StringminLength: 0
    ps5ClientSecretyour app’s client secret (provided by Playstation)EncryptedStringminLength: 0
    environmentThe playstation environment set in the request urlsStringminLength: 0
    ps5EnvironmentHostThe playstation host url per environmentStringminLength: 0

pragma.inventory.TwitchEntitlementConfig #

Twitch Drop entitlement provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    clientIdID of your client in the Twitch Dev PortalStringminLength: 0
    clientSecretSecret of your client in the Twitch Dev PortalEncryptedStringminLength: 0
    gameIdThe game ID associated with the drops to syncStringminLength: 0

pragma.matchmaking.WarmBodyMatchmakingPlugin$Config #

WarmBodyMatchmakingPlugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    numberOfTeamsnumber of teams required for the gameIntmin: 1, max: 2147483647
    playersPerTeamnumber of players required for each teamIntmin: 1, max: 2147483647

pragma.account.GoogleIdentityProviderBase$Config #

Google Identity Provider plugin configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    allowedDomainsA map of domains that are allowed to use Google to authenticate (e.g. pragma.gg)Map of StringminLength: 0
    clientSecretyour app’s secret key (provided by Google)EncryptedStringminLength: 0
    clientIdyour app’s id (provided by Google)StringminLength: 0
    redirectUriyour app’s redirect URI, as defined with GoogleStringminLength: 0

pragma.shared.SteamAppConfig #

Steam application configuration.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    playerLoginEnabledIf this id provider is enabled for player login.Booleanoptions: true, false
    operatorLoginEnabledIf this id provider is enabled for operator login.Booleanoptions: true, false
    accountLinkingEnabledIf this id provider is enabled for account linking.Booleanoptions: true, false
    showPortalLoginButtonIf this id provider is shown in the portal login options.Booleanoptions: true, false
    steamWebAPIKeyyour app’s secret web API key (provided by Steam)EncryptedStringminLength: 0
    appIdyour app’s id (provided by Steam)StringminLength: 0
    restrictByAppOwnershipPrevent authentication if the player does not own the app specified by appIdBooleanoptions: true, false
    restrictByAccountBanPrevent authentication if the player is bannedBooleanoptions: true, false

pragma.matchcapacity.PartnerConnectionInfoConfig #

Connection configuration for Pragma Partner endpoints.

  • Configuration Values:
    fielddescriptiontypevalues/constraints
    protocolPragma Engine partner protocol (http/https)StringminLength: 0
    hostPragma Engine partner host nameStringminLength: 0
    portPragma Engine partner portIntmin: -2147483648, max: 2147483647