@platonic-dice/dice

Persistent dice objects with roll history and TypeScript support. This package builds on top of @platonic-dice/core and provides classes such as Die which maintain roll history, validators, and utilities for consuming applications.

Version 2.1.0 adds support for rollModTest() - combining modifiers with test evaluation in a single method call.

Installation

npm install @platonic-dice/dice

Usage

CommonJS:

const { Die } = require("@platonic-dice/dice");
const { DieType } = require("@platonic-dice/core");

const d20 = new Die(DieType.D20);
console.log(d20.roll());
console.log(d20.history("normal"));

// New in 2.1.0: rollModTest combines modifier and test evaluation
const result = d20.rollModTest((n) => n + 5, { testType: "skill", target: 15 });
console.log(`Modified result: ${result}`);
console.log(d20.history("modifiedTest"));

TypeScript:

import { Die } from "@platonic-dice/dice";
import { DieType } from "@platonic-dice/core";

const d20 = new Die(DieType.D20);
console.log(d20.roll());

// Apply modifier and evaluate against test conditions
const result = d20.rollModTest((n) => n + 5, {
  testType: "at_least",
  target: 15,
});

Build

This package is written in TypeScript and compiles to dist/.

cd packages/dice
npm run build

Notes on publishing

• This package depends on @platonic-dice/core. When publishing both packages in the same release, ensure both package.json versions are bumped to the same release tag (the repository's release workflow can publish matching versions automatically).
• The package is scoped (@platonic-dice/dice) — make sure the npm scope exists for your account or organization before publishing.

License

MIT — see the repository LICENSE file.