Game Guides

This page is part of the hizi engine SDK docs. It gives guides for reading game responses from specific hizi engine game types. The SDK calls are the same for every game. Each guide explains the scenario data structure that the game's placeBet returns. Each guide also explains how to integrate the data into your frontend.

You may want to test a specific outcome, such as a big win, a bonus trigger, or a bust. If so, see Cheating. Do not wait for a natural result from the random number generator (RNG).

Available Guides

Slot Games

This guide explains how to read Slot game responses (the IResult shape from @hizi.io/engine-sdk). Topics include boards, wins, cascades, hold & win, sticky symbols, multiplier collection, and wheel features.

Plinko

This guide explains how to read Plinko game responses. It covers bucket indexes and the animation of the ball drop. It also covers selection of row and risk through buy features (an option to pay for a bonus feature). It covers multiplier lookup from loadConfig.

Frogger

This guide explains how to read Frogger game responses. It covers the multi-step flow for the wager stake. It also covers selection of risk through buy features. It covers the cashout multiplier ladder from loadConfig and the collect-or-continue game loop.

Mines

This guide explains how to read Mines game responses. It covers how to send pick positions through additionalData. It covers how to read the board array for tile states. It also covers selection of mine count through buy features. It covers progression of the cashout multiplier and the collect-or-continue game loop.

Hi/Lo

This guide explains how to read Hi/Lo game responses. It covers the higher/lower/skip flow driven by playerChoice. It covers dynamic card odds and skip re-dealing within the same round. It also covers multiplier rounding and the collect-or-continue game loop.

Keno

This guide explains how to read Keno game responses. It covers how to send player numbers through additionalData (or auto-pick). It covers how to read playerNumbers and drawnNumbers from the enriched scenario. It also covers selection of pick count and risk through buy features. It covers rendering of the pay table.

Bingo

This guide explains how to read Bingo 75 and Bingo 90 responses. It covers how to buy 1–6 tickets through additionalData. It covers how to read tickets[], which has per-cell daub states. It also covers the per-ticket wins[] list of pattern instances (contained patterns stack). It covers the differences between the variants and the paytable for both. It also covers the math for hypergeometric coverage.

Over/Under

This guide explains how to read Over/Under game responses. It covers instant resolution with a single roll. It also covers selection of threshold and direction through buy features. It covers multiplier lookup and the calculation of the win.

Roulette

This guide explains how to read Roulette game responses. It covers how to compose multi-bet rounds through additionalData. It covers the polymorphic selection shape for each bet type. It also covers the per-bet settlement[] array, which has won, payout, and winAmount. It covers the enriched scenario fields (color, oddEven, dozen, column). It also covers the two mechanisms for RTP (return to player).

Blackjack

This guide explains how to play Blackjack through placeBet. It covers the initial deal, which can have optional side bets. It covers the multi-step flow of actions (hit/stand/double/split/insurance/evenMoney), driven by playerChoice. It also covers how to read the final IBlackjackScenario. This scenario has the dealer, the hands, the side-bet results, and the insurance payouts.

Crash

This guide explains how to play Crash. It covers how to open a round with one or more bets through crashPlaceBetData. It covers how to listen to the server-driven curve over websocket events (roundStarted, roundTick, betCashedOut, roundEnded, balanceUpdated). It also covers how to trigger a manual cashout through collect and crashCollectData.