Quick Start

Install package from npmCopy Anchor Link

Set up your Node.js project and install @slot-engine/lgs. Install it next to your game, because the LGS reads the game's build files from disk.

npm i @slot-engine/lgs

Simulate your gameCopy Anchor Link

The LGS plays the books that your simulation wrote. Run a simulation for every game mode before you connect the game. The LGS reads the lookup tables and books from the game's __build__/publish_files directory.

Your game must specify rootDir: __dirname so that the LGS can resolve those files.

export const game = createSlotGame<GameType>({
  rootDir: __dirname, // required if connecting this game to @slot-engine/lgs
  // ...
})

Create the LGSCopy Anchor Link

Create an EngineLgs with a storage and your games, then start it. For all options, see the configuration guide.

import { EngineLgs, InMemoryStorage } from "@slot-engine/lgs"
import { game as MyGame } from "../../path-to/my-game"

const lgs = new EngineLgs({
  storage: new InMemoryStorage(),
  games: [MyGame],
})

lgs.start()

Run the file with tsx:

pnpm tsx ./lgs.ts

You should see the LGS announce itself:

⚡️ Slot Engine LGS (Engine) is running on http://localhost:7771
:: 1 games loaded

If you use Slot Engine Panel, pass the LGS to createPanel() instead. The panel registers its games with the LGS and serves it on the panel's port.

import { EngineLgs, InMemoryStorage } from "@slot-engine/lgs"
import { createPanel } from "@slot-engine/panel"
import { game as MyGame } from "../../path-to/my-game"

const panel = createPanel({
  games: [MyGame],
  lgs: new EngineLgs({ storage: new InMemoryStorage() }),
})

panel.start()

The panel's startup log then shows the attached LGS:

⚡️ Slot Engine Panel is running on http://localhost:7770
:: 1 games loaded
:: LGS "Engine" attached, rgs_url=localhost:7770

Create a sessionCopy Anchor Link

A front end needs a session ID. If you attached the LGS to the panel, the panel's Play Game tab creates the session and launches your front end for you. To create a session by hand, post the game's ID:

curl -X POST http://localhost:7771/lgs/sessions \
  -H "content-type: application/json" \
  -d '{"gameId":"my-game"}'

The response contains the session, its wallet and the launch parameters for the front end:

{
  "sessionID": "wYv1...",
  "walletId": "Qf8c...",
  "launchParams": {
    "sessionID": "wYv1...",
    "rgs_url": "localhost:7771",
    "lang": "en",
    "currency": "USD",
    "device": "desktop",
    "social": false,
    "demo": false
  },
  "launchQuery": "sessionID=wYv1...&rgs_url=localhost%3A7771&lang=en&currency=USD&device=desktop&social=false&demo=false"
}

The session starts with the configured balance, 10,000.00 by default. See Sessions for every field you can set.

Launch your front endCopy Anchor Link

Append the launchQuery to your front end's URL, the same way Engine launches a game:

http://localhost:3000/?sessionID=wYv1...&rgs_url=localhost%3A7771&lang=en&currency=USD&device=desktop&social=false&demo=false

The LGS serves plain HTTP. The official Engine client defaults to HTTPS, so set the protocol when you create it:

const client = RGSClient({ url: window.location.href, protocol: "http" })

Your front end now authenticates, plays and ends rounds against the LGS. The LGS answers with your simulated books, and the wallet balance moves with every bet.