A typescript library for rolling dice using dice notation.
npm install @mrprim/dice-rollerbash
npm install @mrprim/dice-roller
`$3
`bash
yarn add @mrprim/dice-roller
`Usage
`javascript
import roll from '@mrprim/dice-roller'const total = roll('1d6+1d4+3')
const details = roll('1d4-1', true) // need to update this api to take an options object
`$3
The input of the
roll function must be a properly formatted string in dice notation format. EX: 2x4d10Multiple dice notation strings can be separated by
+ or - to roll more than one type of die or add one or more modifiers to a roll.#### Multiplier (Nx)
Perform the following dice action multiple times -
2x4d10 rolls 4d10` twice.Valid values: Integer
#### Dice Type (dN)
The type of die to roll.
Valid values: Integer, 'F' (for Fate die), '%' (for Percentile die; equivalent to d100)
#### Keep Highest N Dice (kN, khN)
The number of dice to use to calculate the total of a roll, keeping those with the highest value.
Valid values: Integer
#### Keep Lowest N Dice (klN)
The number of dice to use to calculate the total of a roll, keeping those with the lowest value.
Valid values: Integer
#### Reroll Dice Above N (! or !N)
Dice that roll N or above are rerolled. If N is left blank then it is set to the maximum value of the dice.
Valid values: Integer