die 2.0.0

Library for simulating dice, dice rolls, and stats on dice.

About

die is a dice library, for RPG and Board Game games, experiments, whatever.

Speed / efficiency are not priorities.

Installing

via uv:

uv add die

via pip:

pip install die

Using

import die

d6 = die.Standard(6)
d6.roll()          # -> single roll, e.g. 4
d6.rolls(3)        # -> list of three rolls, e.g. [2, 6, 1]
d6 + 3             # -> roll + 3

roll = die.Roll((die.Standard(6), die.Standard(6)))
roll.roll()        # -> sum of both dice

best = die.Roll((d6, d6), func=max)
best.roll()        # -> higher of two d6

attack = die.parse('2d6+3')   # dice notation; also NdF fudge dice
attack.roll()

import random
seeded = die.Standard(6, rng=random.Random(42))  # reproducible rolls

See examples/demo.py for a fuller walk through.

Testing

ruff check . pytest

pre-commit runs ruff check and ruff format automatically before each commit:

pre-commit install
pre-commit run --all-files

History

See CHANGELOG for release history and breaking changes.