A dice rolling library that uses standard dice notation
npm install drollDroll is a JavaScript dice-rolling library. It accepts input in
standard dice notation and works in both Node.js
and browser environments.
An optional executable is also included in the package for use directly from the command line.
With npm (recommended)
npm install droll
Without npm
Download droll.js or
droll.min.js
Node.js
``javascript
var droll = require('droll');
var result = droll.roll('3d6+1');
console.log(result);
`
Browser
`html`
Droll ships with an optional executable that can be installed via npm like this
`
npm install droll -g
And used from the command line like this
`
$ droll 3d6+1
6 + 5 + 5 + 1 = 17
* __formula__ String The dice formula in standard dice notation.
Returns true if formula is valid dice notation or false otherwise.
* __formula__ String The dice formula in standard dice notation.
Rolls the dice defined by formula and returns a DrollResult object on success or false
otherwise.
The DrollResult object contains the following properties
* __rolls__ Array The result of each die roll.Number
* __modifier__ The optional modifier. The default is 0.Number
* __total__ The sum of the rolls plus the modifier.
The DrollResult object also has a custom toString() method for pretty printing the result.6 + 5 + 5 + 1 = 17
It returns strings that look like or 4 + 2 - 1 = 5 or even just 7.
* __formula__ String The dice formula in standard dice notation.
Parses formula into its component pieces and returns a DrollFormula object on success or false
otherwise.
The DrollFormula object contains the following properties
* __numDice__ Number The number of dice to roll.Number
* __numSides__ The number of sides on each die.Number
* __modifier__ The optional modifier. The default is 0.Number
* __minResult__ The minimum result that can be returned by this formula.Number
* __maxResult__ The maximum result that can be returned by this formula.Number` The average result returned by this formula. ((max + min) / 2)
* __avgResult__