# Korokoro コロコロ — Dice roller with notation and exact odds

> Korokoro コロコロ — Dice roller with notation and exact odds: mixed dice, seeded rolls, history and a browser tray. Zero dependencies.

Install with `npm install @johnmorrisdotca/korokoro`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/korokoro/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/korokoro/docs/guides/getting-started.md): Install Korokoro, read notation, roll reproducibly and inspect the exact odds.
- [Roll with notation](https://johnmorrisdotca.github.io/korokoro/docs/guides/roll-with-notation.md): Validate a roll, combine dice, keep selected faces and use a game preset.
- [Exact odds](https://johnmorrisdotca.github.io/korokoro/docs/guides/exact-odds.md): Read a distribution, threshold chances and exact integer outcome counts.
- [Keep and share rolls](https://johnmorrisdotca.github.io/korokoro/docs/guides/seeded-shared-rolls.md): Use reproducible sources, round-trip a shared roll and save portable history.
- [Custom and loaded dice](https://johnmorrisdotca.github.io/korokoro/docs/guides/custom-loaded-dice.md): Give faces words and values, or weight a numbered die and inspect its fairness.
- [Embed a tray](https://johnmorrisdotca.github.io/korokoro/docs/guides/embed-a-tray.md): Mount the native tray, use a custom element or iframe and handle host messages.
- [Design and entry points](https://johnmorrisdotca.github.io/korokoro/docs/guides/design.md): Understand the pure engine, optional browser layer and language or storage boundaries.
- [How the dice and odds work](https://johnmorrisdotca.github.io/korokoro/docs/guides/how-it-works.md): Read the seeded generator specification and the rules behind reproducible exact calculations.
- [Troubleshooting and FAQ](https://johnmorrisdotca.github.io/korokoro/docs/guides/troubleshooting.md): Handle invalid notation, unsupported exact counts, storage refusal and browser setup.
- [Upgrading](https://johnmorrisdotca.github.io/korokoro/docs/guides/upgrading.md): Keep 1.x notation and stored rolls compatible, including the reroll change and library migration.

## Reference

- [@johnmorrisdotca/korokoro/react](https://johnmorrisdotca.github.io/korokoro/docs/api/react/index.md): React components
- [@johnmorrisdotca/korokoro/element](https://johnmorrisdotca.github.io/korokoro/docs/api/element/index.md): Embedded roller and die
- [@johnmorrisdotca/korokoro/element/define](https://johnmorrisdotca.github.io/korokoro/docs/api/element-define/index.md): The custom element, registered by being imported:
- [@johnmorrisdotca/korokoro/vue](https://johnmorrisdotca.github.io/korokoro/docs/api/vue/index.md): Vue components
- [@johnmorrisdotca/korokoro/sounds](https://johnmorrisdotca.github.io/korokoro/docs/api/sounds/index.md): Recorded dice sounds
- [@johnmorrisdotca/korokoro](https://johnmorrisdotca.github.io/korokoro/docs/api/main/index.md): Korokoro コロコロ: fair dice, exact odds, and a history that remembers.

## Optional

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