let EasyDice = require('easydice')

let die = new EasyDice()
// Creates a single die with 6 sides by default

let result = die.throw()
// Returns the result as an integer, since there is a single die

// Use your result
// player.position += result

let die2 = new EasyDice(20)
// Creates a single die with 20 sides

let result2 = die2.throw()
// Returns the thrown value as a number

let playerCount = 2

In some games you decide which player starts by getting everyone to throw a die, and whoever has highest, goes first.

let dice = new EasyDice({count: playerCount})
// Creates two dice with 6 sides each

let startingThrow = dice.throw()
// Throw both dice, returns an array since there are multiple dice

let whichPlayerStarts = []

while (Array.isArray(whichPlayerStarts)) {
  whichPlayerStarts = dice.throw().highestIndex()
}

Randomness

The package uses Math.random() internally, so it can be considered random enough for dice. The results should be equally distributed.

Documentation

You can specify properties of the dice by giving the constructor some values:

new EasyDice() Returns a die with 6 sides. new EasyDice(s) Returns a die with s sides. new EasyDice(s, n) Returns n dice with s sides. new EasyDice(arr) Returns a custom die where the outcome is any element of arr, with equal probability. new EasyDice(arr, prob) Returns a custom die where the outcome is any element of arr, with the corresponding relative probability in prob. new EasyDice(arr, n) Returns n custom dice where the outcome for each die is any element of arr, with equal probability.

You can set more properties by instead passing an object to the constructor. It accepts the following keys: min specifies the minimum value for the di(c)e (default: 1) max specifies the maximum value for the di(c)e (default: 6) count specifies the number of dice (default: 1) values specifies that this is a custom die with outcomes from the array (default: undefined) probabilites specifies the relative probabilities of all items in values (default: undefined)

For example:

new EasyDice({ count: 2 }) Returns 2 dice with 6 sides each. new EasyDice({ values: ["red", "green", "blue"]}) Returns a die where a throw will result in either "red", "green" or "blue".

If there are more than 1 dice, the returned array contains some special functions:

let EasyDice = require('easydice')

let die = new EasyDice({ count: 2 })
let result = die.throw()

result now has the following special functions:

result.sum() Returns the sum of all thrown dice result.highestIndex() Returns the highest thrown value's index as an integer, or an array if there is a tie result.highestValue() Returns the highest thrown value result.lowestIndex() Returns the lowest thrown value's index as an integer, or an array if there is a tie result.lowestValue() Returns the lowest thrown value

Note: min and max are prioritized over values and probabilities. Do not use the special functions if values is used and it contains elements that are not numbers.