Dices

A simple and customizable npm package for rolling dice. With this package, you can roll standard six-sided dice, dice with a custom range of sides, and even multiple dice at once.

Features

• Roll a standard six-sided die: Simulates the roll of a classic die with 6 faces.
• Roll a custom-sided die: Specify the number of sides for the die (e.g., 4, 8, 10, 20).
• Roll multiple dice: Roll several dice at once and get the results in one call.

Installation

Install the package using npm:

npm install dices

Usage

Import the package into your project:

const dices = require("dices");

Roll a standard six-sided die

const result = dices.extract();
console.log(`You rolled a: ${result}`);

Roll a die with a custom number of sides

const result = dices.extractByRange(10); // Roll a 10-sided die
console.log(`You rolled a: ${result}`);

Roll multiple dice

const results = dices.extractMany(3, 6); // Roll 3 six-sided dice
console.log(`You rolled: ${results.join(", ")}`);

const defaultResults = dices.extractMany(5); // Roll 5 six-sided dice by default
console.log(`You rolled: ${defaultResults.join(", ")}`);

API Reference

extract()

Rolls a standard six-sided die.

Returns:

• Number: A random number between 1 and 6.

extractByRange(sides)

Rolls a die with a custom number of sides.

Parameters:

• sides (Number): The number of sides on the die. Must be greater than 1.

Returns:

• Number: A random number between 1 and the specified number of sides.

extractMany(count, sides)

Rolls multiple dice at once.

Parameters:

• count (Number): The number of dice to roll. Must be greater than 0.
• sides (Number, optional): The number of sides on each die. Defaults to 6 if not provided.

Returns:

• Array<Number>: An array containing the results of each die rolled.

Examples

const dices = require("dices");

// Roll a standard die
console.log(`Standard Roll: ${dices.extract()}`);

// Roll a custom 20-sided die
console.log(`Custom Roll: ${dices.extractByRange(20)}`);

// Roll 5 six-sided dice
console.log(`Multiple Rolls: ${dices.extractMany(5, 6).join(", ")}`);

// Roll 4 default six-sided dice
console.log(`Multiple Default Rolls: ${dices.extractMany(4).join(", ")}`);

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

Author

Created by Carlo Leonardi.