Configuration Options #
Core Configurations #
pragma.config.CoreConfig #
Node-Wide Configuration
- Configuration Values:
field description type values/constraints clusterNameThe name of the cluster. String minLength: 1 nodeNameThe name of the node, to be used in nodeByInstanceId of distributedServices. String minLength: 0 loggingLogback configuration options. Object of type LoggingConfig LoggingConfig portalUrlHostname of the operator Pragma portal web interface. String minLength: 0 enableHistogramMetricsEnables histograms for metrics. This uses a large number of tags per metric. Boolean options: true,falseenableKtorMetricsEnables standard KTOR metrics for HTTP requests. Boolean options: true,falsemetricsDistributionExpiryDurationSecondsThe expiration duration for DistributionStatistics. See https://docs.micrometer.io/micrometer/reference/concepts/distribution-summaries.html for more information. Long min: -9223372036854775808, max: 9223372036854775807 startupTimeoutMillisThe maximum time in milliseconds to wait during startup before forcibly exiting. Long min: 0, max: 9223372036854775807 shutdownTimeoutMillisThe maximum time milliseconds to wait during shutdown before forcibly exiting. Long min: 0, max: 9223372036854775807 distributedServicesMap of services running on each node. Map of Object of type DistributedServiceConfig DistributedServiceConfig remoteNodeConfigsMap object referencing all remote nodes to their host:port. Map of Object of type RemoteNodeConfig RemoteNodeConfig nettyPendingTasksCheckPeriodMillisHow 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 a build slug to the version output. Boolean options: true,falseshardIdThe unique uuid of this shard. UUIDv4 serviceRpcTimeoutMillisThe maximum time in milliseconds to wait for a service to service RPC before terminating the request. Long min: 1, max: 9223372036854775807
pragma.config.LoggingConfig #
Logback configuration.
- Configuration Values:
field description type values/constraints rootLoggerLevellevel of the root logger Enum LogLevel allowed values: OFF,ERROR,WARN,INFO,DEBUG,TRACE,ALLlogFormatdefault log format String minLength: 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 minLength: 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.config.DistributedServiceConfig #
Distributed services configuration.
- Configuration Values:
field description type values/constraints 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.
- Configuration Values:
field description type values/constraints hostthe host that the node is running on String minLength: 0 portthe port that the remote node is listening on Int min: -2147483648, max: 2147483647
Service Configurations #
pragma.playerdata.PlayerDataDaoConfig #
PlayerDataDaoConfig configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the inventory dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gamedata.GameDataServiceConfig #
GameDataService configuration.
- Configuration Values:
field description type values/constraints loginDataCollectionTimeoutTime, in milliseconds, to wait to aggregate login data Long min: -9223372036854775808, max: 9223372036854775807
pragma.account.config.GameDaoConfig #
GameDaoNodeService configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the game dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.thirdparty.ThirdPartyNodeService$ThirdPartyConfig #
- Configuration Values:
field description type values/constraints
pragma.inventory.InventoryServiceConfig #
Inventory service configuration.
- Configuration Values:
field description type values/constraints enableDeleteAllInventoryDetermines whether to allow making a cache/db delete call. Boolean options: true,falseenableDeletePlayerInventoryDetermines whether to allow players to delete their inventory. Boolean options: true,falselegacyItemLoadBehaviorIf true, do not filter out items with invalid catalogId when retrieving items. Boolean options: true,falsecontentAccessByTagsContent filtering on player endpoints by tags. Object of type ContentAccessByTagsConfig ContentAccessByTagsConfig loadInventoryContentOnStartif true will read all the inventory content files on startup. Boolean options: true,falseinventoryCacheConfigConfig for inventory data cache. Object of type EvictingCacheConfig EvictingCacheConfig
pragma.order.config.OrderDaoConfig #
OrderDaoNodeService service configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the order dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.multiplayer.MultiplayerConfig #
Multiplayer routing service configuration.
- Configuration Values:
field description type values/constraints
pragma.order.FulfillmentService$FulfillmentServiceConfig #
Fulfillment service configuration.
- Configuration Values:
field description type values/constraints
pragma.loginqueue.LoginQueueServiceConfig #
Factory for login queue behavior, driven by a feature toggle
- Configuration Values:
field description type values/constraints targetCcuLimitthe target maximum number of concurrent users logged in Int min: 0, max: 2147483647 targetLoginRatePerSecondthe target number of users to log in per second Int min: 0, max: 2147483647 estimatedSecondsToLoginthe time between a user login request and the user gaining access Int min: 0, max: 2147483647 maxCheckTicketPollTimeSecondsthe maximum allowed poll duration before the sdk should check their ticket Long min: -9223372036854775808, max: 9223372036854775807
pragma.inventory.InventoryDaoConfig #
InventoryDaoConfig configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the inventory dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gameinstance.GameInstanceServiceConfig #
Game instance service configuration.
- Configuration Values:
field description type values/constraints gameServerAllocationTimeoutMillisTime, in milliseconds, to wait for a game server to send a get game start data request before marking it as failed. Long min: -9223372036854775808, max: 9223372036854775807 connectPlayersTimeoutMillisTime, in milliseconds, to wait for a game server to send a connect players request before releasing the players attached to the game instance. Long min: -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. Boolean options: true,falsekeepAliveIntervalMillisInterval, in 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 keepAliveMissesLimitNumber of keep alive request misses before releasing the game instance from the service. Will be ignored if enableKeepAlive is false. Long min: -9223372036854775808, max: 9223372036854775807 assessTimeoutsIntervalSecondsInterval, in seconds, between checking for expiration of timeouts on the service. Long min: -9223372036854775808, max: 9223372036854775807 removePlayersOnDisconnectWhether to remove players from the game instance when they disconnect, preventing them from reconnecting. Boolean options: true,falseenableExtraCreateGameInstanceTimersEnables some additional timing metrics to diagnose performance issues within the CreateGameInstanceV1 endpoint Boolean options: true,falseenableStaleGameInstanceExpirationEnables the termination of a game instance that have lived for a long time. This is to ensure we do not leak game instances in the worst case. Boolean options: true,falsestaleGameInstanceExpirationMinutesTime, in minutes, to wait before terminating a game instance. Will be ignored if enableStaleGameInstanceExpiration is false. Long min: -9223372036854775808, max: 9223372036854775807
pragma.fleet.FleetServiceConfig #
Fleet service configuration.
- Configuration Values:
field description type values/constraints serverPoolManagementPoliciesConfiguration for each server pool policy. Map of Object of type ServerPoolManagementPolicyConfig ServerPoolManagementPolicyConfig
pragma.session.SessionCache$DefaultGatewayConfig #
Default values before init
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647
pragma.account.config.AccountDaoConfig #
AccountDaoNode service configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the account dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.payment.PaymentDaoConfig #
Configuration for the PaymentDaoNodeService
- Configuration Values:
field description type values/constraints databaseConfigthe database config for the payment dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.SocialOperatorGatewayConfig #
Social Operator gateway configuration.
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647 socialHostsocial backend host advertised to clients String minLength: 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.telemetry.db.TelemetryDaoConfig #
DbTelemetryDao configuration.
- Configuration Values:
field description type values/constraints databaseConfigDatabase configuration for the game dao. Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.gateway.GamePartnerGatewayConfig #
Game Partner gateway configuration.
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647 socialHostsocial backend host advertised to clients String minLength: 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 minLength: 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
pragma.matchmaking.MatchmakingConfig #
Matchmaking service configuration.
- Configuration Values:
field description type values/constraints matchmakingDelayMillisDelay, in milliseconds, between matchmaking runs. Long min: -9223372036854775808, max: 9223372036854775807 enableGetMatchmakingInfoEnables the player-facing endpoint to retrieve operational info about the matchmaking service. Boolean options: true,falseenableExtraEnterMatchmakingTimersEnables some additional timing metrics to diagnose performance issues within the EnterMatchmakingV2 endpoint Boolean options: true,false
pragma.account.config.UnsafeIdentityDaoConfig #
UnsafeIdentityDaoNode service configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the unsafe identity provider Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.datarights.config.DataRightsDaoConfig #
DataRightsDaoNode service configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the data rights dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.datarights.DataRightsServiceConfig #
Data rights configuration.
- Configuration Values:
field description type values/constraints includeGameDataReportsWhether or not to include game data reports in the data rights data package. By default, only account data will be included. Boolean options: true,falsewaitingPeriodInDaysWaiting period delays before performing certain data rights actions. Object of type DataRightsWaitingPeriodConfig DataRightsWaitingPeriodConfig downloadLinkLifespanInDaysNumber of days beyond the waiting period the player has access to their personal data package before the link expires. Will always be at least downloadLinkLifespanInDays. Int min: 0, max: 2147483647 downloadEndpointEndpoint used by players to download their personal data package. String minLength: 0
pragma.gameshardcache.GameShardCacheConfig #
- Configuration Values:
field description type values/constraints cacheRefreshSecondsThe frequency at which the GameShardCacheNodeService updates the game shard information. Long min: 1, max: 9223372036854775807
pragma.databases.SharedDatabaseConfigServiceConfig #
Configuration lookup for all database connections
- Configuration Values:
field description type values/constraints databaseConfigsByIdentifiermap of database connections Map of Object of type SharedDatabaseConfig SharedDatabaseConfig
pragma.friend.dao.FriendDaoConfig #
FriendDaoConfig configuration.
- Configuration Values:
field description type values/constraints databaseConfigdatabase config for the friend dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.SocialPartnerGatewayConfig #
Social Partner gateway configuration.
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647 socialHostsocial backend host advertised to clients String minLength: 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.datarights.DataRightsPollingServiceConfig #
- Configuration Values:
field description type values/constraints enabledEnables the DataRightsPollingService for collecting game data for data rights requests Boolean options: true,falsecheckRequestsFrequencyInMinutesHow frequently the DataRightsPollingService should check for new data rights game requests. Int min: 1, max: 2147483647
pragma.gateway.SocialPlayerGatewayConfig #
Social Player gateway configuration.
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647 socialHostsocial backend host advertised to clients String minLength: 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 devLoginQueueBypassEnable to bypass login queue token validation during player authentication or creation. Boolean options: true,false
pragma.order.config.OrderServiceConfig #
Order Service configuration.
- Configuration Values:
field description type values/constraints
pragma.client.SocialBackendPartnerClientConfig #
Partner client configuration used to communicate with a Pragma Social backend from a Game backend.
- Configuration Values:
field description type values/constraints bearerTokenThe bearer token to use when making partner calls to the social backend EncryptedString minLength: 0 socialPartnerProtocolThe protocol to use for making social partner calls String minLength: 0 socialPartnerHostThe host to use for making social partner calls String minLength: 0 socialPartnerPortThe port to use for making social partner calls Int min: -2147483648, max: 2147483647
pragma.account.AccountServiceConfig #
Account service configuration.
- Configuration Values:
field description type values/constraints 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 minLength: 0 blockSessionOnBanWhen a ban is added to an account, does the account’s game and social sessions get removed. Boolean options: true,false
pragma.session.SocialPlayerSessionConfig #
config for social player sessions
- Configuration Values:
field description type values/constraints missingHeartbeatTimeoutMillisamount of time the session service will wait for a heartbeat before expiring the session Long min: -9223372036854775808, max: 9223372036854775807 notifyAllActiveSessionsBatchSizeNumber of notifications per gateway sent in a batch by notifyLocalActiveSessions every notifyAllBatchIntervalMillis. Int min: 1, max: 2147483647 notifyAllActiveSessionsBatchIntervalMillisTime in millis between sending each batch of notifications for notifyLocalActiveSession. Long min: -9223372036854775808, max: 9223372036854775807
pragma.gateway.GameOperatorGatewayConfig #
Game Operator gateway configuration.
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647 socialHostsocial backend host advertised to clients String minLength: 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 minLength: 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
pragma.friend.FriendServiceConfig #
Friend service configuration.
- Configuration Values:
field description type values/constraints maxFriendListSizeMaximum size of friends list for a player. Default value: 400. Int min: -2147483648, max: 2147483647 maxPendingSentInvitesMaximum size of pending sent invites for a player. Default value: 20. Int min: -2147483648, max: 2147483647 maxPendingReceivedInvitesLimit on the amount of friend invites a player can receive. Default value: 20 Int min: -2147483648, max: 2147483647 enablePresenceUpdatesWhether or not to ignore any changes to a player’s presence. Presence clearing through logging out will still be in effect and still send notifications. Boolean options: true,falsefriendListCacheConfigConfiguration of caching behavior for the friend service database. Object of type EvictingCacheConfig EvictingCacheConfig presenceCacheConfigConfiguration of caching behavior for transient presence data. Object of type EvictingCacheConfig EvictingCacheConfig identityCacheConfigConfiguration for caching player identity data retrieved from the account service. Object of type EvictingCacheConfig EvictingCacheConfig enableIntegrationTestDeleteFriendDataWhether the integration test only endpoint to delete a user’s friend data is enabled. If not enabled, the endpoint will not work. This config option and endpoint will be deleted when DataRightsRpc fully supports account deletion. Boolean options: true,false
pragma.playerdata.PlayerDataServiceConfig #
Configuration for the PlayerData Service
- Configuration Values:
field description type values/constraints enableDeleteAllPlayerDataDetermines whether to allow making a cache/db delete operator call. Boolean options: true,falsecacheConfigconfig for the player data cache Object of type EvictingCacheConfig EvictingCacheConfig
pragma.auth.TokenConfig #
Token validator service configuration.
- Configuration Values:
field description type values/constraints jwtCurrentKeysThe public and private keys used to validate and sign JWTs Object of type KeyPairConfig KeyPairConfig jwtRotatedPublicKeysAdditional public keys used to validate JWTs Map of String minLength: 1 playerTokenExpirationMinuteslength of time the player token is valid for (minutes) Double min: -1.7976931348623157E308, 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 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
pragma.telemetry.TelemetryServiceConfig #
The Telemetry service collects events and forwards them to a configured data store.
- Configuration Values:
field description type values/constraints
pragma.payment.PaymentServiceConfig #
Configuration for the PaymentService
- Configuration Values:
field description type values/constraints
pragma.gateway.BackendGatewayConfig #
Backend gateway configuration.
- Configuration Values:
field description type values/constraints portport utilized for service-to-service communication Int min: -2147483648, max: 2147483647
pragma.order.FulfillmentDaoNodeService$FulfillmentDaoConfig #
Configuration for the FulfillmentDaoNodeService
- Configuration Values:
field description type values/constraints databaseConfigthe database config for the fulfillment dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.session.GamePlayerSessionConfig #
config for game player sessions
- Configuration Values:
field description type values/constraints missingHeartbeatTimeoutMillisamount of time the session service will wait for a heartbeat before expiring the session Long min: -9223372036854775808, max: 9223372036854775807 notifyAllActiveSessionsBatchSizeNumber of notifications per gateway sent in a batch by notifyLocalActiveSessions every notifyAllBatchIntervalMillis. Int min: 1, max: 2147483647 notifyAllActiveSessionsBatchIntervalMillisTime in millis between sending each batch of notifications for notifyLocalActiveSession. Long min: -9223372036854775808, max: 9223372036854775807
pragma.gateway.GamePlayerGatewayConfig #
Game Player gateway configuration.
- Configuration Values:
field description type values/constraints protocolprotocol of the host/port String minLength: 0 webSocketProtocolprotocol of the WebSocket host/port String minLength: 0 authenticateHostauthentication backend host String minLength: 0 authenticatePortauthentication backend port Int min: 1, max: 65536 httpExpirySecondsexpiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillistimeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHostsList of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeadersEnable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true,falseconcurrentRequestsPerConnectionnumber of concurrent requests per connection Int min: 1, max: 2147483647 socialHostsocial backend host advertised to clients String minLength: 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 minLength: 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
pragma.party.PartyConfig #
Party service configuration.
- Configuration Values:
field description type values/constraints maxPlayersPerPartyDefault max player per party restriction. Value can be update on a party in the PartyPlugin. Int min: -2147483648, max: 2147483647 disableMaxPlayerCountWhether to disable the max player per party restriction. Boolean options: true,falseenableTransferPartyLeaderWhether to transfer party leader status from one to another when invoking AssignPartyLeaderV1. Boolean options: true,falseenableGameServerVersionDevelopmentOverrideWhether to allow game clients to override their game server version for local development purposes. Boolean options: true,falsegameServerVersionCompatibilityMap of all the game server versions to compatible game client versions configuration. Map of Object of type GameServerVersionCompatibility GameServerVersionCompatibility enableStalePartyExpirationEnables the termination of parties that have lived for a long time. This is to ensure we do not leak parties and players in the worst case. Boolean options: true,falsestalePartyExpirationMinutesTime, in minutes, to wait before terminating a party. Will be ignored if enableStalePartyExpiration is false. Long min: -9223372036854775808, max: 9223372036854775807 assessTimeoutsIntervalSecondsInterval, in seconds, between checking for expiration of timeouts on the service. Long min: -9223372036854775808, max: 9223372036854775807
pragma.databases.DatabaseIdentifierSchema #
Database identifier to schema
- Configuration Values:
field description type values/constraints identifierthe database connection settings defined in your databaseConfig per unique identifier String minLength: 0 schemathe database schema to use for connection settings String minLength: 0
pragma.databases.PartitionedDatabaseConfig #
Standard Pragma Engine database connection configuration.
- Configuration Values:
field description type values/constraints driverwhich driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDBusernameusername to use String minLength: 1 passwordpassword to use EncryptedString minLength: 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 minLength: 0 hostPortSchemashost and schemas by index Map of String minLength: 0 identifierSchemasdatabase connection settings for each identifier Map of Object of type DatabaseIdentifierSchema DatabaseIdentifierSchema
pragma.databases.UnpartitionedDatabaseConfig #
Standard Pragma Engine database connection configuration.
- Configuration Values:
field description type values/constraints driverwhich driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDBusernameusername to use String minLength: 1 passwordpassword to use EncryptedString minLength: 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 minLength: 0 identifierSchemadatabase connection settings for each identifier Object of type DatabaseIdentifierSchema DatabaseIdentifierSchema
pragma.inventory.ContentAccessByTagsConfig #
Content filtering configuration on player endpoints by tags.
- Configuration Values:
field description type values/constraints hiddenContent filtering configuration on player endpoints by tags. Map of String minLength: 0
pragma.utils.EvictingCacheConfig #
Config for evicting cache.
- Configuration Values:
field description type values/constraints 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 sweepIntervalMillisInterval, in milliseconds, between sweep calls for the cache. Long min: -9223372036854775808, max: 9223372036854775807
pragma.fleet.ServerPoolManagementPolicyConfig #
Configuration for a server pool management policy.
- Configuration Values:
field description type values/constraints idIdentifier for this server pool management policy. String minLength: 0 gameCapacityPerServerMaximum number of games that can run on a single game server. Must be at least 1. Int min: 1, max: 2147483647 capacityFloorMinimum number of game capacity to be allocated at all times. Int min: -2147483648, max: 2147483647 capacityCeilingMaximum number of game capacity to be allocated at all times. Int min: -2147483648, max: 2147483647 capacityBufferDesired available game capacity defined as a percentage of used game capacity. 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: -1.7976931348623157E308, max: 1.7976931348623157E308 gameCapacityResolvedTimeoutMillisMaximum duration, in milliseconds, the platform will wait for capacity to resolve for a game instance before ejecting it. Should be the same as GameInstanceServiceConfig.gameServerAllocationTimeoutMillis Long min: -9223372036854775808, max: 9223372036854775807
pragma.datarights.DataRightsWaitingPeriodConfig #
Data rights waiting period configurations.
- Configuration Values:
field description type values/constraints accountDeletionNumber of days to wait before actually deleting the player account. Int min: 0, max: 2147483647 personalDataNumber of days to wait before the personal data package is sent to the player. Int min: 0, max: 2147483647
pragma.databases.SharedDatabaseConfig #
Database identifier config
- Configuration Values:
field description type values/constraints usernameusername to use String minLength: 1 passwordpassword to use EncryptedString minLength: 0 hosthost String minLength: 0 portport Int min: -2147483648, max: 2147483647
pragma.auth.KeyPairConfig #
Public and Private Keys
- Configuration Values:
field description type values/constraints publicPublic key used to validate JWTs String minLength: 1 privatePrivate key used to sign JWTs EncryptedString minLength: 1
pragma.party.GameServerVersionCompatibility #
Map of server version to compatible client versions configuration.
- Configuration Values:
field description type values/constraints serverVersionGame server version string, must not be empty. String minLength: 0 clientVersionsGame client versions supported by this game server version. Map of String minLength: 0
Plugin Configurations #
pragma.inventory.SteamEntitlementConfig #
Steam entitlement provider plugin configuration.
- Configuration Values:
field description type values/constraints appConfigSteam app configuration for entitlement processing. Object of type SteamAppConfig SteamAppConfig
pragma.gateway.FilePortalModulePlugin$Config #
File Portal Router plugin configuration.
- Configuration Values:
field description type values/constraints portalSourceThe path to the portal resource files. String minLength: 0 redirectSignInToSocialCan be used to disable the social sign-in redirect. Boolean options: true,falsecontentA map of values to make available to the portal. Map of String minLength: 0
pragma.fleet.MultiplayFleetPlugin$Config #
MultiplayClientNode service configuration.
- Configuration Values:
field description type values/constraints capacityPerServerAmount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 fleetIdFleetId for Multiplay API calls String minLength: 0 projectGuidProject GUID for Multiplay API calls String minLength: 0 accessKeyClanforge Access Key for signing REST API calls to Multiplay String minLength: 0 secretAccessKeyClanforge Secret Access Key for signing REST API calls to Multiplay EncryptedString minLength: 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 minLength: 0 gameServerZoneToMultiplayRegionIdMap of gameServerZone to Multiplay region id Map of String minLength: 0 serverPoolConfigsConfiguration data for unique Multiplay profiles Map of Object of type ServerPoolConfig ServerPoolConfig pragmaBackendAddressParamName of pragma backend address parameter in Multiplay allocation payload. Default value: pragmaBackendAddress String minLength: 0 serverPoolIdParamName of server pool id parameter in Multiplay allocation payload. Default value: serverPoolId String minLength: 0 gameTokenParamName of game token parameter in Multiplay allocation payload. Default value: gameToken String minLength: 0 socialTokenParamName of social token parameter in Multiplay allocation payload. Default value: socialToken String minLength: 0
pragma.account.GoogleIdentityProviderPlugin$Config #
Google Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseallowedDomainsA map of domains that are allowed to use Google to authenticate (e.g. pragma.gg) Map of String minLength: 0 clientSecretyour app’s secret key (provided by Google) EncryptedString minLength: 0 clientIdyour app’s id (provided by Google) String minLength: 0 redirectUriyour app’s redirect URI, as defined with Google String minLength: 0
pragma.account.config.OidcIdProviderConfig #
OIDC Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseauthorizationUriyour app’s user info url String minLength: 0 tokenUriyour app’s authorization token url String minLength: 0 userInfoUriyour app’s user info url String minLength: 0 clientSecretyour app’s secret key EncryptedString minLength: 0 clientIdyour app’s id String minLength: 0 redirectUriyour app’s redirect URI String minLength: 0 requireEmailVerificationwhether to require email verification for authorization Boolean options: true,false
pragma.config.EmptyPluginConfig #
Empty plugin config for configless plugins.
- Configuration Values:
field description type values/constraints
pragma.fleet.LocalProcessFleetPluginConfig #
Generic Local Process fleet plugin configuration.
- Configuration Values:
field description type values/constraints 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 minLength: 0 serverPoolIdParamName of the command line param to append with the server pool id. String minLength: 0 logPathParamName of the command line param to append with the program log path, and this will result in a file inside logOutputPath. String minLength: 0 logOutputPathPath to a folder where to redirect log output. String minLength: 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 minLength: 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 serverPoolConfigsServer pool configurations. Map of Object of type LocalProcessServerPoolConfig LocalProcessServerPoolConfig
pragma.account.config.UnsafeIdProviderConfig #
Unsafe Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,false
pragma.account.config.TwitchIdProviderConfig #
Twitch Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseclientSecretyour app’s secret key (provided by Twitch) EncryptedString minLength: 0 clientIdyour app’s id (provided by Twitch) String minLength: 0 redirectUriyour app’s redirect URI, as defined with Twitch String minLength: 0
pragma.payment.steam.SteamPaymentConfig #
Steam payment plugin configuration.
- Configuration Values:
field description type values/constraints 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
pragma.telemetry.s3.S3TelemetryPluginConfig #
Configuration for the S3 Telemetry Plugin
- Configuration Values:
field description type values/constraints eventBatchSizenumber of events that will trigger a send. if the size is set to 10 and 100 events come in at the same time, a single send of 100 will be made. 0 means batching by size is disabled Int min: -2147483648, max: 2147483647 timeWindowPerBatchMillisthe period in millis that the batch is sent to S3 Long min: 1, max: 9223372036854775807 s3BucketNamethe name of the s3 bucket to store telemetry files String minLength: 0 shardNamethe name of the shard, e.g. prod, loadtest, test, local-dev, etc. String minLength: 0
pragma.order.EpicOrderProviderPlugin$EpicOrderProviderPluginConfig #
Epic order provider configuration.
- Configuration Values:
field description type values/constraints clientIdID of your client in the Epic Dev Portal. String minLength: 0 clientSecretEncrypted string representing your client’s secret in the Epic Dev Portal. EncryptedString minLength: 0 sandboxIdID of the sandbox to operate on. String minLength: 0 deploymentIdID of the corresponding deployment in the Epic Dev Portal. String minLength: 0 clawbackPollIntervalHoursHow often to call the Epic clawback endpoint in hours Int min: 1, max: 24 clawbackPollingEnabledEnables the Epic Order Provider to poll the clawback endpoint Boolean options: true,falsemaxDaysWorthOfClawbacksToProcessHow many days worth of clawbacks to process in a single clawback poll interval. Int min: 1, max: 2147483647
pragma.account.config.EmailIdProviderConfig #
Email Id Provider configuration.
- Configuration Values:
field description type values/constraints privateKeyan encrypted private key used for encrypting emails in Pragma Engine’s database EncryptedString minLength: 0
pragma.account.config.EpicIdProviderConfig #
Epic Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseclientIdyour product’s client id (provided by Epic) String minLength: 0 clientSecretyour product’s client secret (provided by Epic) EncryptedString minLength: 0 redirectUriyour app’s redirect URI, as defined with Epic String minLength: 0 restrictByCatalogItemOwnershipPrevent authentication if the player does not own the catalog item specified by catalogItemId Boolean options: true,falsesandboxIdyour product’s sandbox id (provided by Epic) String minLength: 0 deploymentIdyour product’s deployment id (provided by Epic) String minLength: 0 catalogItemIdyour catalog item’s id (provided by Epic, Audience Item Id or Game Item Id) String minLength: 0
pragma.datarights.DefaultDataRightsSocialPlugin$Config #
Data Rights plugin configuration.
- Configuration Values:
field description type values/constraints
pragma.account.SendInBlueEmailSenderPlugin$SendInBlueEmailSenderConfig #
EmailSender plugin configuration.
- Configuration Values:
field description type values/constraints providerAPIKeythe API key that will enable you to send emails with your provider EncryptedString minLength: 0 apiUrlbase URL for the provider API to interact with String minLength: 0 routethe HTTP route for the provider String minLength: 0 verificationTemplateIdid of the email template to send String minLength: 0 fromEmailverified email address associated with the account in sendinblue that this email will be sent from String minLength: 0 fromNamename displayed String minLength: 0
pragma.gateway.PostmanRoutePlugin$Config #
Postman Route Plugin configuration.
- Configuration Values:
field description type values/constraints pathToPostmanFilespath to postman files String minLength: 0 collectionNamepath to postman files String minLength: 0 environmentNamepath to postman files String minLength: 0
pragma.metrics.StatsdRegistryProvider$Config #
Statsd metrics registry provider configuration.
- Configuration Values:
field description type values/constraints flavorflavor of statsd Enum StatsdFlavor allowed values: ETSY,DATADOG,TELEGRAF,SYSDIGhosthost to send stats String minLength: 0 portport to send stats Int min: -2147483648, max: 2147483647 protocolprotocol to send stats Enum StatsdProtocol allowed values: UDP,UDS_DATAGRAM,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.metrics.DatadogRegistryProvider$Config #
Datadog metrics registry provider configuration
- Configuration Values:
field description type values/constraints apiKeyDatadog API key EncryptedString minLength: 0 applicationKeyDatadog application key EncryptedString minLength: 0 descriptionswhether to send descriptions metadata Boolean options: true,falsehostTaghost tag when shipping metrics String minLength: 0 uriURI to ship metrics to String minLength: 0
pragma.gameinstance.LocalProcessGameServerProviderPluginConfig #
Local process game host plugin configuration.
- Configuration Values:
field description type values/constraints serverExecutablePathPath to the executable for running the game server String minLength: 0 serverLogDirectoryPath to a directory to store server logs, relative to the pragma-engine execution. Creates the directory if it does not exist. String minLength: 0 gameInstanceIdParamCommand line argument parameter name for the game instance id, defaults to -PragmaGameInstanceId String minLength: 0 socialTokenParamCommand line argument parameter name for the social token, defaults to -PragmaSocialToken String minLength: 0 gameTokenParamCommand line argument parameter name for the game token, defaults to -PragmaGameToken String minLength: 0 pragmaBackendAddressParamCommand line argument parameter name for the pragma backend address, defaults to -PragmaBackendAddress String minLength: 0 portParamCommand line argument parameter name for the port the game server should use, defaults to -Port String minLength: 0 minPortStarting port number for game server to use, defaults to 7777 Int min: -2147483648, max: 2147483647 maxPortEnding port number for game server to use, defaults to 7777 Int min: -2147483648, max: 2147483647 additionalArgumentsAdditional command line arguments to be passed to the game server Map of String minLength: 0 usePlayInEditorGameServerUse PIE game server instead of starting new server, defaults to false Boolean options: true,false
pragma.fleet.NomadFleetPlugin$Config #
Pragma Engine Nomad fleet provider configuration.
- Configuration Values:
field description type values/constraints urlfull URL (including protocol and port) to reach the Nomad API URL capacityPerServeramount of games a server can run concurrently Int min: -2147483648, max: 2147483647 executableNamename of the executable such as ‘gameServer.sh’ String minLength: 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 minLength: 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.MetaQuestIdProviderConfig #
Meta Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseappIdyour product’s client id (provided by Meta) String minLength: 0 appCredentialsyour product’s app credentials (provided by Meta) Example: `OC 1234 4567ABCDE` orgIdyour product’s org id (provided by Meta) String minLength: 0 redirectUriyour app’s redirect URI, as defined with Meta String minLength: 0
pragma.account.config.DiscordIdProviderConfig #
Discord Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseclientSecretyour app’s secret key (provided by Discord) EncryptedString minLength: 0 clientIdyour app’s id (provided by Discord) String minLength: 0 guildIdyour guild id, also known as server id String minLength: 0 redirectUriyour app’s redirect URI, as defined with Discord String minLength: 0 botTokenbot token associated with your Discord Server’s bot EncryptedString minLength: 0 allowedRoleIdsset of guild role ids that provide access to Pragma Engine social backend Map of String minLength: 0
pragma.shared.SteamAppConfig #
Steam application configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falsesteamWebAPIKeyyour app’s secret web API key (provided by Steam) EncryptedString minLength: 0 appIdyour app’s id (provided by Steam) String minLength: 0 restrictByAppOwnershipPrevent authentication if the player does not own the app specified by appId Boolean options: true,falserestrictByAccountBanPrevent authentication if the player is banned Boolean options: true,false
pragma.account.GoogleWorkspaceIdentityProviderPlugin$Config #
Google Workspace Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseallowedDomainsA map of domains that are allowed to use Google to authenticate (e.g. pragma.gg) Map of String minLength: 0 clientSecretyour app’s secret key (provided by Google) EncryptedString minLength: 0 clientIdyour app’s id (provided by Google) String minLength: 0 redirectUriyour app’s redirect URI, as defined with Google String minLength: 0
pragma.inventory.EpicEntitlementConfig #
Epic entitlement provider plugin configuration.
- Configuration Values:
field description type values/constraints sandboxIdID of the sandbox to operate on. String minLength: 0 deploymentIdID of the corresponding deployment in the Epic Dev Portal. String minLength: 0 clientIdID of your client in the Epic Dev Portal. String minLength: 0 clientSecretEncrypted string representing your client’s secret in the Epic Dev Portal. EncryptedString minLength: 0
pragma.inventory.TwitchEntitlementConfig #
Twitch Drop entitlement provider plugin configuration.
- Configuration Values:
field description type values/constraints clientIdID of your client in the Twitch Dev Portal String minLength: 0 clientSecretSecret of your client in the Twitch Dev Portal EncryptedString minLength: 0 gameIdThe game ID associated with the drops to sync String minLength: 0
pragma.order.SteamOrderProviderPlugin$SteamOrderProviderPluginConfig #
Steam order provider configuration.
- Configuration Values:
field description type values/constraints steamWebAPIKeyyour app’s secret web API key (provided by Steam) EncryptedString minLength: 0 appIdyour app’s id (provided by Steam) String minLength: 0
pragma.datarights.DefaultDataRightsGamePlugin$Config #
Data Rights plugin configuration.
- Configuration Values:
field description type values/constraints enableLegacyInventoryDataCollectionPackage the player inventory data with their data rights request. Boolean options: true,false
pragma.matchmaking.WarmBodyMatchmakingPlugin$Config #
WarmBodyMatchmakingPlugin configuration.
- Configuration Values:
field description type values/constraints numberOfTeamsnumber of teams required for the game Int min: 1, max: 2147483647 playersPerTeamnumber of players required for each team Int min: 1, max: 2147483647
pragma.order.TwitchOrderProviderPlugin$TwitchOrderProviderPluginConfig #
Twitch order provider configuration.
- Configuration Values:
field description type values/constraints clientIdID of your client in the Twitch Dev Portal String minLength: 0 clientSecretSecret of your client in the Twitch Dev Portal EncryptedString minLength: 0 gameIdThe game ID associated with the drops to sync String minLength: 0
pragma.account.GoogleIdentityProviderBase$Config #
Google Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falseallowedDomainsA map of domains that are allowed to use Google to authenticate (e.g. pragma.gg) Map of String minLength: 0 clientSecretyour app’s secret key (provided by Google) EncryptedString minLength: 0 clientIdyour app’s id (provided by Google) String minLength: 0 redirectUriyour app’s redirect URI, as defined with Google String minLength: 0
pragma.shared.SteamAppConfig #
Steam application configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabledIf this id provider is enabled for player login. Boolean options: true,falseoperatorLoginEnabledIf this id provider is enabled for operator login. Boolean options: true,falseaccountLinkingEnabledIf this id provider is enabled for account linking. Boolean options: true,falseaccountLinkingCooldownInDaysThe number of days a player needs to wait after unlinking before linking a new account for this provider. Int min: -2147483648, max: 2147483647 accountLinkingOneAssociationOnlyIf true, only one provider account of this type can ever be linked to a player’s account. Boolean options: true,falseaccountUnlinkingEnabledIf this id provider is enabled for account unlinking. Boolean options: true,falseshowPortalLoginButtonIf this id provider is shown in the portal login options. Boolean options: true,falsevisibleToOtherPlayersIf the information about this id provider can be shared with other players. Boolean options: true,falsesteamWebAPIKeyyour app’s secret web API key (provided by Steam) EncryptedString minLength: 0 appIdyour app’s id (provided by Steam) String minLength: 0 restrictByAppOwnershipPrevent authentication if the player does not own the app specified by appId Boolean options: true,falserestrictByAccountBanPrevent authentication if the player is banned Boolean options: true,false
pragma.fleet.MultiplayFleetPlugin$ServerPoolConfig #
Configuration for a Multiplay server pool.
- Configuration Values:
field description type values/constraints serverPoolIdGame server pool id. String minLength: 0 managementPolicyConfigIdServer pool management policy config id. String minLength: 0 profileIdThe Multiplay profileId for API calls String minLength: 0 regionIdThe region supported by this server pool String minLength: 0
pragma.fleet.LocalProcessServerPoolConfig #
Configuration for a server pool.
- Configuration Values:
field description type values/constraints serverPoolIdGame server pool id. String minLength: 0 managementPolicyConfigIdServer pool management policy config id. String minLength: 0 gameServerVersionsGame server versions supported by this server pool. 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)