Configuration Options #
Core Config #
pragma.config.CoreConfig
#
- Node-wide configuration.
- type:
Objectfield description type values/restrictions clusterNamethe name of this cluster String min: 1 nodeNamethe name of this node, to be used as value in nodeByInstanceId of distributedServices String min: 0 openTelemetryServiceNameservice name for open telemetry tracing String min: 0 logginglogging (logback) configuration Object of type LoggingConfig LoggingConfig sessionsession configuration Object of type SessionConfig SessionConfig portalUrlhostname of the portal String min: 0 enableHistogramMetricsenables histograms for metrics, uses a large number of tags per metric Boolean options: true,falseenableKtorMetricsenables standard ktor metrics for HTTP request Boolean options: true,falsestartupTimeoutMillismaximum milliseconds to wait during startup before forcibly exiting Long min: 0, max: 9223372036854775807 shutdownTimeoutMillismaximum milliseconds to wait during shutdown before forcibly exiting Long min: 0, max: 9223372036854775807 gatewayManagerenabling/disabling gateways Object of type GatewayManagerConfig GatewayManagerConfig distributedServicesmap of services and node they run on Map of DistributedServiceConfig DistributedServiceConfig remoteNodeConfigsmap of remote node names to their host:port Map of RemoteNodeConfig RemoteNodeConfig nettyPendingTasksCheckPeriodMillisdetermines how often to check pending tasks and emit a metric Long min: -9223372036854775808, max: 9223372036854775807 allowWorkInProgressAccessallows access to methods that are works in progress Boolean options: true,falseenableVersionWithBuildSlugadds build slug info to version output Boolean options: true,falseshardIdThe unique uuid of this shard UUIDv4
pragma.config.LoggingConfig
#
- Logback configuration.
- type:
Objectfield description type values/restrictions rootLoggerLevellevel of the root logger Enum LogLevel allowed values: OFF,ERROR,WARN,INFO,DEBUG,TRACE,ALLlogFormatdefault log format String min: 0 consoleLoggerEnabledenable logging to stdout/stderr Boolean options: true,falsefileLoggerEnabledenable logging to file Boolean options: true,falsefileLoggerCurrentFilenamefile name (including path) to use for logs String min: 0 fileLoggerRolledFilenamefile name (including path) to use for rotated logs String min: 0 fileLoggerRolledTotalSizeCapsize cap of all rolled compressed log files String min: 0 loggerslogback log level per logger Map of Enum LogLevel allowed values: OFF,ERROR,WARN,INFO,DEBUG,TRACE,ALLlogLayouttype of layout to log Enum LogLayout allowed values: TEXT,JSON
pragma.session.SessionConfig
#
- Session configuration.
- type:
Objectfield description type values/restrictions httpExpirySecondsexpiry 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:
Objectfield description type values/restrictions playerwhether the player gateway is enabled on this node Boolean options: true,falseoperatorwhether the operator gateway is enabled on this node Boolean options: true,falsepartnerwhether the partner gateway is enabled on this node Boolean options: true,false
pragma.config.DistributedServiceConfig
#
- Distributed services configuration.
- type:
Objectfield description type values/restrictions nodeByInstanceIdmap 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:
Objectfield description type values/restrictions hostthe host that the node is running on String min: 0 portthe port that the remote node is listening on Int min: -2147483648, max: 2147483647
Service Configs #
pragma.gamedata.GameDataServiceConfig
#
- GameDataService configuration.
- type:
Objectfield description type values/restrictions waitForMatchEndEventTimeoutMillistime to wait to aggregate player match end events before sending the partial payload Long min: -9223372036854775808, max: 9223372036854775807 loginDataCollectionTimeouttime to wait to aggregate login data Long min: -9223372036854775808, max: 9223372036854775807
pragma.gateway.SocialPlayerGatewayConfig
#
- Social Player gateway configuration.
- type:
Objectfield description type values/restrictions protocolprotocol of the host/port String min: 0 webSocketProtocolprotocol of the WebSocket host/port String min: 0 authenticateHostauthentication backend host String min: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 loginQueueEnabledfeature toggle for login queue Boolean options: true,falsesocialHostsocial backend host advertised to clients String min: 0 socialPortsocial backend port advertised to clients Int min: 1, max: 65536 socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536
pragma.auth.TokenSignerConfig
#
- Token Signer configuration.
- type:
Objectfield description type values/restrictions partnerExpirationHourslength of time the partner token is valid for (hours) Long min: -9223372036854775808, max: 9223372036854775807 operatorExpirationMinuteslength of time the operator token is valid for (minutes) Long min: -9223372036854775808, max: 9223372036854775807 emailTokenExpirationMinuteslength of time the email validation token is valid for (minutes) Long min: -9223372036854775808, max: 9223372036854775807 playerTokenExpirationMinuteslength of time the player token is valid for (minutes) Double min: 4.9E-324, max: 1.7976931348623157E308 playerTokenRefreshMinutestime before the player token expires that we tell clients to refresh Long min: -9223372036854775808, max: 9223372036854775807 playerTokenRefreshVarianceWindowMinutesvariance in refresh time to smooth the refresh load over time Long min: -9223372036854775808, max: 9223372036854775807 jwtPrivateKeyprivate key used to signed JWTs EncryptedString min: 1
pragma.account.config.GameDaoConfig
#
- GameDaoNodeService configuration.
- type:
Objectfield description type values/restrictions databaseConfigdatabase config for the game dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
demo.echo.EchoServiceConfig
#
- Echo service configuration.
- type:
Objectfield description type values/restrictions
pragma.auth.TokenDecoderConfig
#
- Token validator service configuration.
- type:
Objectfield description type values/restrictions jwtPublicKeyJWT used to validate String min: 1
pragma.inventory.InventoryServiceConfig
#
- Inventory service configuration.
- type:
Objectfield description type values/restrictions enableDeleteAllInventorywhether to allow making a cache/db delete call Boolean options: true,falseenableDeletePlayerInventorywhether to allow players to delete their inventory Boolean options: true,falselegacyItemLoadBehavioron item retrieval do not filter out items with invalid catalogId Boolean options: true,falsecontentAccessByTagscontent filtering on player endpoints by tags Object of type ContentAccessByTagsConfig ContentAccessByTagsConfig inventoryCacheConfigConfig for inventory data cache. Object of type InventoryCacheConfig InventoryCacheConfig
pragma.account.AccountServiceConfig
#
- Account service configuration.
- type:
Objectfield description type values/restrictions gameManagementPollingFrequencyInMillisfrequency with which Account service checks for updated game management data Long min: -9223372036854775808, max: 9223372036854775807 verificationEmailEndpointURL 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:
Objectfield description type values/restrictions databaseConfigdatabase config for the inventory dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.GameOperatorGatewayConfig
#
- Game Operator gateway configuration.
- type:
Objectfield description type values/restrictions protocolprotocol of the host/port String min: 0 webSocketProtocolprotocol of the WebSocket host/port String min: 0 authenticateHostauthentication backend host String min: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 loginQueueEnabledfeature toggle for login queue Boolean options: true,falseloginQueueHostlogin queue host advertised to clients String min: 0 loginQueuePortlogin queue port advertised to clients Int min: 1, max: 65536 socialHostsocial backend host advertised to clients String min: 0 socialPortsocial backend port advertised to clients Int min: 1, max: 65536 socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHostgame backend host advertised to clients String min: 0 gamePortgame backend port advertised to clients Int min: 1, max: 65536 gameBindPortgame backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536 sdkCoreEnabledtemporary feature toggle for Core SDK until it is stable Boolean options: true,false
pragma.account.config.AccountDaoConfig
#
- AccountDaoNode service configuration.
- type:
Objectfield description type values/restrictions databaseConfigdatabase config for the account dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.payment.PaymentDaoConfig
#
- Configuration for the PaymentDaoNodeService
- type:
Objectfield description type values/restrictions databaseConfigthe database config for the payment dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.SocialOperatorGatewayConfig
#
- Social Operator gateway configuration.
- type:
Objectfield description type values/restrictions protocolprotocol of the host/port String min: 0 webSocketProtocolprotocol of the WebSocket host/port String min: 0 authenticateHostauthentication backend host String min: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 loginQueueEnabledfeature toggle for login queue Boolean options: true,falsesocialHostsocial backend host advertised to clients String min: 0 socialPortsocial backend port advertised to clients Int min: 1, max: 65536 socialBindPortsocial 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:
Objectfield description type values/restrictions createMatchTimeoutMilliseconds 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 matchEndTimeoutMilliseconds 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 enableMatchAbsoluteTimeoutEnables the match absolute timeout that will end a match after a specific amount of time has elapsed. Boolean options: true,falsematchAbsoluteTimeoutMillisMilliseconds 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 enableKeepAliveEnables 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,falsekeepAliveIntervalMillisMilliseconds 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 keepAliveMissesLimitNumber of keep alive request misses before ending the match. Will be ignored if enableKeepAlive is false. Long min: -9223372036854775808, max: 9223372036854775807 enableMatchReconnectenables the match reconnect flow Boolean options: true,falsematchReconnectSet 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:
Objectfield description type values/restrictions databaseConfigdatabase config for the game dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.matchcapacity.MatchCapacityServiceConfig
#
- Match Capacity service configuration.
- type:
Objectfield description type values/restrictions matchCapacityConfigvalues 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:
Objectfield description type values/restrictions
pragma.gateway.GamePartnerGatewayConfig
#
- Game Partner gateway configuration.
- type:
Objectfield description type values/restrictions protocolprotocol of the host/port String min: 0 webSocketProtocolprotocol of the WebSocket host/port String min: 0 authenticateHostauthentication backend host String min: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 loginQueueEnabledfeature toggle for login queue Boolean options: true,falseloginQueueHostlogin queue host advertised to clients String min: 0 loginQueuePortlogin queue port advertised to clients Int min: 1, max: 65536 socialHostsocial backend host advertised to clients String min: 0 socialPortsocial backend port advertised to clients Int min: 1, max: 65536 socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHostgame backend host advertised to clients String min: 0 gamePortgame backend port advertised to clients Int min: 1, max: 65536 gameBindPortgame backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536 sdkCoreEnabledtemporary feature toggle for Core SDK until it is stable Boolean options: true,false
pragma.matchmaking.MatchmakingConfig
#
- Matchmaking service configuration.
- type:
Objectfield description type values/restrictions matchmakingDelayMillisdelay between matchmaking runs Long min: -9223372036854775808, max: 9223372036854775807 enableGetMatchmakingInfoenables the player-facing endpoint to retrieve operational info about the matchmaking service Boolean options: true,false
pragma.account.config.UnsafeIdentityDaoConfig
#
- UnsafeIdentityDaoNode service configuration.
- type:
Objectfield description type values/restrictions databaseConfigdatabase config for the unsafe identity provider Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig canAuthenticatecan be used to authenticate players Boolean options: true,falsecanFederatecan 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:
Objectfield description type values/restrictions bearerTokenThe bearer token to use when making partner calls to the social backend EncryptedString min: 0
pragma.payment.PaymentServiceConfig
#
- Configuration for the PaymentService
- type:
Objectfield description type values/restrictions
pragma.gateway.BackendGatewayConfig
#
- Backend gateway configuration.
- type:
Objectfield description type values/restrictions portport utilized for service-to-service communication Int min: -2147483648, max: 2147483647
pragma.gateway.GamePlayerGatewayConfig
#
- Game Player gateway configuration.
- type:
Objectfield description type values/restrictions protocolprotocol of the host/port String min: 0 webSocketProtocolprotocol of the WebSocket host/port String min: 0 authenticateHostauthentication backend host String min: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 loginQueueEnabledfeature toggle for login queue Boolean options: true,falseloginQueueHostlogin queue host advertised to clients String min: 0 loginQueuePortlogin queue port advertised to clients Int min: 1, max: 65536 socialHostsocial backend host advertised to clients String min: 0 socialPortsocial backend port advertised to clients Int min: 1, max: 65536 socialBindPortsocial backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHostgame backend host advertised to clients String min: 0 gamePortgame backend port advertised to clients Int min: 1, max: 65536 gameBindPortgame backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536 sdkCoreEnabledtemporary feature toggle for Core SDK until it is stable Boolean options: true,false
pragma.party.PartyConfig
#
- Party service configuration.
- type:
Objectfield description type values/restrictions maxPlayersPerPartymaximum players allowed in each party Int min: -2147483648, max: 2147483647 disableMaxPlayerCountwhether to disable maximum player count limits in each party Boolean options: true,falseenableLocalGameServerVersionswhether to allow local game clients to override their game server version for local development purposes Boolean options: true,falserepeatInviteDelaySecondsdefines the delay between a player inviting another player consecutive times Int min: -2147483648, max: 2147483647 inventoryTagsToIncludetags used to filter player inventories, and items that match one or more tags will be included Map of String minLength: 0 enableTransferPartyLeaderwhether to transfer party leader status from one to another when invoking AssignPartyLeaderV1 Boolean options: true,false
pragma.gateway.SocialPartnerGatewayConfig
#
- Social Partner gateway configuration.
- type:
Objectfield description type values/restrictions protocolprotocol of the host/port String min: 0 webSocketProtocolprotocol of the WebSocket host/port String min: 0 authenticateHostauthentication backend host String min: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 loginQueueEnabledfeature toggle for login queue Boolean options: true,falsesocialHostsocial backend host advertised to clients String min: 0 socialPortsocial backend port advertised to clients Int min: 1, max: 65536 socialBindPortsocial 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:
Objectfield description type values/restrictions driverwhich driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDBusernameusername to use String min: 1 passwordpassword to use EncryptedString min: 0 hikariConnectionTimeoutMillisconnection timeout in millis for Hikari connection pool, default: 20,000ms Long min: -9223372036854775808, max: 9223372036854775807 hikariMinimumIdleConnectionsminimum number of connections to hold open for Hikari connection pool, default: 0 Int min: -2147483648, max: 2147483647 hikariConfigMaximumPoolSizemaximum connection pool size for Hikari connection pool, default: 10 Int min: -2147483648, max: 2147483647 hikariConfigIdleTimeoutMillisidle timeout in millis for Hikari connection pool, default: 300,000ms Long min: -9223372036854775808, max: 9223372036854775807 dynamicShardingSupportenables virtual nodes and sharding support, default:false Boolean options: true,falsehostPortSchemaschema String min: 0
pragma.inventory.ContentAccessByTagsConfig
#
- Content filtering configuration on player endpoints by tags.
- type:
Objectfield description type values/restrictions hiddencontent filtering configuration on player endpoints by tags. Map of String minLength: 0
pragma.inventory.InventoryCacheConfig
#
- Config for inventory data cache.
- type:
Objectfield description type values/restrictions maxTimeBetweenAccessMillisIf 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 sizeBeforeExpirationEnforcedSize of cache before eviction sweeping will start removing entries. Int min: -2147483648, max: 2147483647 sweepIntervalMillisTime in millis between calling sweep for the cache. Long min: -9223372036854775808, max: 9223372036854775807
pragma.databases.PartitionedDatabaseConfig
#
- Standard Pragma Engine database connection configuration.
- type:
Objectfield description type values/restrictions driverwhich driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDBusernameusername to use String min: 1 passwordpassword to use EncryptedString min: 0 hikariConnectionTimeoutMillisconnection timeout in millis for Hikari connection pool, default: 20,000ms Long min: -9223372036854775808, max: 9223372036854775807 hikariMinimumIdleConnectionsminimum number of connections to hold open for Hikari connection pool, default: 0 Int min: -2147483648, max: 2147483647 hikariConfigMaximumPoolSizemaximum connection pool size for Hikari connection pool, default: 10 Int min: -2147483648, max: 2147483647 hikariConfigIdleTimeoutMillisidle timeout in millis for Hikari connection pool, default: 300,000ms Long min: -9223372036854775808, max: 9223372036854775807 dynamicShardingSupportenables virtual nodes and sharding support, default:false Boolean options: true,falsecolumnNameOfPropertyToConsistentHashproperty to shard by (ie playerId) String min: 0 hostPortSchemasschemas by index Map of String minLength: 0
pragma.matchcapacity.MatchCapacityConfig
#
- Match Capacity service requirement configuration.
- type:
Objectfield description type values/restrictions floorempty system minimum match capacity Int min: -2147483648, max: 2147483647 ceilingabsolute maximum number of matches Int min: -2147483648, max: 2147483647 headroomPercentdesired available capacity defined by % of existing matches Int min: -2147483648, max: 2147483647 serverMaxStartDurationMillismaximum duration, in milliseconds, a game server can take to start before the allocation is declared failed Long min: -9223372036854775808, max: 9223372036854775807 serverHeartbeatPeriodMillisexpected heartbeat period a game server should report its state Long min: -9223372036854775808, max: 9223372036854775807 serverHeartbeatExpiryFactornumber as a float of heartbeats before a game server is considered timed out Double min: 4.9E-324, max: 1.7976931348623157E308 matchReadyTimeoutMillismaximum 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:
Objectfield description type values/restrictions appConfigSteam app config for entitlement processing Object of type SteamAppConfig SteamAppConfig
demo.account.FakeAuthIdentityProviderPlugin$Config
#
- Fake Auth Identity Provider plugin configuration.
- type:
Objectfield description type values/restrictions identityProviderThe 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:
Objectfield description type values/restrictions portalSourcepath to portal resource files String min: 0 modulesmodules enabled for the portal Map of String minLength: 0 defaultModulefirst module loaded when the portal is opened String min: 0 discordClientIdclient id for Discord authentication String min: 0 googleClientIdclient id for Google authentication String min: 0 twitchClientIdclient id for Twitch authentication String min: 0 authenticationIdProvidersid providers enabled for portal login Map of Enum IdProvider allowed values: UNUSED,UNSAFE,EPIC,DISCORD,STEAM,EMAIL,GOOGLE,PLAYSTATION,TWITCH,CUSTOM,UNRECOGNIZEDredirectSignInToSocialcan be used to disable the social sign-in redirect Boolean options: true,false
pragma.gateway.ResourcePortalModulePlugin$Config
#
- Resource Portal Router plugin configuration
- type:
Objectfield description type values/restrictions basePackageresource package for portal files String min: 0 modulesmodules enabled for the portal Map of String minLength: 0 defaultModulefirst module loaded when the portal is opened String min: 0 discordClientIdclient id for Discord authentication String min: 0 authenticationIdProvidersid providers enabled for portal login Map of Enum IdProvider allowed values: UNUSED,UNSAFE,EPIC,DISCORD,STEAM,EMAIL,GOOGLE,PLAYSTATION,TWITCH,CUSTOM,UNRECOGNIZEDredirectSignInToSocialcan be used to disable the social sign-in redirect Boolean options: true,false
pragma.matchmaking.FreeForAllWarmBodyMatchmakingStrategy$Config
#
- FreeForAllWarmBodyMatchmakingStrategy configuration.
- type:
Objectfield description type values/restrictions numberOfPlayersnumber of players in the FFA match Int min: 1, max: 2147483647
pragma.config.EmptyPluginConfig
#
- Empty plugin config for configless plugins.
- type:
Objectfield description type values/restrictions
pragma.account.config.TwitchIdProviderConfig
#
- Twitch Id Provider configuration.
- type:
Objectfield description type values/restrictions clientSecretyour app’s secret key (provided by Twitch) EncryptedString min: 0 clientIdyour app’s id (provided by Twitch) String min: 0 redirectUriyour app’s redirect URI, as defined with Twitch String min: 0
pragma.payment.steam.SteamPaymentConfig
#
- Steam payment plugin configuration.
- type:
Objectfield description type values/restrictions appConfigSteam app config for payment processing Object of type SteamAppConfig SteamAppConfig defaultCurrencyCodethe 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:
Objectfield description type values/restrictions loadTestClienttype of client to use for making game launch requests, localhost loadtest only or remote capable [true false] Boolean capacityPerServeramount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 startProcessCommandStrategyClass.JvmName of the start process command implementation class String min: 0 matchLaunchertype of match launcher [demo.matchcapacity.LocalMatchLauncher demo.matchcapacity.ForkProcessMatchLauncher String partnerConnectionInfoPragma Engine partner connection info for games to report their existence Object of type PartnerConnectionInfoConfig PartnerConnectionInfoConfig clientInitialHeartbeatPeriodMillisheartbeat 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:
Objectfield description type values/restrictions gameServerVersionhardcoded game server version to return, default value: GameServerVersion1 String min: 0
pragma.account.config.EmailIdProviderConfig
#
- Email Id Provider configuration.
- type:
Objectfield description type values/restrictions privateKeyan encrypted private key used for encrypting emails in Pragma Engine’s database EncryptedString min: 0
pragma.account.SendInBlueEmailSenderPlugin$SendInBlueEmailSenderConfig
#
- EmailSender plugin configuration.
- type:
Objectfield description type values/restrictions providerAPIKeythe API key that will enable you to send emails with your provider EncryptedString min: 0 apiUrlbase URL for the provider API to interact with String min: 0 routethe HTTP route for the provider String min: 0 verificationTemplateIdid of the email template to send String min: 0 fromEmailverified email address associated with the account in sendinblue that this email will be sent from String min: 0 fromNamename displayed String min: 0
pragma.metrics.StatsdRegistryProvider$Config
#
- Statsd metrics registry provider configuration.
- type:
Objectfield description type values/restrictions flavorflavor of statsd Enum StatsdFlavor allowed values: ETSY,DATADOG,TELEGRAF,SYSDIGhosthost to send stats String min: 0 portport to send stats Int min: -2147483648, max: 2147483647 protocolprotocol to send stats Enum StatsdProtocol allowed values: UDP,TCPmaxPacketLengthmax packet length to send stats Int min: -2147483648, max: 2147483647 pollingFrequencySecondspolling frequency to send stats Int min: -2147483648, max: 2147483647 stepSecondsstep size to compute windowed statistics Int min: -2147483648, max: 2147483647 publishUnchangedMeterswhether to publish unchanged meters Boolean options: true,falsebufferedwhether to buffer metrics sent Boolean options: true,false
pragma.matchcapacity.MultiplayCapacityProvider$Config
#
- MultiplayClientNode service configuration.
- type:
Objectfield description type values/restrictions capacityPerServeramount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 regionIdregionId for Multiplay API calls String min: 0 fleetIdfleetId for Multiplay API calls String min: 0 profileIdprofileId for Multiplay API calls String min: 0 projectGuidproject guid for Multiplay API calls String min: 0 accessKeyClanforge Access Key for signing REST API calls to Multiplay String min: 0 secretAccessKeyClanforge Secret Access Key for signing REST API calls to Multiplay EncryptedString min: 0 useAllocateV2feature toggle to enable using Multiplay AllocateV2 Boolean options: true,falsepragmaGamePartnerBackendAddresstells the Multiplay game server where the Pragma Game Partner gateway is, and is only used when AllocateV2 is enabled String min: 0 gameServerZoneToMultiplayRegionIdmap of gameServerZone to Multiplay region id Map of String minLength: 0
pragma.matchmaking.CooperativeWarmBodyMatchmakingStrategy$Config
#
- CooperativeWarmBodyMatchmakingStrategy configuration.
- type:
Objectfield description type values/restrictions numberOfPlayersnumber of players in the cooperative match Int min: 1, max: 2147483647
pragma.metrics.DatadogRegistryProvider$Config
#
- Datadog metrics registry provider configuration
- type:
Objectfield description type values/restrictions apiKeyDatadog API key EncryptedString min: 0 applicationKeyDatadog application key EncryptedString min: 0 descriptionswhether to send descriptions metadata Boolean options: true,falsehostTaghost tag when shipping metrics String min: 0 uriURI to ship metrics to String min: 0
pragma.inventory.TwitchDropsEntitlementConfig
#
- Twitch Drop entitlement provider plugin configuration.
- type:
Objectfield description type values/restrictions clientIdID of your client in the Twitch Dev Portal String min: 0 clientSecretSecret of your client in the Twitch Dev Portal EncryptedString min: 0 gameIdThe game ID associated with the drops to sync String min: 0
pragma.matchcapacity.PragmaNomadCapacityProvider$Config
#
- Pragma Engine Nomad match capacity provider configuration.
- type:
Objectfield description type values/restrictions urlfull URL (including protocol and port) to reach the Nomad API URL capacityPerServeramount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 executableNamename of the executable such as ‘gameServer.sh’ String min: 0 argscommand line args to pass to the start game server script, and chains together map values, ordered by key Map of String minLength: 0 jobCpuAmount 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 jobDatacenterNomad Datacenter to allocate new task instance. See https://developer.hashicorp.com/nomad/api-docs/json-jobs#datacenters String min: 0 jobMemoryAmount 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:
Objectfield description type values/restrictions clientSecretyour app’s secret key (provided by Discord) EncryptedString min: 0 clientIdyour app’s id (provided by Discord) String min: 0 guildIdyour guild id, also known as server id String min: 0 redirectUriyour app’s redirect URI, as defined with Discord String min: 0 botTokenbot token associated with your Discord Server’s bot EncryptedString min: 0 authorizedRoleIdsset of guild role ids that provide access to Pragma Engine social backend Map of String minLength: 0
pragma.shared.SteamAppConfig
#
- Steam application configuration.
- type:
Objectfield description type values/restrictions steamWebAPIKeyyour app’s secret web API key (provided by Steam) EncryptedString min: 0 appIdyour app’s id (provided by Steam) String min: 0
pragma.matchcapacity.LocalProcessCapacityProvider$Config
#
- Generic Local Process match capacity provider configuration.
- type:
Objectfield description type values/restrictions processCommandfull command line including parameters run the process Map of String minLength: 0 serverIdParamname of the command line param to append with the allocated server id String min: 0 logPathParamname of the command line param to append with the program log path, and this will result in a file inside logOutputPath String min: 0 logOutputPathpath to a folder where to redirect log output String min: 0 maximumLocalServersmaximum number of local servers this provider can support Int min: -2147483648, max: 2147483647 portParamname of the command line param to append with the allocated host port value String min: 0 gameServerZoneParamname of the command line param to append with the game server zone String min: 0 minPortminimum value of the game server host port Int min: -2147483648, max: 2147483647 maxPortmaximum value of the game server host port Int min: -2147483648, max: 2147483647
pragma.party.OrderedGameServerCompatibilityPlugin$Config
#
- OrderedGameServerCompatibility plugin configuration.
- type:
Objectfield description type values/restrictions versionCompatibilitymap of all the server versions to compatible game client versions Map of VersionCompatibility VersionCompatibility
pragma.inventory.EpicEntitlementConfig
#
- Epic entitlement provider plugin configuration.
- type:
Objectfield description type values/restrictions sandboxIdID of the sandbox to operate on String min: 0 deploymentIdID of the corresponding deployment in the Epic Dev Portal String min: 0 clientIdID of your client in the Epic Dev Portal String min: 0 clientSecretSecret of your client in the Epic Dev Portal EncryptedString min: 0
demo.matchlifecycle.GameFlowMatchFoundPlugin$Config
#
- GameFlowMatchFoundPlugin plugin configuration.
- type:
Objectfield description type values/restrictions matchDurationMillisthe duration of match in milliseconds Long min: -9223372036854775808, max: 9223372036854775807
pragma.matchmaking.WarmBodyMatchmakingPlugin$Config
#
- WarmBodyMatchmakingPlugin configuration.
- type:
Objectfield description type values/restrictions numberOfTeamsnumber of teams required for the match Int min: 1, max: 2147483647 playersPerTeamnumber of players required for each team Int min: 1, max: 2147483647
pragma.shared.SteamAppConfig
#
- Steam application configuration.
- type:
Objectfield description type values/restrictions steamWebAPIKeyyour app’s secret web API key (provided by Steam) EncryptedString min: 0 appIdyour app’s id (provided by Steam) String min: 0
pragma.matchcapacity.PartnerConnectionInfoConfig
#
- Connection configuration for Pragma Partner endpoints.
- type:
Objectfield description type values/restrictions gameTokenauthentication token to the Pragma Engine Game platform EncryptedString min: 0 socialTokenauthentication token to the Pragma Engine Social platform EncryptedString min: 0 protocolPragma Engine partner protocol (http/https) String min: 0 hostPragma Engine partner host name String min: 0 portPragma Engine partner port Int min: -2147483648, max: 2147483647
pragma.party.VersionCompatibility
#
- clientVersions to serverVersion support configuration.
- type:
Objectfield description type values/restrictions serverVersiongame server version string, must not be empty String min: 0 clientVersionsgame client versions supported by this server version Map of String minLength: 0
%22/%3E%3Cpath%20d=%22M82%20113.698c1.821%201.063%201.834%202.78.0%203.843l-13.084%207.687a7.17%207.17.0%2001-3.284.798%207.17%207.17.0%2001-3.284-.798l-13.16-7.687c-1.821-1.063-1.834-2.78.0-3.843l13.084-7.687a7.168%207.168.0%20016.568.0L82%20113.698z%22%20fill=%22url(%23b)%22/%3E%3Cpath%20d=%22M73.16%20114.658a.985.985.0%2001.487.368%201.037%201.037.0%20010%201.186.981.981.0%2001-.486.369l-6.383%203.846a3.438%203.438.0%2001-3.198.0l-6.42-3.846a.982.982.0%2001-.486-.369%201.035%201.035.0%20010-1.186.986.986.0%2001.486-.368l6.383-3.846a3.438%203.438.0%20013.198.0l6.42%203.846z%22%20fill=%22%23fff%22/%3E%3Cpath%20d=%22M111%2048c-1.455-.642-37.943-12.532-45.55-14.5-7.607%202.022-43.495%2016.358-44.95%2017l37.504%2065.718c.106.239.291.435.524.556l5.542%203.209a3.038%203.038.0%20002.76.0l5.51-3.209c.25-.123.441-.338.535-.599L111%2048z%22%20fill=%22url(%23c)%22/%3E%3Cpath%20fill-rule=%22evenodd%22%20clip-rule=%22evenodd%22%20d=%22M109.533%2040.686c-6.925%203.665-17.69%203.562-24.4-.311-6.892-3.98-6.892-10.431.0-14.41%201.422-.822%203.026-1.473%204.737-1.955-17.595-6.637-41.42-5.496-56.87%203.424-17.72%2010.23-17.72%2026.815.0%2037.044%2017.719%2010.23%2046.447%2010.23%2064.167.0%2011.194-6.462%2015.316-15.461%2012.366-23.792z%22%20fill=%22url(%23d)%22/%3E%3Cg%20opacity=%22.7%22%20filter=%22url(%23e)%22%3E%3Ccircle%20r=%2237.046%22%20transform=%22scale(1.22477%20.70706)%20rotate(45%20-55.303%2098.057)%22%20fill=%22url(%23f)%22/%3E%3C/g%3E%3Cpath%20fill-rule=%22evenodd%22%20clip-rule=%22evenodd%22%20d=%22M96.321%2027.615a8.615%208.615.0%2001-2.019-.824c-2.848-1.644-2.848-4.31.0-5.954%201.296-.748%202.958-1.156%204.653-1.223a41.764%2041.764.0%2000-1.788-1.092c-17.72-10.23-46.448-10.23-64.168.0-17.72%2010.23-17.72%2026.814.0%2037.044s46.448%2010.23%2064.168.0c8.025-4.633%2012.416-10.57%2013.172-16.63-4.598%201.417-10.442%201.007-14.318-1.23-4.746-2.74-4.746-7.183.0-9.923.099-.057.199-.113.3-.168zm9.666-1.923a2.064%202.064.0%2001-.068.076l.139.01c-.023-.03-.047-.058-.071-.086z%22%20fill=%22url(%23g)%22/%3E%3Ccircle%20r=%222%22%20transform=%22matrix(.86604%20.49997%20-.86604%20.49997%2062.464%2051)%22%20fill=%22%23121212%22/%3E%3Ccircle%20r=%222%22%20transform=%22matrix(.86604%20.49997%20-.86604%20.49997%2081.464%2045)%22%20fill=%22%23121212%22/%3E%3Ccircle%20r=%222%22%20transform=%22matrix(.86604%20.49997%20-.86604%20.49997%2043.642%2031)%22%20fill=%22%23121212%22/%3E%3Ccircle%20r=%222%22%20transform=%22matrix(.86604%20.49997%20-.86604%20.49997%2039.464%2045)%22%20fill=%22%23121212%22/%3E%3Ccircle%20r=%222%22%20transform=%22scale(1.22477%20.70706)%20rotate(45%20-12.95%2084.623)%22%20fill=%22%23121212%22/%3E%3Ccircle%20r=%222%22%20transform=%22matrix(.86604%20.49997%20-.86604%20.49997%2062.464%2035)%22%20fill=%22%23121212%22/%3E%3Cdefs%3E%3ClinearGradient%20id=%22a%22%20x1=%2265.415%22%20y1=%22133.384%22%20x2=%2262.707%22%20y2=%22116.141%22%20gradientUnits=%22userSpaceOnUse%22%3E%3Cstop%20stop-color=%22%23bebebe%22/%3E%3Cstop%20offset=%221%22%20stop-color=%22%23fff%22/%3E%3C/linearGradient%3E%3ClinearGradient%20id=%22b%22%20x1=%2265.415%22%20y1=%22126.531%22%20x2=%2257.672%22%20y2=%22104.287%22%20gradientUnits=%22userSpaceOnUse%22%3E%3Cstop%20stop-color=%22%23bebebe%22/%3E%3Cstop%20offset=%221%22%20stop-color=%22%23fff%22/%3E%3C/linearGradient%3E%3ClinearGradient%20id=%22c%22%20x1=%2265.409%22%20y1=%22107.427%22%20x2=%2265.409%22%20y2=%2274.173%22%20gradientUnits=%22userSpaceOnUse%22%3E%3Cstop%20stop-color=%22%23fff%22%20stop-opacity=%22.72%22/%3E%3Cstop%20offset=%221%22%20stop-color=%22%23fff%22%20stop-opacity=%220%22/%3E%3C/linearGradient%3E%3ClinearGradient%20id=%22d%22%20x1=%2265.007%22%20y1=%2270.496%22%20x2=%2261.493%22%20y2=%22.477%22%20gradientUnits=%22userSpaceOnUse%22%3E%3Cstop%20stop-color=%22%23edf2f9%22/%3E%3Cstop%20offset=%221%22%20stop-color=%22%23fff%22%20stop-opacity=%220%22/%3E%3C/linearGradient%3E%3ClinearGradient%20id=%22f%22%20x1=%2270.425%22%20y1=%2221.274%22%20x2=%22-.284%22%20y2=%2248.41%22%20gradientUnits=%22userSpaceOnUse%22%3E%3Cstop%20stop-color=%22%231efff1%22/%3E%3Cstop%20offset=%221%22%20stop-color=%22%231548ff%22/%3E%3C/linearGradient%3E%3ClinearGradient%20id=%22g%22%20x1=%2220.05%22%20y1=%2263.78%22%20x2=%2255.07%22%20y2=%22-9.969%22%20gradientUnits=%22userSpaceOnUse%22%3E%3Cstop%20offset=%22.156%22%20stop-color=%22%231efff1%22/%3E%3Cstop%20offset=%221%22%20stop-color=%22%231548ff%22/%3E%3C/linearGradient%3E%3Cfilter%20id=%22e%22%20x=%224.71%22%20y=%226.763%22%20width=%22120.747%22%20height=%2282.388%22%20filterUnits=%22userSpaceOnUse%22%20color-interpolation-filters=%22sRGB%22%3E%3CfeFlood%20flood-opacity=%220%22%20result=%22BackgroundImageFix%22/%3E%3CfeBlend%20in=%22SourceGraphic%22%20in2=%22BackgroundImageFix%22%20result=%22shape%22/%3E%3CfeGaussianBlur%20stdDeviation=%227.5%22%20result=%22effect1_foregroundBlur%22/%3E%3C/filter%3E%3C/defs%3E%3C/svg%3E)