# hizi docs

> Documentation for the entire hizi ecosystem: the hizi engine that serves pre-computed game outcomes, the Operator and Game Studio integration APIs, the Operator Interface lobby protocol, the hizi app, and the backoffice settings.

hizi.io is a Remote Gaming Server (RGS). A game studio builds a game on the hizi engine or brings its own; an operator launches that game for a player through the Operator API; the game talks back through the Game Studio API and the Operator Interface.

Each section below publishes its own `llms.txt`, listed beside it. Every page of the site, in full, is at https://docs.hizi.io/llms-full.txt.

The site also publishes a search index in JSON, with short sections of each page, at https://docs.hizi.io/docs-index.json.

## Build a game frontend

- [SDK index](https://docs.hizi.io/engine/sdk/llms.txt): Start here for ordered reading and task-specific references.
- [Complete frontend text](https://docs.hizi.io/engine/sdk/llms-full.txt): Read the frontend documentation in one fetch. Includes example source.

## Sections

- [Studio Quickstart](https://docs.hizi.io/studio-quickstart/): The ordered path for a game studio building a hizi engine game with its own frontend. Five steps, from engine config to operator-ready, each linking onward to the section that covers it in full. Section index: https://docs.hizi.io/studio-quickstart/llms.txt
- [Hizi App](https://docs.hizi.io/hizi-app/): The hizi app is where you build and import games, configure studios and partners, and publish your setup live to the operator sites. Section index: https://docs.hizi.io/hizi-app/llms.txt
- [Operator API](https://docs.hizi.io/operator-api/): The server-to-server integration for casino operators and aggregators putting hizi.io games into their platform. It covers game launch, player management, balances and transactions, in real-money or demo mode. Every monetary value is an integer in 1/100 of the base currency. Section index: https://docs.hizi.io/operator-api/llms.txt
- [Game Studio API](https://docs.hizi.io/game-studio-api/): Game engines and third-party RGS connect to the hizi.io platform through this API. It covers game launches, round management, freeplays and certified RNG. Section index: https://docs.hizi.io/game-studio-api/llms.txt
- [Operator & Game Settings](https://docs.hizi.io/operator-game-settings/): Operator-level settings configured from the backoffice: payment retry strategies, geo-IP access control, and the games an operator may access with the default settings applied to them. Section index: https://docs.hizi.io/operator-game-settings/llms.txt
- [Operator Interface](https://docs.hizi.io/operator-interface/): The client-side event protocol that connects a game to an operator's or aggregator's lobby, shipped as `@hoelle/operator-interface` with full TypeScript types. It covers the methods, the events, and the per-operator notes for every supported lobby. Section index: https://docs.hizi.io/operator-interface/llms.txt
- [hizi engine](https://docs.hizi.io/engine/): hizi engine is a system for building and serving pre-computed game outcomes for fixed-odds games - slots, instant wins, scratch cards, plinko, mines, blackjack, crash, and more. Game outcomes are simulated offline, the generator writes compact JSONL files (`entries`, `scenarios`, `config`, `buyfeatures`), and the hizi RGS platform serves them to players at runtime through the `@hizi.io/engine-sdk`. Section index: https://docs.hizi.io/engine/llms.txt

## Reference

- [hizi documentation changelog](https://docs.hizi.io/changelog.html): Dated, per-section record of every documentation change on this site.
- [Response Codes & Error Codes](https://docs.hizi.io/response-codes.html): The `X-H-ERROR-ID` and `X-H-ERROR-MSG` response headers, and the full list of error codes the APIs share.