# Jirai 地雷 — Minesweeper with no-guess boards

> Jirai 地雷 — Minesweeper with no-guess boards: square, orthogonal, hexagonal and wraparound fields, seeded safe openings, bounded generation, explained hints and accessible English/Japanese play. Zero runtime dependencies.

Install with `npm install @johnmorrisdotca/jirai`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/jirai/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/jirai/docs/guides/getting-started.md): Reveal a small native field and read its visible clues.
- [Select topology, shapes and levels](https://johnmorrisdotca.github.io/jirai/docs/guides/grids-and-levels.md): Keep row-major active-cell indices and validate topology-specific settings.
- [Generate verified no-guess fields](https://johnmorrisdotca.github.io/jirai/docs/guides/bounded-generation.md): Keep seed, opening and budgets explicit; generation failure is never an unproved board.
- [Prove hints from visible clues](https://johnmorrisdotca.github.io/jirai/docs/guides/visible-hints.md): Use VisibleGame and distinguish flags, proof and contradictions.
- [Save progress and preserve variants](https://johnmorrisdotca.github.io/jirai/docs/guides/save-and-variants.md): Replay validated moves and retain orthogonal version-2 markers.
- [Share a UTC daily field](https://johnmorrisdotca.github.io/jirai/docs/guides/daily-fields.md): Pin a real date, topology, settings and opening for reproducible daily play.
- [Draw a model or mount a React host](https://johnmorrisdotca.github.io/jirai/docs/guides/models-and-react.md): Keep visible presentation data separate from game answers and mount ownership.
- [Embed and control a native board](https://johnmorrisdotca.github.io/jirai/docs/guides/embed-and-mount.md): Use native mounts, events, reflected settings and cleanup.
- [How generation, clues and the player fit together](https://johnmorrisdotca.github.io/jirai/docs/guides/architecture.md): Preserved source tree and boundaries between answers, visible clues and UI.
- [Troubleshooting and FAQ](https://johnmorrisdotca.github.io/jirai/docs/guides/troubleshooting.md): Interpret generation errors, null progress, inactive cells and empty deductions.
- [Upgrading within 0.x](https://johnmorrisdotca.github.io/jirai/docs/guides/upgrading.md): Retain versioned deals, variant markers and generation policy.

## Reference

- [@johnmorrisdotca/jirai/orthogonal](https://johnmorrisdotca.github.io/jirai/docs/api/orthogonal/index.md): Four-neighbour rules
- [@johnmorrisdotca/jirai/play](https://johnmorrisdotca.github.io/jirai/docs/api/play/index.md): Native Minesweeper player
- [@johnmorrisdotca/jirai/draw](https://johnmorrisdotca.github.io/jirai/docs/api/draw/index.md): Visible board models
- [@johnmorrisdotca/jirai/element](https://johnmorrisdotca.github.io/jirai/docs/api/element/index.md): Minesweeper element
- [@johnmorrisdotca/jirai/element/define](https://johnmorrisdotca.github.io/jirai/docs/api/element-define/index.md): Register Minesweeper
- [@johnmorrisdotca/jirai/react](https://johnmorrisdotca.github.io/jirai/docs/api/react/index.md): React player
- [@johnmorrisdotca/jirai](https://johnmorrisdotca.github.io/jirai/docs/api/main/index.md): Jirai 地雷: the rules and deductions, plain functions over plain data.

## Optional

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