Configuration Options #
2024-11-27 20:05:53,550 [main] INFO main - 7 -> class demo.playerdata.NumberDataProto 2024-11-27 20:05:53,553 [main] INFO main - 18 -> class demo.playerdata.MigrationHistoryProto 2024-11-27 20:05:53,553 [main] INFO main - 14 -> class demo.playerdata.MaterialGrantProto 2024-11-27 20:05:53,553 [main] INFO main - 2 -> class demo.playerdata.PlayerHiddenComponentProto 2024-11-27 20:05:53,553 [main] INFO main - 4 -> class demo.playerdata.ComponentToUpdateProto 2024-11-27 20:05:53,554 [main] INFO main - 13 -> class demo.playerdata.ComponentToRemoveProto 2024-11-27 20:05:53,554 [main] INFO main - 1 -> class demo.playerdata.DemoAllNumericTypesProto 2024-11-27 20:05:53,554 [main] INFO main - 6 -> class demo.playerdata.DemoComplexTypeProto 2024-11-27 20:05:53,554 [main] INFO main - 15 -> class demo.playerdata.PlayerVisibleComponentProto 2024-11-27 20:05:53,554 [main] INFO main - 19 -> class demo.contentoperation.TestPackageImportsOnGenerationProto 2024-11-27 20:05:53,554 [main] INFO main - 10 -> class demo.playerdata.MyComponentProto 2024-11-27 20:05:53,554 [main] INFO main - 11 -> class demo.playerdata.MigrationTrackerProto 2024-11-27 20:05:53,554 [main] INFO main - 5 -> class playerdata.triage.StringDataProto 2024-11-27 20:05:53,554 [main] INFO main - 17 -> class demo.playerdata.NewComponentProto 2024-11-27 20:05:53,554 [main] INFO main - 12 -> class mystudio.checklist.MyLiveDataComponentProto 2024-11-27 20:05:53,554 [main] INFO main - 3 -> class demo.playerdata.ComponentToTransferProto 2024-11-27 20:05:53,554 [main] INFO main - 8 -> class playerdata.loadtest.StringComponentProto 2024-11-27 20:05:53,554 [main] INFO main - 16 -> class demo.currency.CurrencyBalanceProto 2024-11-27 20:05:53,554 [main] INFO main - 9 -> class playerdata.loadtest.WalletComponentProto
Core Configurations #
pragma.config.CoreConfig #
Node-Wide Configuration
- Configuration Values:
field description type values/constraints clusterName
The name of the cluster. String minLength: 1 nodeName
The name of the node, to be used in nodeByInstanceId of distributedServices. String minLength: 0 logging
Logback configuration options. Object of type LoggingConfig LoggingConfig portalUrl
Hostname of the operator Pragma portal web interface. String minLength: 0 enableHistogramMetrics
Enables histograms for metrics. This uses a large number of tags per metric. Boolean options: true
,false
enableKtorMetrics
Enables standard KTOR metrics for HTTP requests. Boolean options: true
,false
metricsDistributionExpiryDurationSeconds
The expiration duration for DistributionStatistics. See https://docs.micrometer.io/micrometer/reference/concepts/distribution-summaries.html for more information. Long min: -9223372036854775808, max: 9223372036854775807 startupTimeoutMillis
The maximum time in milliseconds to wait during startup before forcibly exiting. Long min: 0, max: 9223372036854775807 shutdownTimeoutMillis
The maximum time milliseconds to wait during shutdown before forcibly exiting. Long min: 0, max: 9223372036854775807 distributedServices
Map of services running on each node. Map of Object of type DistributedServiceConfig DistributedServiceConfig remoteNodeConfigs
Map object referencing all remote nodes to their host:port. Map of Object of type RemoteNodeConfig RemoteNodeConfig nettyPendingTasksCheckPeriodMillis
How often to check pending tasks and emit a metric. Long min: -9223372036854775808, max: 9223372036854775807 allowWorkInProgressAccess
Allows access to methods that are works in progress. Boolean options: true
,false
enableVersionWithBuildSlug
Adds a build slug to the version output. Boolean options: true
,false
shardId
The unique uuid of this shard. UUIDv4 serviceRpcTimeoutMillis
The 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 rootLoggerLevel
level of the root logger Enum LogLevel allowed values: OFF
,ERROR
,WARN
,INFO
,DEBUG
,TRACE
,ALL
logFormat
default log format String minLength: 0 consoleLoggerEnabled
enable logging to stdout/stderr Boolean options: true
,false
fileLoggerEnabled
enable logging to file Boolean options: true
,false
fileLoggerCurrentFilename
file name (including path) to use for logs String minLength: 0 loggers
logback log level per logger Map of Enum LogLevel allowed values: OFF
,ERROR
,WARN
,INFO
,DEBUG
,TRACE
,ALL
logLayout
type of layout to log Enum LogLayout allowed values: TEXT
,JSON
pragma.config.DistributedServiceConfig #
Distributed services configuration.
- Configuration Values:
field description type values/constraints nodeByInstanceId
map of instances of distributed services and the node they are running on Map of String minLength: 0
pragma.config.RemoteNodeConfig #
Individual PragmaNodes and their gateway ports configuration.
- Configuration Values:
field description type values/constraints host
the host that the node is running on String minLength: 0 port
the 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 databaseConfig
database config for the inventory dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gamedata.GameDataServiceConfig #
GameDataService configuration.
- Configuration Values:
field description type values/constraints loginDataCollectionTimeout
Time, 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 databaseConfig
database config for the game dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
demo.triage.ChaosMonkeyConfig #
Chaos Monkey service configuration.
- Configuration Values:
field description type values/constraints concurrentDosAttacks
Number of concurrent coroutines used to attack the target service. Default value: 100 Int min: -2147483648, max: 2147483647 delayMillisBetweenAttacks
Delay between individual rpcs made by an attacking coroutine. Default value: 10 Long min: -9223372036854775808, max: 9223372036854775807 numBytesPerPlayerDataDosAttack
Number of bytes to allocate per player data grant per attack rpc. Default value: 1000 Int min: -2147483648, max: 2147483647
pragma.thirdparty.ThirdPartyNodeService$ThirdPartyConfig #
- Configuration Values:
field description type values/constraints
pragma.inventory.InventoryServiceConfig #
Inventory service configuration.
- Configuration Values:
field description type values/constraints enableDeleteAllInventory
Determines whether to allow making a cache/db delete call. Boolean options: true
,false
enableDeletePlayerInventory
Determines whether to allow players to delete their inventory. Boolean options: true
,false
legacyItemLoadBehavior
If true, do not filter out items with invalid catalogId when retrieving items. Boolean options: true
,false
contentAccessByTags
Content filtering on player endpoints by tags. Object of type ContentAccessByTagsConfig ContentAccessByTagsConfig loadInventoryContentOnStart
if true will read all the inventory content files on startup. Boolean options: true
,false
inventoryCacheConfig
Config for inventory data cache. Object of type EvictingCacheConfig EvictingCacheConfig
pragma.order.config.OrderDaoConfig #
OrderDaoNodeService service configuration.
- Configuration Values:
field description type values/constraints databaseConfig
database config for the order dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.order.FulfillmentService$FulfillmentServiceConfig #
Fulfillment service configuration.
- Configuration Values:
field description type values/constraints
pragma.multiplayer.MultiplayerConfig #
Multiplayer routing 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 targetCcuLimit
the target maximum number of concurrent users logged in Int min: 0, max: 2147483647 targetLoginRatePerSecond
the target number of users to log in per second Int min: 0, max: 2147483647 estimatedSecondsToLogin
the time between a user login request and the user gaining access Int min: 0, max: 2147483647 maxCheckTicketPollTimeSeconds
the 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 databaseConfig
database config for the inventory dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gameinstance.GameInstanceServiceConfig #
Game instance service configuration.
- Configuration Values:
field description type values/constraints gameReadyTimeoutMillis
Time, 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 enableKeepAlive
Enables 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
,false
keepAliveIntervalMillis
Interval, 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 keepAliveMissesLimit
Number 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 reconnect
Set to required, optional, or off to determine the player client behavior when recovering from an unexpected disconnect during a game. Enum GameInstanceReconnect allowed values: OFF
,REQUIRED
,OPTIONAL
enableExtraCreateGameInstanceTimers
Enables some additional timing metrics to diagnose performance issues within the CreateGameInstanceV1 endpoint Boolean options: true
,false
enableStaleGameInstanceExpiration
Enables 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
,false
staleGameInstanceExpirationMinutes
Time, 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 serverPoolManagementPolicies
Configuration 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 protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647
pragma.account.config.AccountDaoConfig #
AccountDaoNode service configuration.
- Configuration Values:
field description type values/constraints databaseConfig
database config for the account dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.payment.PaymentDaoConfig #
Configuration for the PaymentDaoNodeService
- Configuration Values:
field description type values/constraints databaseConfig
the 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 protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647 socialHost
social backend host advertised to clients String minLength: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536
pragma.telemetry.db.TelemetryDaoConfig #
DbTelemetryDao configuration.
- Configuration Values:
field description type values/constraints databaseConfig
Database configuration for the game dao. Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.gateway.GamePartnerGatewayConfig #
Game Partner gateway configuration.
- Configuration Values:
field description type values/constraints protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647 socialHost
social backend host advertised to clients String minLength: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHost
game backend host advertised to clients String minLength: 0 gamePort
game backend port advertised to clients Int min: 1, max: 65536 gameBindPort
game backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536
pragma.matchmaking.MatchmakingConfig #
Matchmaking service configuration.
- Configuration Values:
field description type values/constraints matchmakingDelayMillis
Delay, in milliseconds, between matchmaking runs. Long min: -9223372036854775808, max: 9223372036854775807 enableGetMatchmakingInfo
Enables the player-facing endpoint to retrieve operational info about the matchmaking service. Boolean options: true
,false
enableExtraEnterMatchmakingTimers
Enables some additional timing metrics to diagnose performance issues within the EnterMatchmakingV2 endpoint Boolean options: true
,false
divertResultsToMatchmakingSimulator
Flag used to divert all matchmaking results to matchmaking simulator. This takes priority over sampleMatchResults if set to true. Boolean options: true
,false
sampleMatchResults
Percent chance (from 0 - 1) to divert results to matchmaking simulator. Double min: -1.7976931348623157E308, max: 1.7976931348623157E308
pragma.account.config.UnsafeIdentityDaoConfig #
UnsafeIdentityDaoNode service configuration.
- Configuration Values:
field description type values/constraints databaseConfig
database 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 databaseConfig
database config for the data rights dao Object of type UnpartitionedDatabaseConfig UnpartitionedDatabaseConfig
pragma.datarights.DataRightsServiceConfig #
Data rights configuration.
- Configuration Values:
field description type values/constraints includeGameDataReports
Whether or not to include game data reports in the data rights data package. By default, only account data will be included. Boolean options: true
,false
waitingPeriodInDays
Waiting period delays before performing certain data rights actions. Object of type DataRightsWaitingPeriodConfig DataRightsWaitingPeriodConfig downloadLinkLifespanInDays
Number 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 downloadEndpoint
Endpoint used by players to download their personal data package. String minLength: 0
pragma.gameshardcache.GameShardCacheConfig #
- Configuration Values:
field description type values/constraints cacheRefreshSeconds
The 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 databaseConfigsByIdentifier
map of database connections Map of Object of type SharedDatabaseConfig SharedDatabaseConfig
pragma.friend.dao.FriendDaoConfig #
FriendDaoConfig configuration.
- Configuration Values:
field description type values/constraints databaseConfig
database config for the friend dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.gateway.SocialPartnerGatewayConfig #
Social Partner gateway configuration.
- Configuration Values:
field description type values/constraints protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647 socialHost
social backend host advertised to clients String minLength: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536
pragma.datarights.DataRightsPollingServiceConfig #
- Configuration Values:
field description type values/constraints enabled
Enables the DataRightsPollingService for collecting game data for data rights requests Boolean options: true
,false
checkRequestsFrequencyInMinutes
How 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 protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647 socialHost
social backend host advertised to clients String minLength: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 devLoginQueueBypass
Enable 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
demo.echo.EchoServiceConfig #
Echo 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 bearerToken
The bearer token to use when making partner calls to the social backend EncryptedString minLength: 0 socialPartnerProtocol
The protocol to use for making social partner calls String minLength: 0 socialPartnerHost
The host to use for making social partner calls String minLength: 0 socialPartnerPort
The port to use for making social partner calls Int min: -2147483648, max: 2147483647
demo.stress.DelayedServiceConfig #
Delayed service config
- Configuration Values:
field description type values/constraints delayInSeconds
lag in seconds to introduce Int min: 1, max: 2147483647
pragma.account.AccountServiceConfig #
Account service configuration.
- Configuration Values:
field description type values/constraints gameManagementPollingFrequencyInMillis
frequency with which Account service checks for updated game management data Long min: -9223372036854775808, max: 9223372036854775807 verificationEmailEndpoint
URL to send the verification email requests to, which is passed into the email sender plugin when templating your email String minLength: 0 blockSessionOnBan
When 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 missingHeartbeatTimeoutMillis
amount of time the session service will wait for a heartbeat before expiring the session Long min: -9223372036854775808, max: 9223372036854775807 notifyAllActiveSessionsBatchSize
Number of notifications per gateway sent in a batch by notifyLocalActiveSessions every notifyAllBatchIntervalMillis. Int min: 1, max: 2147483647 notifyAllActiveSessionsBatchIntervalMillis
Time 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 protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647 socialHost
social backend host advertised to clients String minLength: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHost
game backend host advertised to clients String minLength: 0 gamePort
game backend port advertised to clients Int min: 1, max: 65536 gameBindPort
game backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536
pragma.friend.FriendServiceConfig #
Friend service configuration.
- Configuration Values:
field description type values/constraints maxFriendListSize
Maximum size of friends list for a player. Default value: 400. Int min: -2147483648, max: 2147483647 maxPendingSentInvites
Maximum size of pending sent invites for a player. Default value: 20. Int min: -2147483648, max: 2147483647 maxPendingReceivedInvites
Limit on the amount of friend invites a player can receive. Default value: 20 Int min: -2147483648, max: 2147483647 enablePresenceUpdates
Whether 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
,false
friendListCacheConfig
Configuration of caching behavior for the friend service database. Object of type EvictingCacheConfig EvictingCacheConfig identityCacheConfig
Configuration for caching player identity data retrieved from the account service. Object of type EvictingCacheConfig EvictingCacheConfig enableIntegrationTestDeleteFriendData
Whether 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 cacheConfig
config for the player data cache Object of type EvictingCacheConfig EvictingCacheConfig
pragma.auth.TokenConfig #
Token validator service configuration.
- Configuration Values:
field description type values/constraints jwtCurrentKeys
The public and private keys used to validate and sign JWTs Object of type KeyPairConfig KeyPairConfig jwtRotatedPublicKeys
Additional public keys used to validate JWTs Map of String minLength: 1 playerTokenExpirationMinutes
length of time the player token is valid for (minutes) Double min: -1.7976931348623157E308, max: 1.7976931348623157E308 playerTokenRefreshMinutes
time before the player token expires that we tell clients to refresh Long min: -9223372036854775808, max: 9223372036854775807 playerTokenRefreshVarianceWindowMinutes
variance in refresh time to smooth the refresh load over time Long min: -9223372036854775808, max: 9223372036854775807 partnerExpirationHours
length of time the partner token is valid for (hours) Long min: -9223372036854775808, max: 9223372036854775807 operatorExpirationMinutes
length of time the operator token is valid for (minutes) Long min: -9223372036854775808, max: 9223372036854775807 emailTokenExpirationMinutes
length of time the email validation token is valid for (minutes) Long min: -9223372036854775808, max: 9223372036854775807
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
demo.loadtesting.LoadTestingGameServerServiceConfig #
Load Testing Game Server Configuration.
- Configuration Values:
field description type values/constraints capacityPerServer
amount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 partnerConnectionInfo
Pragma Engine partner connection info for games to report their existence Object of type PartnerConnectionInfoConfig PartnerConnectionInfoConfig clientInitialHeartbeatPeriodMillis
heartbeat period used when the server has not yet responded Long min: -9223372036854775808, max: 9223372036854775807 matchLauncher
The fully qualified name of the match launcher class String minLength: 0
pragma.gateway.BackendGatewayConfig #
Backend gateway configuration.
- Configuration Values:
field description type values/constraints port
port 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 databaseConfig
the database config for the fulfillment dao Object of type PartitionedDatabaseConfig PartitionedDatabaseConfig
pragma.matchmakingsimulator.MatchmakingSimulatorConfig #
Matchmaking Simulator service configuration.
- Configuration Values:
field description type values/constraints enableMatchGeneration
Enables simulate matchmaking Boolean options: true
,false
pragma.session.GamePlayerSessionConfig #
config for game player sessions
- Configuration Values:
field description type values/constraints missingHeartbeatTimeoutMillis
amount of time the session service will wait for a heartbeat before expiring the session Long min: -9223372036854775808, max: 9223372036854775807 notifyAllActiveSessionsBatchSize
Number of notifications per gateway sent in a batch by notifyLocalActiveSessions every notifyAllBatchIntervalMillis. Int min: 1, max: 2147483647 notifyAllActiveSessionsBatchIntervalMillis
Time 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 protocol
protocol of the host/port String minLength: 0 webSocketProtocol
protocol of the WebSocket host/port String minLength: 0 authenticateHost
authentication backend host String minLength: 0 authenticatePort
authentication backend port Int min: 1, max: 65536 httpExpirySeconds
expiry length for HTTP sessions, expiration deadline is refreshed on each use of an existing session Long min: -9223372036854775808, max: 9223372036854775807 notificationSendTimeoutMillis
timeout for send operations to clients Long min: -9223372036854775808, max: 9223372036854775807 corsAllowedHosts
List of hosts to allow for CORS AccessControlAllowOrigin. If not set CORS will be configured to allow any host Map of String minLength: 0 enableXForwardedHeaders
Enable X-Forwarded headers for this gateway, for security reasons only enable this if behind a reverse proxy. Disabled by default Boolean options: true
,false
concurrentRequestsPerConnection
number of concurrent requests per connection Int min: 1, max: 2147483647 socialHost
social backend host advertised to clients String minLength: 0 socialPort
social backend port advertised to clients Int min: 1, max: 65536 socialBindPort
social backend port the backend binds to (if 0, defaults to socialPort) Int min: 0, max: 65536 gameHost
game backend host advertised to clients String minLength: 0 gamePort
game backend port advertised to clients Int min: 1, max: 65536 gameBindPort
game backend port the backend binds to (if 0, defaults to gamePort) Int min: 0, max: 65536
pragma.party.PartyConfig #
Party service configuration.
- Configuration Values:
field description type values/constraints maxPlayersPerParty
Default max player per party restriction. Value can be update on a party in the PartyPlugin. Int min: -2147483648, max: 2147483647 disableMaxPlayerCount
Whether to disable the max player per party restriction. Boolean options: true
,false
repeatInviteDelaySeconds
Defines the delay between a player sending consecutive party invites to another player. Long min: -9223372036854775808, max: 9223372036854775807 enableTransferPartyLeader
Whether to transfer party leader status from one to another when invoking AssignPartyLeaderV1. Boolean options: true
,false
enableGameServerVersionDevelopmentOverride
Whether to allow game clients to override their game server version for local development purposes. Boolean options: true
,false
gameServerVersionCompatibility
Map of all the game server versions to compatible game client versions configuration. Map of Object of type GameServerVersionCompatibility GameServerVersionCompatibility enableStalePartyExpiration
Enables 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
,false
stalePartyExpirationMinutes
Time, in minutes, to wait before terminating a party. Will be ignored if enableStalePartyExpiration is false. Long min: -9223372036854775808, max: 9223372036854775807
pragma.databases.DatabaseIdentifierSchema #
Database identifier to schema
- Configuration Values:
field description type values/constraints identifier
the database connection settings defined in your databaseConfig per unique identifier String minLength: 0 schema
the 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 driver
which driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDB
username
username to use String minLength: 1 password
password to use EncryptedString minLength: 0 hikariConnectionTimeoutMillis
connection timeout in millis for Hikari connection pool, default: 20,000ms Long min: -9223372036854775808, max: 9223372036854775807 hikariMinimumIdleConnections
minimum number of connections to hold open for Hikari connection pool, default: 0 Int min: -2147483648, max: 2147483647 hikariConfigMaximumPoolSize
maximum connection pool size for Hikari connection pool, default: 10 Int min: -2147483648, max: 2147483647 hikariConfigIdleTimeoutMillis
idle timeout in millis for Hikari connection pool, default: 300,000ms Long min: -9223372036854775808, max: 9223372036854775807 dynamicShardingSupport
enables virtual nodes and sharding support, default:false Boolean options: true
,false
columnNameOfPropertyToConsistentHash
property to shard by (ie playerId) String minLength: 0 hostPortSchemas
host and schemas by index Map of String minLength: 0 identifierSchemas
database 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 driver
which driver to use, default: MYSQLDB Enum DatabaseDriver allowed values: MYSQLDB
username
username to use String minLength: 1 password
password to use EncryptedString minLength: 0 hikariConnectionTimeoutMillis
connection timeout in millis for Hikari connection pool, default: 20,000ms Long min: -9223372036854775808, max: 9223372036854775807 hikariMinimumIdleConnections
minimum number of connections to hold open for Hikari connection pool, default: 0 Int min: -2147483648, max: 2147483647 hikariConfigMaximumPoolSize
maximum connection pool size for Hikari connection pool, default: 10 Int min: -2147483648, max: 2147483647 hikariConfigIdleTimeoutMillis
idle timeout in millis for Hikari connection pool, default: 300,000ms Long min: -9223372036854775808, max: 9223372036854775807 dynamicShardingSupport
enables virtual nodes and sharding support, default:false Boolean options: true
,false
hostPortSchema
schema String minLength: 0 identifierSchema
database 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 hidden
Content 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 maxTimeBetweenAccessMillis
If an entry has not been accessed in this amount of time, it is a candidate for removal in the next eviction sweep. Long min: -9223372036854775808, max: 9223372036854775807 sizeBeforeExpirationEnforced
Size of cache before eviction sweeping will start removing entries. Int min: -2147483648, max: 2147483647 sweepIntervalMillis
Interval, 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 id
Identifier for this server pool management policy. String minLength: 0 gameCapacityPerServer
Maximum number of games that can run on a single game server. Must be at least 1. Int min: 1, max: 2147483647 capacityFloor
Minimum number of game capacity to be allocated at all times. Int min: -2147483648, max: 2147483647 capacityCeiling
Maximum number of game capacity to be allocated at all times. Int min: -2147483648, max: 2147483647 capacityBuffer
Desired available game capacity defined as a percentage of used game capacity. Int min: -2147483648, max: 2147483647 serverMaxStartDurationMillis
Maximum duration, in milliseconds, a game server can take to start before the allocation is declared failed. Long min: -9223372036854775808, max: 9223372036854775807 serverHeartbeatPeriodMillis
Expected heartbeat period a game server should report its state. Long min: -9223372036854775808, max: 9223372036854775807 serverHeartbeatExpiryFactor
Number, as a float, of heartbeats before a game server is considered timed out. Double min: -1.7976931348623157E308, max: 1.7976931348623157E308 gameCapacityResolvedTimeoutMillis
Maximum duration, in milliseconds, the platform will wait for capacity to resolve for a game instance before ejecting it. Long min: -9223372036854775808, max: 9223372036854775807
pragma.datarights.DataRightsWaitingPeriodConfig #
Data rights waiting period configurations.
- Configuration Values:
field description type values/constraints accountDeletion
Number of days to wait before actually deleting the player account. Int min: 0, max: 2147483647 personalData
Number 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 username
username to use String minLength: 1 password
password to use EncryptedString minLength: 0 host
host String minLength: 0 port
port Int min: -2147483648, max: 2147483647
pragma.auth.KeyPairConfig #
Public and Private Keys
- Configuration Values:
field description type values/constraints public
Public key used to validate JWTs String minLength: 1 private
Private key used to sign JWTs EncryptedString minLength: 1
pragma.fleet.PartnerConnectionInfoConfig #
Connection configuration for Pragma Partner endpoints.
- Configuration Values:
field description type values/constraints protocol
Pragma Engine partner protocol (http/https) String minLength: 0 host
Pragma Engine partner host name String minLength: 0 port
Pragma Engine partner port Int min: -2147483648, max: 2147483647
pragma.party.GameServerVersionCompatibility #
Map of server version to compatible client versions configuration.
- Configuration Values:
field description type values/constraints serverVersion
Game server version string, must not be empty. String minLength: 0 clientVersions
Game 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 appConfig
Steam app configuration for entitlement processing. Object of type SteamAppConfig SteamAppConfig
demo.account.FakeAuthIdentityProviderPlugin$Config #
Fake Auth Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
identityProvider
The string name of the id provider this is faking String minLength: 0
pragma.gateway.FilePortalModulePlugin$Config #
File Portal Router plugin configuration.
- Configuration Values:
field description type values/constraints portalSource
The path to the portal resource files. String minLength: 0 redirectSignInToSocial
Can be used to disable the social sign-in redirect. Boolean options: true
,false
content
A 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 capacityPerServer
Amount of matches a server can run concurrently Int min: -2147483648, max: 2147483647 fleetId
FleetId for Multiplay API calls String minLength: 0 projectGuid
Project GUID for Multiplay API calls String minLength: 0 accessKey
Clanforge Access Key for signing REST API calls to Multiplay String minLength: 0 secretAccessKey
Clanforge Secret Access Key for signing REST API calls to Multiplay EncryptedString minLength: 0 useAllocateV2
Feature toggle to enable using Multiplay AllocateV2 Boolean options: true
,false
pragmaGamePartnerBackendAddress
Tells the Multiplay game server where the Pragma Game Partner gateway is, and is only used when AllocateV2 is enabled String minLength: 0 gameServerZoneToMultiplayRegionId
Map of gameServerZone to Multiplay region id Map of String minLength: 0 serverPoolConfigs
Configuration data for unique Multiplay profiles Map of Object of type ServerPoolConfig ServerPoolConfig pragmaBackendAddressParam
Name of pragma backend address parameter in Multiplay allocation payload. Default value: pragmaBackendAddress String minLength: 0 serverPoolIdParam
Name of server pool id parameter in Multiplay allocation payload. Default value: serverPoolId String minLength: 0 gameTokenParam
Name of game token parameter in Multiplay allocation payload. Default value: gameToken String minLength: 0 socialTokenParam
Name 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 playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
allowedDomains
A map of domains that are allowed to use Google to authenticate (e.g. pragma.gg) Map of String minLength: 0 clientSecret
your app’s secret key (provided by Google) EncryptedString minLength: 0 clientId
your app’s id (provided by Google) String minLength: 0 redirectUri
your 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 playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
authorizationUri
your app’s user info url String minLength: 0 tokenUri
your app’s authorization token url String minLength: 0 userInfoUri
your app’s user info url String minLength: 0 clientSecret
your app’s secret key EncryptedString minLength: 0 clientId
your app’s id String minLength: 0 redirectUri
your app’s redirect URI String minLength: 0 requireEmailVerification
whether 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 processCommand
Full command line including parameters run the process. Map of String minLength: 0 serverIdParam
Name of the command line param to append with the allocated server id. String minLength: 0 serverPoolIdParam
Name of the command line param to append with the server pool id. String minLength: 0 logPathParam
Name of the command line param to append with the program log path, and this will result in a file inside logOutputPath. String minLength: 0 logOutputPath
Path to a folder where to redirect log output. String minLength: 0 maximumLocalServers
Maximum number of local servers this provider can support. Int min: -2147483648, max: 2147483647 portParam
Name of the command line param to append with the allocated host port value. String minLength: 0 minPort
Minimum value of the game server host port. Int min: -2147483648, max: 2147483647 maxPort
Maximum value of the game server host port. Int min: -2147483648, max: 2147483647 serverPoolConfigs
Server pool configurations. Map of Object of type LocalProcessServerPoolConfig LocalProcessServerPoolConfig
pragma.account.config.UnsafeIdProviderConfig #
Unsafe Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If 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 playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
clientSecret
your app’s secret key (provided by Twitch) EncryptedString minLength: 0 clientId
your app’s id (provided by Twitch) String minLength: 0 redirectUri
your 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 appConfig
Steam app config for payment processing Object of type SteamAppConfig SteamAppConfig defaultCurrencyCode
the default currency code to use when a player’s configured currency is not configured for a product entry. Enum CurrencyCode allowed values: UNUSED_CURRENCY
,USD
,EUR
,CAD
,AED
,ARS
,AUD
,BRL
,CHF
,CLP
,CNY
,COP
,CRC
,GBP
,HKD
,ILS
,IDR
,INR
,JPY
,KRW
,KWD
,KZT
,MXN
,MYR
,NOK
,NZD
,PEN
,PHP
,PLN
,QAR
,RUB
,SAR
,SGD
,THB
,TRY
,TWD
,UAH
,UYU
,VND
,ZAR
,UNRECOGNIZED
pragma.telemetry.s3.S3TelemetryPluginConfig #
Configuration for the S3 Telemetry Plugin
- Configuration Values:
field description type values/constraints eventBatchSize
number 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 timeWindowPerBatchMillis
the period in millis that the batch is sent to S3 Long min: 1, max: 9223372036854775807 s3BucketName
the name of the s3 bucket to store telemetry files String minLength: 0 shardName
the 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 clientId
ID of your client in the Epic Dev Portal. String minLength: 0 clientSecret
Encrypted string representing your client’s secret in the Epic Dev Portal. EncryptedString minLength: 0 sandboxId
ID of the sandbox to operate on. String minLength: 0 deploymentId
ID of the corresponding deployment in the Epic Dev Portal. String minLength: 0 clawbackPollIntervalHours
How often to call the Epic clawback endpoint in hours Int min: 1, max: 24 clawbackPollingEnabled
Enables the Epic Order Provider to poll the clawback endpoint Boolean options: true
,false
pragma.account.config.EmailIdProviderConfig #
Email Id Provider configuration.
- Configuration Values:
field description type values/constraints privateKey
an 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 playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
clientId
your product’s client id (provided by Epic) String minLength: 0 clientSecret
your product’s client secret (provided by Epic) EncryptedString minLength: 0 redirectUri
your app’s redirect URI, as defined with Epic String minLength: 0 restrictByCatalogItemOwnership
Prevent authentication if the player does not own the catalog item specified by catalogItemId Boolean options: true
,false
sandboxId
your product’s sandbox id (provided by Epic) String minLength: 0 deploymentId
your product’s deployment id (provided by Epic) String minLength: 0 catalogItemId
your catalog item’s id (provided by Epic, Audience Item Id or Game Item Id) String minLength: 0
demo.fleet.LoadTestingGameServerFleetPlugin$Config #
Generic load testing fleet plugin configuration.
- Configuration Values:
field description type values/constraints serverPoolId
Game server pool id. String minLength: 0 managementPolicyConfigId
Server pool management policy config 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 providerAPIKey
the API key that will enable you to send emails with your provider EncryptedString minLength: 0 apiUrl
base URL for the provider API to interact with String minLength: 0 route
the HTTP route for the provider String minLength: 0 verificationTemplateId
id of the email template to send String minLength: 0 fromEmail
verified email address associated with the account in sendinblue that this email will be sent from String minLength: 0 fromName
name displayed String minLength: 0
pragma.gateway.PostmanRoutePlugin$Config #
Postman Route Plugin configuration.
- Configuration Values:
field description type values/constraints pathToPostmanFiles
path to postman files String minLength: 0 collectionName
path to postman files String minLength: 0 environmentName
path to postman files String minLength: 0
pragma.metrics.StatsdRegistryProvider$Config #
Statsd metrics registry provider configuration.
- Configuration Values:
field description type values/constraints flavor
flavor of statsd Enum StatsdFlavor allowed values: ETSY
,DATADOG
,TELEGRAF
,SYSDIG
host
host to send stats String minLength: 0 port
port to send stats Int min: -2147483648, max: 2147483647 protocol
protocol to send stats Enum StatsdProtocol allowed values: UDP
,UDS_DATAGRAM
,TCP
maxPacketLength
max packet length to send stats Int min: -2147483648, max: 2147483647 pollingFrequencySeconds
polling frequency to send stats Int min: -2147483648, max: 2147483647 stepSeconds
step size to compute windowed statistics Int min: -2147483648, max: 2147483647 publishUnchangedMeters
whether to publish unchanged meters Boolean options: true
,false
buffered
whether to buffer metrics sent Boolean options: true
,false
pragma.metrics.DatadogRegistryProvider$Config #
Datadog metrics registry provider configuration
- Configuration Values:
field description type values/constraints apiKey
Datadog API key EncryptedString minLength: 0 applicationKey
Datadog application key EncryptedString minLength: 0 descriptions
whether to send descriptions metadata Boolean options: true
,false
hostTag
host tag when shipping metrics String minLength: 0 uri
URI to ship metrics to String minLength: 0
demo.pragmaconfidential.xbox.XboxS2SConfig #
Xbox Entitlement Provider configuration.
- Configuration Values:
field description type values/constraints businessPartnerCertificate
The base64 encoded Business Partner certificate. EncryptedString minLength: 0 businessPartnerPrivateKeyPassword
The password to decrypt the BusinessPartner private key. EncryptedString minLength: 0 relyingPartyCertificate
The base64 encoded RelyingParty certificate. String minLength: 0 relyingPartyPrivateKey
The base64 encoded RelyingParty private key. EncryptedString minLength: 0 privateKeyPassword
The password to decrypt the private key. EncryptedString minLength: 0
pragma.gameinstance.LocalProcessGameServerProviderPluginConfig #
Local process game host plugin configuration.
- Configuration Values:
field description type values/constraints serverExecutablePath
Path to the executable for running the game server String minLength: 0 serverLogDirectory
Path to a directory to store server logs, relative to the pragma-engine execution. Creates the directory if it does not exist. String minLength: 0 gameInstanceIdParam
Command line argument parameter name for the game instance id, defaults to -PragmaGameInstanceId String minLength: 0 socialTokenParam
Command line argument parameter name for the social token, defaults to -PragmaSocialToken String minLength: 0 gameTokenParam
Command line argument parameter name for the game token, defaults to -PragmaGameToken String minLength: 0 pragmaBackendAddressParam
Command line argument parameter name for the pragma backend address, defaults to -PragmaBackendAddress String minLength: 0 portParam
Command line argument parameter name for the port the game server should use, defaults to -Port String minLength: 0 minPort
Starting port number for game server to use, defaults to 7777 Int min: -2147483648, max: 2147483647 maxPort
Ending port number for game server to use, defaults to 7777 Int min: -2147483648, max: 2147483647 additionalArguments
Additional command line arguments to be passed to the game server Map of String minLength: 0 usePlayInEditorGameServer
Use 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 url
full URL (including protocol and port) to reach the Nomad API URL capacityPerServer
amount of games a server can run concurrently Int min: -2147483648, max: 2147483647 executableName
name of the executable such as ‘gameServer.sh’ String minLength: 0 args
command line args to pass to the start game server script, and chains together map values, ordered by key Map of String minLength: 0 jobCpu
Amount of cpu to allocate per task instance in MHz. See https://developer.hashicorp.com/nomad/docs/job-specification/resources#cpu Int min: -2147483648, max: 2147483647 jobDatacenter
Nomad Datacenter to allocate new task instance. See https://developer.hashicorp.com/nomad/api-docs/json-jobs#datacenters String minLength: 0 jobMemory
Amount of memory to allocate per task instance in MB. See https://developer.hashicorp.com/nomad/docs/job-specification/resources#memory Int min: -2147483648, max: 2147483647
demo.account.DemoIdentityProviderPlugin$Config #
Demo Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
demo.account.DemoExtIdentityProviderPlugin$Config #
Demo Ext Identity Provider plugin configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
pragma.account.config.DiscordIdProviderConfig #
Discord Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
clientSecret
your app’s secret key (provided by Discord) EncryptedString minLength: 0 clientId
your app’s id (provided by Discord) String minLength: 0 guildId
your guild id, also known as server id String minLength: 0 redirectUri
your app’s redirect URI, as defined with Discord String minLength: 0 botToken
bot token associated with your Discord Server’s bot EncryptedString minLength: 0 allowedRoleIds
set of guild role ids that provide access to Pragma Engine social backend Map of String minLength: 0
demo.datarights.DemoDataRightsPlugin$Config #
Demo Data Rights plugin configuration.
- Configuration Values:
field description type values/constraints
pragma.shared.SteamAppConfig #
Steam application configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
steamWebAPIKey
your app’s secret web API key (provided by Steam) EncryptedString minLength: 0 appId
your app’s id (provided by Steam) String minLength: 0 restrictByAppOwnership
Prevent authentication if the player does not own the app specified by appId Boolean options: true
,false
restrictByAccountBan
Prevent 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 playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
allowedDomains
A map of domains that are allowed to use Google to authenticate (e.g. pragma.gg) Map of String minLength: 0 clientSecret
your app’s secret key (provided by Google) EncryptedString minLength: 0 clientId
your app’s id (provided by Google) String minLength: 0 redirectUri
your app’s redirect URI, as defined with Google String minLength: 0
demo.account.DemoAccountPlugin$Config #
Account plugin configuration.
- Configuration Values:
field description type values/constraints waitingPeriodInDays
The number of days between name changes. Long min: -9223372036854775808, max: 9223372036854775807
demo.gameinstance.GameFlowGameInstancePlugin$Config #
GameFlowGameInstancePlugin plugin configuration.
- Configuration Values:
field description type values/constraints matchDurationMillis
the duration of game in milliseconds Long min: -9223372036854775808, max: 9223372036854775807 matchDurationVarianceMillis
the potential variation above/below the defined match duration in milliseconds Long min: -9223372036854775808, max: 9223372036854775807 setRichPresencePercentage
the potential chance to set a rich presence for all players in a match Double min: -1.7976931348623157E308, max: 1.7976931348623157E308
demo.pragmaconfidential.xbox.XboxIdentityProviderPlugin$Config #
XBox Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
relyingParty
Url of the RelyingParty: ‘rp://yourdomain.com/’ String minLength: 0 relyingPartyCertificate
The base64 encoded RelyingParty certificate. String minLength: 0 relyingPartyPrivateKey
The base64 encoded RelyingParty private key. EncryptedString minLength: 0 privateKeyPassword
The password to decrypt the private key. EncryptedString minLength: 0 clientSecret
your app’s secret key (provided by Xbox) EncryptedString minLength: 0 clientId
your app’s id (provided by Xbox) String minLength: 0 redirectUri
your app’s redirect URI, as defined with Xbox String minLength: 0 useXid
Use the XUID/xid claim as the user’s ID rather than the pXUID/ptx claim (xid claim requires Xbox approval before it can be added to your relying party) Boolean options: true
,false
sandbox
The Xbox sandbox you are logging in to. This is used for the web login path only. Defaults to ‘RETAIL’ String minLength: 0
pragma.inventory.EpicEntitlementConfig #
Epic entitlement provider plugin configuration.
- Configuration Values:
field description type values/constraints sandboxId
ID of the sandbox to operate on. String minLength: 0 deploymentId
ID of the corresponding deployment in the Epic Dev Portal. String minLength: 0 clientId
ID of your client in the Epic Dev Portal. String minLength: 0 clientSecret
Encrypted string representing your client’s secret in the Epic Dev Portal. EncryptedString minLength: 0
demo.pragmaconfidential.playstation.PlaystationApiConfig #
Playstation Id Provider configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
redirectUri
your app’s redirect URI, as defined with Playstation String minLength: 0 ps4ClientId
your app’s id (provided by Playstation) String minLength: 0 ps4ClientSecret
your app’s client secret (provided by Playstation) EncryptedString minLength: 0 ps5ClientId
your app’s id (provided by Playstation) String minLength: 0 ps5ClientSecret
your app’s client secret (provided by Playstation) EncryptedString minLength: 0 ps5EnvironmentHost
The playstation host url per environment String minLength: 0 authorizeHost
The playstation authorize url for browser authentication String minLength: 0 serviceLabels
Service labels as configured on your App Server Map of String minLength: 0 ps4TokenEndpointHost
The playstation 4 host url for getting tokens String minLength: 0 ps4UsersMeEndpointHost
The playstation 4 host url for getting user info String minLength: 0
demo.party.DemoPartyPluginConfig #
Generic Local Process fleet plugin configuration.
- Configuration Values:
field description type values/constraints inventoryTagsToInclude
Tags used to filter player inventories, and items that match one or more tags will be included. NO LONGER AUTOMATICALLY USED BY THE ENGINE AS OF 0.1.0. Map of String minLength: 0
pragma.inventory.TwitchEntitlementConfig #
Twitch Drop entitlement provider plugin configuration.
- Configuration Values:
field description type values/constraints clientId
ID of your client in the Twitch Dev Portal String minLength: 0 clientSecret
Secret of your client in the Twitch Dev Portal EncryptedString minLength: 0 gameId
The 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 steamWebAPIKey
your app’s secret web API key (provided by Steam) EncryptedString minLength: 0 appId
your app’s id (provided by Steam) String minLength: 0
pragma.datarights.DefaultDataRightsGamePlugin$Config #
Data Rights plugin configuration.
- Configuration Values:
field description type values/constraints enableLegacyInventoryDataCollection
Package 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 numberOfTeams
number of teams required for the game Int min: 1, max: 2147483647 playersPerTeam
number 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 clientId
ID of your client in the Twitch Dev Portal String minLength: 0 clientSecret
Secret of your client in the Twitch Dev Portal EncryptedString minLength: 0 gameId
The 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 playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
allowedDomains
A map of domains that are allowed to use Google to authenticate (e.g. pragma.gg) Map of String minLength: 0 clientSecret
your app’s secret key (provided by Google) EncryptedString minLength: 0 clientId
your app’s id (provided by Google) String minLength: 0 redirectUri
your app’s redirect URI, as defined with Google String minLength: 0
pragma.shared.SteamAppConfig #
Steam application configuration.
- Configuration Values:
field description type values/constraints playerLoginEnabled
If this id provider is enabled for player login. Boolean options: true
,false
operatorLoginEnabled
If this id provider is enabled for operator login. Boolean options: true
,false
accountLinkingEnabled
If this id provider is enabled for account linking. Boolean options: true
,false
showPortalLoginButton
If this id provider is shown in the portal login options. Boolean options: true
,false
visibleToOtherPlayers
If the information about this id provider can be shared with other players. Boolean options: true
,false
steamWebAPIKey
your app’s secret web API key (provided by Steam) EncryptedString minLength: 0 appId
your app’s id (provided by Steam) String minLength: 0 restrictByAppOwnership
Prevent authentication if the player does not own the app specified by appId Boolean options: true
,false
restrictByAccountBan
Prevent 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 serverPoolId
Game server pool id. String minLength: 0 managementPolicyConfigId
Server pool management policy config id. String minLength: 0 profileId
The Multiplay profileId for API calls String minLength: 0 regionId
The region supported by this server pool String minLength: 0
pragma.fleet.LocalProcessServerPoolConfig #
Configuration for a server pool.
- Configuration Values:
field description type values/constraints serverPoolId
Game server pool id. String minLength: 0 managementPolicyConfigId
Server pool management policy config id. String minLength: 0 gameServerVersions
Game server versions supported by this server pool. Map of String minLength: 0