Studio QuickstartFrom an empty project to an operator-ready game

The ordered path for a game studio building a hizi engine game with its own frontend. Five steps. Each one links to the docs that cover it in full.

Start with Step 1

Getting started in the hizi app

Step 1: Create your engine

Build your game in the engine's creator tool from the hizi app. Save it as a Hizi Engine Config. Attach it to a Game. Promote that version to sandbox or staging.

Create your engine

Step 2: Set your frontend URL

Point the Game at the frontend index document that players are redirected to on launch. Use a temporary URL while you are still testing.

Set your frontend URL

Step 3: Install the SDK

Add '@hizi.io/engine-sdk' to your frontend. Bring a session up with login and loadConfig.

Install the SDK

Step 4: Place bets and collect

Drive the round loop with placeBet and collect. Handle multi-step rounds. Read the scenario your game type returns.

Place bets and collect

Step 5: Implement the Operator Interface

Wire up '@hoelle/operator-interface' so your game behaves correctly inside an operator's lobby, including any calls a specific operator requires.

Implement the Operator Interface

Who this is for

You are a game studio. You want to build a game on the in-house hizi engine, run your own frontend for it, and get that game ready to hand to operators. Everything you need is already documented, but it is spread across the hizi app, engine, SDK, and Operator Interface sections. This guide gives you the running order.

Each step is a short checklist. It links onward to the page that covers that step in full. Read the linked pages for the detail. Use this page to know what comes next.

TIP

The five steps are roughly sequential. Steps 3 to 5 are all frontend work and can overlap. Two steps must come first: Step 1, because you need a config attached to a Game before there is anything to launch, and Step 2, because you need a launch URL before your frontend can log in.

Building your game a different way?

This guide assumes the hizi engine. Do you already have your own engine, or your own RGS (remote game server)? Then the shape of the work is different. See I want to import my own games in the hizi app docs, and read the Game Studio API instead.