Skip to the content

Korokoroコロコロ

Roll mixed dice or type notation, compare exact probabilities, keep a history and replay seeded rolls.

Korokoro describes something small rolling in Japanese. About the name

Contents

Reference · Rolls and exact odds

toJSONfunction

Rolls as JSON, two spaces deep, with the format's number first. stats: true adds statsOf the rolls. fromJSON reads it back.

Import it

import { toJSON } from "@johnmorrisdotca/korokoro";

Definition

function toJSON(rolls: readonly Roll[], options?: { stats?: boolean; }): string

Parameters

NameTypeDescription
rollsreadonly Roll[]

Completed rolls, or the number of attempts where this parameter is numeric.

options (optional){ stats?: boolean; }

Options for this call; omitted fields keep their documented defaults.

Returns

string

Rolls as JSON, two spaces deep, with the format's number first. stats: true adds statsOf the rolls. fromJSON reads it back.

Examples

import { toJSON } from "@johnmorrisdotca/korokoro";
import { normalizeSpec, rollFrom } from "@johnmorrisdotca/korokoro";
const spec = normalizeSpec({ count: 2, sides: 6 });
const sample = rollFrom(spec, [2, 5], "saved", 0, null)!;
console.log(toJSON([sample]));
{
  "format": 1,
  "generator": "korokoro 1.16.0",
  "rolls": [
    {
      "id": "saved",
      "notation": "2d6",
      "spec": {
        "count": 2,
        "sides": 6,
        "modifier": 0,
        "keep": "all"
      },
      "faces": [
        2,
        5
      ],
      "kept": [
        true,
        true
      ],
      "total": 7,
      "at": 0,
      "time": "1970-01-01T00:00:00.000Z",
      "seed": null,
      "dice": [
        {
          "face": 2,
          "status": "kept",
          "exploded": false,
          "die": 0
        },
        {
          "face": 5,
          "status": "kept",
          "exploded": false,
          "die": 1
        }
      ]
    }
  ]
}

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/korokoro 1.16.0.