# Toranpu トランプ — Playing cards, card games and solitaire

> Toranpu トランプ — Playing cards, card games and solitaire: Hearts, Spades, Euchre, Cribbage, Oh Hell, Crazy Eights, Go Fish, Big Two, President, Gin Rummy and War; solitaires, seeded deals and computers. Zero dependencies.

Install with `npm install @johnmorrisdotca/toranpu`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/toranpu/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/toranpu/docs/guides/getting-started.md): Install Toranpu, start a seeded game and play one legal move.
- [Run computer turns](https://johnmorrisdotca.github.io/toranpu/docs/guides/run-computers.md): Choose which seats are computers, step them through a game, and show their moves in order.
- [Save, restore and export](https://johnmorrisdotca.github.io/toranpu/docs/guides/save-and-export.md): Save a game as its setup and moves, read it back by replaying them, and export JSON, a code, text or CSV.
- [Display and brand cards](https://johnmorrisdotca.github.io/toranpu/docs/guides/display-and-branding.md): Draw cards and backs as SVG, register your own designs, and show them with elements.
- [Deal, play and solve solitaires](https://johnmorrisdotca.github.io/toranpu/docs/guides/solitaires.md): Deal, play and solve Klondike, FreeCell and Spider with their own engines.
- [Embed cards or use React](https://johnmorrisdotca.github.io/toranpu/docs/guides/embed-and-react.md): Register the card tags, use the builder, and drive a table from React hooks.
- [Engine, views and replay](https://johnmorrisdotca.github.io/toranpu/docs/guides/engine-design.md): See how the rules engines share one shape, how state and deals are reproduced, and how the entry points divide.
- [Card representations and layouts](https://johnmorrisdotca.github.io/toranpu/docs/guides/card-representations.md): Know the three ways a card is written, and keep layout and spoken names apart from game state.
- [Troubleshooting & FAQ](https://johnmorrisdotca.github.io/toranpu/docs/guides/troubleshooting.md): Find out why a game or move is null, a card or design will not read, a save fails, or a tag or hook does not work.
- [Upgrading from 1.x and other card libraries](https://johnmorrisdotca.github.io/toranpu/docs/guides/upgrading.md): Move from 1.x to 2.x, stay on 2.x, and come from another card library.

## Reference

- [@johnmorrisdotca/toranpu/deck](https://johnmorrisdotca.github.io/toranpu/docs/api/deck/index.md): The deck on its own: fifty-two cards as objects (`{ suit, rank }`), a seeded shuffle, dealing, one-character and two-character codes, and the names a card is written and spoken by.
- [@johnmorrisdotca/toranpu/react](https://johnmorrisdotca.github.io/toranpu/docs/api/react/index.md): React components
- [@johnmorrisdotca/toranpu/card-sounds](https://johnmorrisdotca.github.io/toranpu/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, a pile gathered in, a hand fanned.
- [@johnmorrisdotca/toranpu/sounds](https://johnmorrisdotca.github.io/toranpu/docs/api/sounds/index.md): Recorded sounds
- [@johnmorrisdotca/toranpu/card-backs](https://johnmorrisdotca.github.io/toranpu/docs/api/card-backs/index.md): The backs of the cards, drawn as SVG: one home for every card game in the family.
- [@johnmorrisdotca/toranpu/card-faces](https://johnmorrisdotca.github.io/toranpu/docs/api/card-faces/index.md): The faces of the cards, drawn as SVG in the same 100 by 140 box as the backs: plain (unless said), four colour, and the English pattern with its drawn kings, queens and jacks, which is its own entry point because of its size.
- [@johnmorrisdotca/toranpu/card-faces/english](https://johnmorrisdotca.github.io/toranpu/docs/api/card-faces-english/index.md): The English pattern: the traditional deck with its kings, queens and jacks, as vectors by Dmitry Fomin, who dedicated them to the public domain (CC0) on Wikimedia Commons; the jokers are his too, from his Atlas deck, with the corner word drawn afresh.
- [@johnmorrisdotca/toranpu/card-faces/realistic](https://johnmorrisdotca.github.io/toranpu/docs/api/card-faces-realistic/index.md): The realistic design: Byron Knoll's number cards and aces, which he released into the public domain (Wikimedia Commons), with the kings, queens, jacks, ace of spades and jokers of Dmitry Fomin's CC0 English pattern.
- [@johnmorrisdotca/toranpu/element](https://johnmorrisdotca.github.io/toranpu/docs/api/element/index.md): Toranpu's custom elements, for any page and any framework that renders HTML, and the arithmetic behind them:
- [@johnmorrisdotca/toranpu/element/define](https://johnmorrisdotca.github.io/toranpu/docs/api/element-define/index.md): The custom elements, registered by being imported:
- [@johnmorrisdotca/toranpu/table](https://johnmorrisdotca.github.io/toranpu/docs/api/table/index.md): `<toranpu-table>`: any of the ten games, ready to play on a page — the seats, the felt in any of the family's cloths, the trick and the piles (the stock and the discard as `<toranpu-pile>`, as untidy as asked), the hand of whoever is to play and the moves they may make, with computers in every other seat.
- [@johnmorrisdotca/toranpu/table/define](https://johnmorrisdotca.github.io/toranpu/docs/api/table-define/index.md): `<toranpu-table>`, registered by being imported:
- [@johnmorrisdotca/toranpu/hearts](https://johnmorrisdotca.github.io/toranpu/docs/api/hearts/index.md): Hearts: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/spades](https://johnmorrisdotca.github.io/toranpu/docs/api/spades/index.md): Spades: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/euchre](https://johnmorrisdotca.github.io/toranpu/docs/api/euchre/index.md): Euchre: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/cribbage](https://johnmorrisdotca.github.io/toranpu/docs/api/cribbage/index.md): Cribbage: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/oh-hell](https://johnmorrisdotca.github.io/toranpu/docs/api/oh-hell/index.md): Oh Hell: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/crazy-eights](https://johnmorrisdotca.github.io/toranpu/docs/api/crazy-eights/index.md): Crazy Eights: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/go-fish](https://johnmorrisdotca.github.io/toranpu/docs/api/go-fish/index.md): Go Fish: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/big-two](https://johnmorrisdotca.github.io/toranpu/docs/api/big-two/index.md): Big Two: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/president](https://johnmorrisdotca.github.io/toranpu/docs/api/president/index.md): President: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/gin-rummy](https://johnmorrisdotca.github.io/toranpu/docs/api/gin-rummy/index.md): Gin Rummy: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/war](https://johnmorrisdotca.github.io/toranpu/docs/api/war/index.md): War: its rules, its computer player and its saved-game format.
- [@johnmorrisdotca/toranpu/klondike](https://johnmorrisdotca.github.io/toranpu/docs/api/klondike/index.md): Klondike, the Solitaire: its table, its rules, its moves written as text, a solver, and what a tap on the table means.
- [@johnmorrisdotca/toranpu/freecell](https://johnmorrisdotca.github.io/toranpu/docs/api/freecell/index.md): FreeCell: its table, its rules, its moves written as text, a solver, and what a tap on the table means.
- [@johnmorrisdotca/toranpu/spider](https://johnmorrisdotca.github.io/toranpu/docs/api/spider/index.md): Spider: its table at one, two or four suits, its rules, its moves written as text, a solver, and what a tap on the table means.
- [@johnmorrisdotca/toranpu](https://johnmorrisdotca.github.io/toranpu/docs/api/main/index.md): Toranpu トランプ: a deck of playing cards and eleven card games to play with it, each with a computer player.

## Optional

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