Game Client Configuration

There are two configuration surfaces:

SdkConfig — provided by the wrapper to the game. It becomes available on sdk.config after openGame() resolves (accessing it earlier throws). The game MUST treat it as read-only.
WrapperConfig — sent by the game to the wrapper via sdk.configure(...), before openGame().

// Game -> wrapper (before openGame)
await sdk.configure({ gameName: 'myGame', gameVersion: '1.0.0' })

await sdk.openGame()

// Wrapper -> game (after openGame)
const config: SdkConfig = sdk.config

The authoritative, generated reference is SdkConfig.

SdkConfig.api

Session and integration parameters. The game SHOULD NOT need most of these — they exist for the wrapper and plugins — but they are exposed for display and integration-specific logic.

Field	Type	Description
`brand`	`string`	Brand (casino operator) identifier. Default: `''`.
`cashierUrl`	`string \| undefined`	URL of the casino cashier, when the integration provides one.
`coinValueInCents`	`number`	Value of one coin in cents; used to convert coin amounts to money. Default: `1`.
`country`	`string`	Player country code. Default: `''`.
`currency`	`string`	Player currency code. Default: `''`.
`game`	`string`	Game identifier (game code). Default: `''`.
`gameHistoryUrl`	`string`	URL of the game history service. Default: `''`.
`homeUrl`	`string \| undefined`	Casino lobby / home URL, when provided by the integration.
`integration`	`string`	Casino integration identifier. Default: `''`.
`integrationData`	`unknown`	Opaque integration-specific payload passed through by the casino plugin.
`jurisdiction`	`string \| null`	Regulatory jurisdiction code, or `null` when not set. Default: `null`.
`playMode`	`'FUN' \| 'REAL'`	Whether the session is for fun (demo) or real money. Default: `'FUN'`.
`user`	`string`	User identifier. Default: `''`.
`username`	`string`	Display username. Default: `''`.
`sessionId`	`string`	Session identifier. Default: a random UUID.
`backendSessionId`	`string \| undefined`	Backend (RGS) session identifier, when distinct from `sessionId`.

SdkConfig.ui

UI parameters MUST be used to change how the Game Client UI is presented to players.

feature

Boolean flags toggling wrapper/game UI elements and capabilities. All default to false except showCurrency, showPromoPanel and showUi, which default to true.

Flag	Description
`allowTelemetry`	Enables telemetry event collection.
`allowFullscreen`	Allows switching the game to fullscreen.
`allowGamble`	Allows the gamble feature.
`allowQuickStop`	Allows the player to quick-stop a spin (implies no minimum spin duration).
`showCashier`	Shows the cashier entry point.
`showClock`	Shows the clock in the wrapper UI.
`showCloseGame`	Shows the close-game button.
`showCurrency`	Shows the currency symbol next to monetary amounts.
`showDeconstructedBet`	Shows the bet deconstructed into base bet and multiplier.
`showFastPlay`	Shows the fast-play (turbo) option.
`showFeatureBuy`	Shows the feature-buy option.
`showFeatureIntro`	Shows the feature intro screen.
`showFeatureOutro`	Shows the feature outro screen.
`showFunModeBanner`	Shows a banner indicating fun (demo) mode; only applies when `playMode` is `'FUN'`.
`showHistory`	Shows the game-history entry point.
`showLowWinCelebration`	Shows a celebration for low wins.
`showMaximumWin`	Shows the maximum-win information.
`showNetPosition`	Shows the player's net position for the session.
`showPaylineLines`	Shows payline lines on wins.
`showPaytable`	Shows the paytable entry point.
`showPromoPanel`	Shows the promo panel.
`showRoundId`	Shows the round identifier.
`showRtp`	Shows the RTP value.
`showRules`	Shows the game-rules entry point.
`showSessionDuration`	Shows the elapsed session duration.
`showUi`	Shows the game UI as a whole.

autoplay

Field	Type	Default	Description
`enabled`	`boolean`	`false`	Enables autoplay.
`rounds`	`AutoplayLimit`	disabled	Limit on the number of autoplay rounds.
`lossLimit`	`AutoplayLimit`	disabled	Autoplay stop condition based on accumulated loss.
`winLimit`	`AutoplayLimit`	disabled	Autoplay stop condition based on a single/accumulated win.
`simple`	`boolean`	`false`	Uses the simplified autoplay UI (no limit configuration).
`stopOnFeature`	`boolean`	`false`	Stops autoplay when a feature is triggered.

type AutoplayLimit = {
  enabled: boolean
  showNoLimit: boolean // offer a "no limit" option
  showCustomLimit: boolean // allow entering a custom value
  options: number[] // predefined values to choose from
}

Each AutoplayLimit defaults to { enabled: false, showNoLimit: false, showCustomLimit: false, options: [] }.

realityCheck

Controls which elements the reality-check popup presents.

type RealityCheckConfig = {
  sessionDurationPeriodFormat: 'seconds' | 'minutes' | 'hours'
  showCloseGame: boolean
  showHistory: boolean
  showNetPosition: boolean
  showSessionDuration: boolean
  showSumBets: boolean
  showSumWins: boolean
}

Defaults: sessionDurationPeriodFormat: 'minutes', all show* flags false.

cashier

type CashierConfig = {
  enabled: boolean
  balanceThreshold: number[] // balance levels below which the cashier is suggested
}

Default: { enabled: false, balanceThreshold: [0] }.

Other UI parameters

Field	Type	Default	Description
`language`	`string`	`'en'`	UI language code. See Localization.
`minimumSpinDuration`	`number`	`0`	Minimum spin duration the game MUST honour (regulatory requirement in some jurisdictions).
`requestTimeoutMs`	`number`	`10000`	Timeout for RGS requests in milliseconds.
`incompleteGameResolution`	see below	`{ type: 'NONE' }`	How incomplete game rounds are resolved.
`skipInsufficientFundsCheck`	`boolean`	`false`	Skips the client-side insufficient-funds check before play.
`skipSplash`	`boolean`	`false`	Skips the splash screen.
`cheatPanel`	`boolean`	`false`	Enables the cheat panel (dev/test environments only).

type IncompleteGameResolution =
  | { type: 'NONE' | 'MANUAL' }
  | { type: 'AUTOMATIC'; daysToAutoResolution: number }

WrapperConfig

The game MUST call sdk.configure(...) before openGame(). The payload is Partial<WrapperConfig> — omitted fields keep the wrapper defaults.

Field	Type	Description
`gameName`	`string`	Name of the game.
`gameVersion`	`string`	Version of the game build.
`sdkVersion`	`string`	SDK version. Auto-filled by `configure()` with the running SDK's version — the game MUST NOT set it.
`showFreeRounds`	`boolean`	Whether the wrapper handles the free-rounds UI.
`showPromoPanel`	`boolean`	Whether the wrapper shows the promo panel.
`showRealityCheck`	`boolean`	Whether the wrapper shows the reality-check popup.
`showErrors`	`boolean`	Whether the wrapper displays error popups.
`showBars`	`boolean`	Whether the wrapper renders the top/bottom UI bars.
`skipErrors`	`(RgsErrorCode \| 'TIMEOUT')[]`	RGS error codes the wrapper MUST NOT handle, leaving handling to the game. See Error Handling.

SdkConfig.api​

SdkConfig.ui​

feature​

autoplay​

realityCheck​

cashier​

Other UI parameters​

WrapperConfig​