Skip to content

Frontend settings reference

login and refresh return gameSettings. The remote gaming server (RGS) resolves profiles and overrides before sending these settings.

The TypeScript interface declares many required properties. Actual replies can omit properties or contain null values. Validate the reply. Resolve missing values through the agreed integration profile. Do not treat a missing permission as permission to enable a feature.

Apply settings to every input path, including keyboard shortcuts and Operator Interface events. Reapply settings after refresh. A local preference cannot enable an operator-disabled function.

Bets and gameplay

SettingFrontend requirement
minStake, maxStakeValidate the selected base stake. Use effective reply amounts. See stake precedence.
customStakesReplace the default ladder when nonempty. Apply independent legal and player limits.
defaultStakeIndexSelect a valid index in the final displayed ladder.
forceDefaultStakeIgnore the saved stake at a new session. Preserve the stake of an open round.
maxExposureDisplay the configured cap where required. Honor capped results and early round closure.
packageBuyEnabledGate slot bonus purchases. Other verticals need an agreed mapping for table selection.
maxPackageStakeCheck purchase limits. Current handlers compare the base stake; the frontend must also check the complete cost.
gambleEnabledGate elective slot gambles. Keep collection available when the engine offers it. Do not hide mandatory bonus choices.
partialCollectEnabledGate banking part of a win. Explain that banking can leave the money inside the round.
autoplayEnabledGate the autoplay menu and every automatic paid-start path.
autoplayLossLimitRequiredRequire a valid loss limit before autoplay starts. Stop when the limit is reached.
autoplayShowTotalStakeShow stake × selected round count in the autoplay confirmation.
turboEnabledGate faster presentation. Disabled turbo also applies to wrapper requests and stored preferences.
stopEnabledGate early stopping of presentation. Never change the outcome or bypass timing.
minSpinTimeEnforce milliseconds between accepted cycle starts. See timing.
dynamicMinSpinTimeSelect the approved timing policy. Do not infer an averaging algorithm from this boolean.
multipleInstancesAllowedPrevent your frontend from offering simultaneous games when false. Coordinate session enforcement with the operator.
reportAnimationEndReport completed presentation to the RGS. Await success before another action.

Loading, rules, and amounts

SettingFrontend requirement
loadMsgDisplay the supplied loading message as text.
minLoadTimeMinimum visible loading interval in milliseconds. Start it when the required message appears.
displayPaytableOnEnterGameShow the rules or paytable before play.
displayRTPShow the configured return-to-player (RTP) percentage in the rules.
showExactRTPPreserve supplied precision. Do not invent missing decimal places.
displayXRTPShow experienced RTP only for games with an approved definition and source. It is not theoretical config.rtp.
displayWinOddsDisplay requested maxWin and/or maxPayout odds. Verify availability and correctness before release.
displayJackpotOddsDisplay approved jackpot odds. Do not substitute a progression meter for probability.
skipWinsEqualToOrLessThanStakeSuppress win celebrations for a return no greater than the total amount staked. Still display the result.
displayCoinsLegacy coin display. It must not replace a required currency amount.
displayCurrencyControl the configured currency display. A legal requirement takes precedence over a cosmetic setting.
currencyToDisplayUse the agreed display label. Do not change amounts or currency sent to the server.
abbreviateAmountsAbbreviate only where the integration permits it, normally social mode. Keep exact amounts accessible.
isSocialApply social presentation. Do not infer it from a zero balance or demo tickets.
hideDemoBalanceHide the demo balance when requested. Keep stake and result controls understandable.
hideCompanyLogoHide the provider logo where configured. Preserve required attribution and regulatory information.
translateErrorsMap recognized error codes to approved local text. Preserve operator-supplied messages and actions.

Sessions and responsible gambling

SettingFrontend requirement
jurisdictionSelect the tested jurisdiction configuration. This is not a country code or proof of certification.
rcEnabledEnable the agreed reality-check flow. Do not start a second reminder system when the operator owns it.
rcIntervalReality-check interval in milliseconds. The SDK's seconds comment is incorrect.
rcDisplayWinLossInclude confirmed session win/loss values in the reminder.
displayClockDisplay the current clock. This differs from elapsed session time.
displaySessionTimerDisplay elapsed session time. The SDK type also permits a string. The platform sends only a boolean. Treat a string as an operator-specific extension.
displayNetPositionDisplay session winnings minus stakes. Exclude deposits and withdrawals.
sessionTimeoutInSecondsInactivity limit in seconds. A zero value disables this timeout where the profile permits it.
operatorHandlesErrorsForward errors through Operator Interface. Keep play blocked until the integration resolves them.

A true rcEnabled without a usable interval requires integration configuration. Do not silently omit the reminder. login() does not return gameVariables.rcElapsed, so agree the owner of the elapsed time with the operator. See what login() does not return.

SettingFrontend requirement
homeEnabledShow the home control only when allowed.
homeURLFallback destination for the lobby. Prefer the wrapper action where required.
historyURLDestination for account or game history.
topupURLDestination for deposits. Do not change balances locally after navigation.
lossLimitURLDestination for responsible-gambling limits.
redirectTargetUse self, parent, or top as configured.
preventRedirectPrevent automatic navigation. Use the operator's control or an explicit player action as agreed.
refreshDisabledGate the game's reload controls and operator-requested refresh flow.
launcherTypeDistinguish reelLink and online launch behavior. Read the ReelLink adapter.

Preferences and device behavior

SettingFrontend requirement
forceOrientationSDK values: 0 none, 1 landscape, 2 portrait. Hizi configuration also uses corresponding strings. Normalize the received value.
disableFullScreenMobilePrevent automatic mobile fullscreen.
doNotStoreSettingsDo not persist listed preferences. The platform currently defines autoplay.
turboDefaultEnabledAdditional platform field. Start turbo only when turboEnabled also permits it.
performanceModeAdditional platform field: enabled, landscape, or portrait. Reduce costly animation in the selected mode. Preserve outcome information.
progressionAnimationsAdditional platform field. Gate progression animations while preserving counter values and awards.

The last three fields exist in Hizi configuration but lack explicit SDK properties. Access them through the settings index signature. Check types at runtime.

There is no standard loadingScreens or mute setting in this interface. Build loading screens locally. Use Operator Interface audio events and player preferences for mute state.

Apply defaults deliberately

Use strict boolean checks after normalization. The string "false" is truthy in JavaScript. Do not use Boolean(value) on unvalidated settings.

Resolve an absent restrictive setting from a reviewed integration profile. Keep paid play disabled if required limits or legal behavior remain unknown. Include the resulting settings object in acceptance fixtures, with credentials removed.

The contract audit identifies source versions and implementation gaps. The release checks define the cases to exercise.