# Hitotsu 一つ — Colour-card shedding game for two to eight

> Hitotsu 一つ — Colour-card shedding game for two to eight: classic and party rules, a computer player, a table for several devices and its own deck. Zero dependencies.

Install with `npm install @johnmorrisdotca/hitotsu`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/hitotsu/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/hitotsu/docs/guides/getting-started.md): Install Hitotsu, deal from a seed and play one legal move.
- [Choose house rules](https://johnmorrisdotca.github.io/hitotsu/docs/guides/house-rules.md): Choose the classic or party rules, set the match length and check the settings you receive.
- [Run a computer player](https://johnmorrisdotca.github.io/hitotsu/docs/guides/computer-player.md): Ask the computer player for a move, handle out-of-turn jump-ins, and see what it knows.
- [Save and restore a game](https://johnmorrisdotca.github.io/hitotsu/docs/guides/save-and-restore.md): Save a game as its setup and moves, restore it by replaying them, and decide what to share.
- [Mount or embed a table](https://johnmorrisdotca.github.io/hitotsu/docs/guides/mount-and-embed.md): Put a playable table on a page, change it without a re-deal, and embed it in React, a tag or a frame.
- [Use the shared-table adapter](https://johnmorrisdotca.github.io/hitotsu/docs/guides/shared-tables.md): Connect tables on several devices with adapters while your app keeps the network and the hidden hands.
- [The engine and its state](https://johnmorrisdotca.github.io/hitotsu/docs/guides/engine-and-state.md): Read the game state, card identity, seeded shuffles and scoring of the rules engine.
- [Cards, language and sounds](https://johnmorrisdotca.github.io/hitotsu/docs/guides/cards-and-sounds.md): Draw cards from one shared model, read them without relying on colour, and load recorded sounds only when needed.
- [Troubleshooting & FAQ](https://johnmorrisdotca.github.io/hitotsu/docs/guides/troubleshooting.md): Find out why a game will not start, a move is refused, a value is null or a sound stays silent.
- [Upgrading and coming from other games](https://johnmorrisdotca.github.io/hitotsu/docs/guides/upgrading.md): Stay on version 1 and move from another colour-card game.

## Reference

- [@johnmorrisdotca/hitotsu/react](https://johnmorrisdotca.github.io/hitotsu/docs/api/react/index.md): React components
- [@johnmorrisdotca/hitotsu/element](https://johnmorrisdotca.github.io/hitotsu/docs/api/element/index.md): Table element
- [@johnmorrisdotca/hitotsu/element/define](https://johnmorrisdotca.github.io/hitotsu/docs/api/element-define/index.md): `<hitotsu-table>`, registered by being imported:
- [@johnmorrisdotca/hitotsu/element-define](https://johnmorrisdotca.github.io/hitotsu/docs/api/element-define/index.md): `<hitotsu-table>`, registered by being imported:
- [@johnmorrisdotca/hitotsu/card-sounds](https://johnmorrisdotca.github.io/hitotsu/docs/api/card-sounds/index.md): The sounds of a card table, from real recorded cards: a card dealt, turned over or played, the deck shuffled.
- [@johnmorrisdotca/hitotsu](https://johnmorrisdotca.github.io/hitotsu/docs/api/main/index.md): Hitotsu 一つ: a colour-card shedding game for two to eight, with the house rules people actually play.

## Optional

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