holistic-agency/dice-roll

dice roll formula interpreter

1.0.0 2024-10-30 19:40 UTC

Requires

• holistic-agency/decouple: ^1.0

Requires (Dev)

• phpunit/phpunit: ^10.5
• symfony/var-dumper: ^6.4

MIT

• JamesRezo

• random
• dice

README

One or More Dice to Roll.

Install

composer require holistic-agency/dice-roll:^1.x-dev

Usage

#!/usr/bin/env php
<?php

use HolisticAgency\DiceRoll\DiceFactory;

// signed dice -xDy±z is actually treated as -(xDy±z)
$sub1d4 = DiceFactory::fromFormula('-1D4+1');
echo $sub1d4 . ':' . $sub1d4->roll() . PHP_EOL; // Between -5 and -1, not -3 to 0

#!/usr/bin/env php
<?php

use HolisticAgency\DiceRoll\DiceFactory;

$potionOfHealing = DiceFactory::fromFormula('2D4+2');
echo $potionOfHealing . ':' . $potionOfHealing->roll() . PHP_EOL;

$sneakAttack = DiceFactory::fromFormula('1D8+2+3D6');
echo $sneakAttack . ':' . $sneakAttack->roll() . PHP_EOL;

#!/usr/bin/env php
<?php

use HolisticAgency\DiceRoll\Dice;
use HolisticAgency\DiceRoll\MersenneTwister;

$best3of4 = (new Dice('4D6'))->bestOf(3);
$best3of4->setNumberGenerator(new MersenneTwister());
for ($i = 0; $i < 6; $i++) {
    echo "Roll of $best3of4:" . $best3of4->roll() . PHP_EOL;
}

See other examples