# Houseki 宝石 — Match-3 gem puzzles

> Houseki 宝石 — Match-3 gem puzzles: five gem and stone puzzle engines, 684 measured challenges, bilingual lessons, deterministic saves, magnetic floors, Shizen and Arashi campaigns. TypeScript. Zero dependencies.

Install with `npm install @johnmorrisdotca/houseki`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/houseki/docs/. The examples on the reference pages are run when the site is built, and what they print is shown under them.

## Guides

- [Getting started](https://johnmorrisdotca.github.io/houseki/docs/guides/getting-started.md): Choose one native engine and inspect a deterministic transition.
- [Drive falling gems](https://johnmorrisdotca.github.io/houseki/docs/guides/falling-games.md): Keep player actions and fixed-tick simulation in order.
- [Play full-board games](https://johnmorrisdotca.github.io/houseki/docs/guides/full-board-games.md): Inspect legal actions, rejection and tool previews on native full boards.
- [Use magnetic floors](https://johnmorrisdotca.github.io/houseki/docs/guides/magnetic-blocks.md): Compare native landing and gravity without mutating the input.
- [Preview nature and weather](https://johnmorrisdotca.github.io/houseki/docs/guides/nature-and-weather.md): Use pure previews before committing magnetic, rebound and weather changes.
- [Open campaigns and lessons](https://johnmorrisdotca.github.io/houseki/docs/guides/campaigns-and-lessons.md): Keep stable ids, witnessed plans and review status with authored content.
- [Save and replay a game](https://johnmorrisdotca.github.io/houseki/docs/guides/saving-replays.md): Store native recordings and handle replay rejection explicitly.
- [Build a host UI](https://johnmorrisdotca.github.io/houseki/docs/guides/host-ui.md): Render native state and route accessible input without changing the engine API.
- [Architecture and determinism](https://johnmorrisdotca.github.io/houseki/docs/guides/architecture.md): Read the original complete source tree and engine design.
- [Troubleshooting and FAQ](https://johnmorrisdotca.github.io/houseki/docs/guides/troubleshooting.md): Interpret absent values, setup errors and saved-game failures.
- [Upgrading and migration](https://johnmorrisdotca.github.io/houseki/docs/guides/upgrading.md): Keep native entries and saves while adopting the docs site.

## Reference

- [@johnmorrisdotca/houseki/falling-triplets](https://johnmorrisdotca.github.io/houseki/docs/api/falling-triplets/index.md): Falling Triplets
- [@johnmorrisdotca/houseki/colour-chains](https://johnmorrisdotca.github.io/houseki/docs/api/colour-chains/index.md): Colour Chains
- [@johnmorrisdotca/houseki/stone-collapse](https://johnmorrisdotca.github.io/houseki/docs/api/stone-collapse/index.md): Stone Collapse
- [@johnmorrisdotca/houseki/gem-swap](https://johnmorrisdotca.github.io/houseki/docs/api/gem-swap/index.md): Gem Swap
- [@johnmorrisdotca/houseki/nature](https://johnmorrisdotca.github.io/houseki/docs/api/nature/index.md): Shizen and Arashi environments
- [@johnmorrisdotca/houseki/magnetic-blocks](https://johnmorrisdotca.github.io/houseki/docs/api/magnetic-blocks/index.md): Magnetic Blocks
- [@johnmorrisdotca/houseki](https://johnmorrisdotca.github.io/houseki/docs/api/main/index.md): Original immutable game engines, grouped by game.

## Optional

- [Changelog](https://johnmorrisdotca.github.io/houseki/docs/changelog.md): every release
- [Every export, in full](https://johnmorrisdotca.github.io/houseki/llms-full.txt)
- [Source](https://github.com/johnmorrisdotca/houseki)