Stake Engine

https://stake-engine.com/docs
Admin
Stake Engine is a comprehensive development kit for creating, simulating, and optimizing slot games...
Tokens:52,594
Snippets:406
Trust Score:6
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example Replay Request

Source: https://stake-engine.com/docs/approval-guidelines/game-replay-requirements

Example GET request to the RGS server using a specific game ID, version, mode, and event. The response contains the replay state.

```http
GET https://rgsd.engine.io/bet/replay/01996148-eecf-7678-be46-41de88c58951/1/SUPER/55
```

--------------------------------

### Example betLevels configuration

Source: https://stake-engine.com/docs/rgs

Shows the structure of the betLevels array returned from /wallet/authenticate, with minBet, maxBet, stepBet, and a list of bet levels. The example includes comments indicating the USD values for the first and last entries.

```json
{
  "minBet": 100000,
  "maxBet": 1000000000,
  "stepBet": 10000,
  "betLevels": [
    100000, // $0.10
    200000,
    400000,
    600000,
    ...
    1000000000 // $1000
  ]
}
```

--------------------------------

### Lines.record_lines_wins() example

Source: https://stake-engine.com/docs/math/utilities

Example of how Lines.record_lines_wins() records wins with the required format.

```python
def record_line(kind: int, symbol: str, mult: int, gametype: str) -> None:
    """Force file description for line-win."""
    gamestate.record({"kind": kind, "symbol": symbol, "mult": mult, "gametype": gametype})
```

--------------------------------

### Example board for Ways calculation

Source: https://stake-engine.com/docs/math/source-files/calculations/ways

Example board layout used to illustrate the Ways calculation. The board shows symbol positions across reels, with H1 appearing on reel 3 with a multiplier.

```text
L5 H1 L4 L4 L4 
L1 H4 L3 H2 L4 
H1 H1 H1 L3 H3
```

--------------------------------

### TumbleBoard.svelte - Task breakdown example

Source: https://stake-engine.com/docs/front-end/task-breakdown

Shows how the TumbleBoard component subscribes to the individual emitter events that make up the tumbleBoard bookEvent. This allows each event to be handled and tested independently.

```svelte
// TumbleBoard.svelte - Example of task-breakdown

context.eventEmitter.subscribeOnMount({
  tumbleBoardShow: () => {},
  tumbleBoardHide: () => {},
  tumbleBoardInit: () => {},
  tumbleBoardReset: () => {},
  tumbleBoardExplode: () => {},
  tumbleBoardRemoveExploded: () => {},
  tumbleBoardSlideDown: () => {},
});
```

--------------------------------

### POST /wallet/play

Source: https://stake-engine.com/docs-content/prompt.md

Places a bet and starts a round, returning the updated balance and round state.

```APIDOC
## POST /wallet/play

### Description
Places a bet and starts a round, returning the updated balance and round state.

### Method
POST

### Endpoint
/wallet/play

### Parameters
#### Request Body
- **sessionID** (string) - Required - Player session identifier.
- **amount** (number) - Required - Bet amount in micro-units (e.g., 1000000 = 1.00).
- **mode** (string) - Required - Game mode.

### Request Example
{
  "sessionID": "string",
  "amount": 1000000,
  "mode": "normal"
}

### Response
#### Success Response (200)
- **balance** (object) - Contains `amount` (number) and `currency` (string).
- **round** (object) - Contains `amount` (number), `payoutMultiplier` (number), `active` (boolean), and `state` (object) with the book's events.

#### Response Example
{
  "balance": {
    "amount": 9000000,
    "currency": "USD"
  },
  "round": {
    "amount": 1000000,
    "payoutMultiplier": 2.5,
    "active": true,
    "state": {}
  }
}
```

--------------------------------

### GET /bet/replay/{game}/{version}/{mode}/{event}

Source: https://stake-engine.com/docs-content/prompt.md

Fetches replay data for a game event. No session is used; the game must make no wallet calls.

```APIDOC
## GET /bet/replay/{game}/{version}/{mode}/{event}

### Description
Fetches replay data for a game event. No session is used; the game must make no wallet calls.

### Method
GET

### Endpoint
/bet/replay/{game}/{version}/{mode}/{event}

### Parameters
#### Path Parameters
- **game** (string) - Required - Game identifier.
- **version** (string) - Required - Math version.
- **mode** (string) - Required - Game mode.
- **event** (string) - Required - Event identifier.

### Response
#### Success Response (200)
- **payoutMultiplier** (number) - Payout multiplier.
- **costMultiplier** (number) - Cost multiplier.
- **state** (object) - Game state.

#### Response Example
{
  "payoutMultiplier": 2.5,
  "costMultiplier": 1,
  "state": {}
}
```

--------------------------------

### bookEventHandlerMap.ts - Task breakdown example

Source: https://stake-engine.com/docs/front-end/task-breakdown

Shows how the tumbleBoard bookEvent is broken down into multiple emitter events, including async broadcasts for explosion and slide-down. This pattern allows step-by-step implementation and testing of complex events.

```typescript
// bookEventHandlerMap.ts - Example of task-breakdown

{
  ...,
  tumbleBoard: async (bookEvent: BookEventOfType<'tumbleBoard'>) => {
    eventEmitter.broadcast({ type: 'boardHide' });
    eventEmitter.broadcast({ type: 'tumbleBoardShow' });
    eventEmitter.broadcast({ type: 'tumbleBoardInit', addingBoard: bookEvent.newSymbols });
    eventEmitter.broadcast({ type: 'soundOnce', name: 'sfx_multiplier_explosion_b' });
    await eventEmitter.broadcastAsync({
      type: 'tumbleBoardExplode',
      explodingPositions: bookEvent.explodingSymbols,
    });
    eventEmitter.broadcast({ type: 'tumbleBoardRemoveExploded' });
    await eventEmitter.broadcastAsync({ type: 'tumbleBoardSlideDown' });
    eventEmitter.broadcast({
      type: 'boardSettle',
      board: stateGameDerived
        .tumbleBoardCombined()
        .map((tumbleReel) => tumbleReel.map((tumbleSymbol) => tumbleSymbol.rawSymbol)),
    });
    eventEmitter.broadcast({ type: 'tumbleBoardReset' });
    eventEmitter.broadcast({ type: 'tumbleBoardHide' });
    eventEmitter.broadcast({ type: 'boardShow' });
  },
  ...,
}
```

--------------------------------

### Ways calculation example with multiplier

Source: https://stake-engine.com/docs/math/source-files/calculations/ways

Shows the calculation of total ways for symbol H1 when a multiplier is applied. The formula multiplies the number of occurrences on each reel, resulting in 6 ways.

```text
(1) * (2) * (3) = 6 ways
```

--------------------------------

### POST /wallet/play

Source: https://stake-engine.com/docs/rgs/wallet

Starts a game round and debits the bet from the player's balance. amount is the base bet, as an integer with six decimal places; the debit is amount multiplied by the mode's cost multiplier. mode is the bet mode name.

```APIDOC
## POST /wallet/play

### Description
Starts a game round and debits the bet from the player's balance. amount is the base bet, as an integer with six decimal places; the debit is amount multiplied by the mode's cost multiplier. mode is the bet mode name.

### Method
POST

### Endpoint
/wallet/play

### Parameters
#### Request Body
- **amount** (integer) - Required - The base bet amount.
- **sessionID** (string) - Required - The session identifier.
- **mode** (string) - Required - The bet mode name.

### Request Example
{
  "amount": 100000,
  "sessionID": "xxxxxxx",
  "mode": "BASE"
}

### Response
#### Success Response (200)
- **balance** (object) - The player's current balance.
  - **amount** (integer) - The balance amount.
  - **currency** (string) - The currency code.
- **round** (object) - The round information.
  - **betID** (integer) - The bet identifier.
  - **amount** (integer) - The bet amount.
  - **payout** (integer) - The payout amount.
  - **payoutMultiplier** (number) - The payout multiplier.
  - **active** (boolean) - Whether the round is active.
  - **mode** (string) - The bet mode.
  - **state** (array) - The game events for the round.

#### Response Example
{
  "balance": {
    "amount": 100000,
    "currency": "USD"
  },
  "round": {
    "betID": 123456,
    "amount": 100000,
    "payout": 200000,
    "payoutMultiplier": 2,
    "active": true,
    "mode": "BASE",
    "state": [ ... ]
  }
}
```

--------------------------------

### Error response body: ERR_VAL example

Source: https://stake-engine.com/docs/rgs/wallet

Errors return a JSON body with an ERR_* code and a short message. Example shows ERR_VAL with message 'invalid amount'.

```json
{
  "error": "ERR_VAL",
  "message": "invalid amount"
}

```

--------------------------------

### Run AI review with Claude Code

Source: https://stake-engine.com/docs/ai-review

Use this command to ask Claude Code to follow the instructions in prompt.md and review the game. Save prompt.md in the root of the game folder before running.

```bash
claude "Follow the instructions in prompt.md and review this game."
```

--------------------------------

### GET Endpoint for Replay Data

Source: https://stake-engine.com/docs/approval-guidelines/game-replay-requirements

Construct the URL to fetch replay state from the RGS server. Replace {rgs_url}, {game}, {version}, {mode}, and {event} with values from the query parameters.

```http
GET https://{rgs_url}/bet/replay/{game}/{version}/{mode}/{event}
```

--------------------------------

### Swap lookups: python3 utils/swap_lookups.py -g 0_0_lines -m base -n 2

Source: https://stake-engine.com/docs/math/utilities

Copies the weights of one optimized lookup table into the publish folder. The command uses the -g, -m, and -n flags to specify the game, mode, and table index.

```bash
python3 utils/swap_lookups.py -g 0_0_lines -m base -n 2
Copy
```

--------------------------------

### Launch URL template

Source: https://stake-engine.com/docs/rgs

The predefined URL from which studio games are served. The game reads the query parameters to talk to the RGS on the player's behalf and to display game information correctly. Replace {team}, {game}, and {version} with your team slug, game slug, and front-end version.

```text
https://{team}.live.engine.io/{game}/v{version}/?sessionID={sessionID}&rgs_url={rgs_url}&lang={lang}&currency={currency}&device={device}&social={social}&demo={demo}
```

--------------------------------

### GET /bet/replay/{game}/{version}/{mode}/{event}

Source: https://stake-engine.com/docs/approval-guidelines/game-replay-requirements

Fetches replay data from the RGS server. The game must call this endpoint after parsing the query parameters to retrieve the replay state.

```APIDOC
## GET /bet/replay/{game}/{version}/{mode}/{event}

### Description
Fetches replay data from the RGS server. The game must call this endpoint after parsing the query parameters to retrieve the replay state.

### Method
GET

### Endpoint
`https://{rgs_url}/bet/replay/{game}/{version}/{mode}/{event}`

### Parameters
#### Path Parameters
- **game** (string) - Required - Game ID (a UUID)
- **version** (string) - Required - Math version of the game (e.g., `1`, `2`)
- **mode** (string) - Required - Bet mode
- **event** (string) - Required - Unique simulation ID to replay

### Request Example
```
GET https://rgsd.engine.io/bet/replay/01996148-eecf-7678-be46-41de88c58951/1/SUPER/55
```

### Response
#### Success Response (200)
- **payoutMultiplier** (float) - Multiplier for calculating total payout
- **costMultiplier** (float) - Multiplier for calculating bet cost
- **state** (object) - Game-specific state for replay animation. Omitted when the event has no state.

#### Response Example
```json
{
  "payoutMultiplier": 25.0,
  "costMultiplier": 1.0,
  "state": { }
}
```

#### Error Response (404)
- Plain 404 with no JSON body when the game, version, mode, or event is unknown.
```
Tokens:
Raw