npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dsibilly/dice-tower

v1.5.0

Published

A Node.js module for rolling dice and adding modifiers, e.g.: 3d6+2. Forked from node-roll.

Downloads

10

Readme

dice-tower

dice-tower is a node.js module for rolling dice and adding modifiers (e.g. "3d6+2"). This project was forked from node-roll.

npm version Build Status Coverage Status

How To Use (From Shell)

Installation (via npm)

$ npm install -g @dsibilly/dice-tower

Usage

$ dice-tower 3d6+2
13
$ dice-tower d20
15
$ dice-tower d%
97

How To Use (As Library)

Installation (via npm)

$ npm install @dsibilly/dice-tower

Usage

Get an instance of the library:

var DiceTower = require('@dsibilly/dice-tower').default,
  diceTower = new DiceTower();

Rolling a single die:

var oneDie = diceTower.roll('d6');
console.log(oneDie.result); // A pseudo-random number between 1 and 6 (inclusive)

Rolling multiple dice:

var twoTwenties = diceTower.roll('2d20');
console.log(twoTwenties.result); // A pseudo-random number between 2 and 40 (inclusive)

Rolling multiple sets of dice:

var bunchOfDice = diceTower.roll('2d20+1d12');
console.log(bunchOfDice.result); // A pseudo-random number between 3 and 52 (inclusive)

Rolling a percentage:

var chance = diceTower.roll('d%'); // ...or '1d100', 'd100', or '1d%'
console.log(chance.result); // A pseudo-random number between 1 and 100 (inclusive)

Simple calculation (+, -, *, /):

var attack = diceTower.roll('2d6+2');
console.log(attack.result); // A pseudo-random number between 3 and 8 (inclusive)

Seeing what was rolled, rather than the sum:

const yahtzee = diceTower.roll('5d6');
console.log(yahtzee.rolled); // `yahtzee.rolled` will return an Array, e.g. [5, 2, 4, 6, 1]

const blessedSneaker = diceTower.roll('2d20b1+1d4+5');
console.log(blessedSneaker.rolled); // blessedSneaker.rolled will return an Array containing an Array for each component that is a roll of the dice, in the order in which they occurred, e.g. [[19,3],[1]]

Getting the highest two dice of the set:

var pickBestTwo = diceTower.roll('6d20b2'); // roll 6 dice and sum the 2 highest results
console.log(pickBestTwo.calculations[1]); // pickBestTwo.calculations[0] is the same as .result, .calculations[1] is prior to the sum operation

Processing rolls without parsing a string:

// Same as 2d6+2:
const attack = diceTower.roll({
        quantity: 2,
        sides: 6,
        transformations: [ // List arbitrary pipeline operations to perform on the result.
            'sum', // Sum the result array of rolled dice together...
            ['add', 2] // ...and add 2 to that sum.
        ]
    });
    console.log(attack.result); // Outputs a pseudo-random number between 4 and 14, inclusive.

Using custom transformations:

const dropOnes = function(results){
        return results.filter(function (result) {
            return result !== 1;
        });
    },
    noOnes = diceTower.roll({
        quantity: 5,
        sides: 4,
        transformations: [
            dropOnes, // remove any rolled 1s
            'sum'
        ]
    });

Using a custom seed:

const srand = require('srand'); // https://github.com/isaacs/node-srand
srand.seed(Math.floor(Math.random() * 1000));

diceTower = new DiceTower(function () {
  return srand.random();
});

console.log(diceTower.roll('2d6+5').result);

Validating user input:

const userInput = 'this isn\'t a valid roll',
  valid = DiceTower.validate(userInput);

if (!valid) {
  console.error(`"${userInput}" is not a valid input string for node-roll!`);
}

Credits

Forked from Troy Goode's node-roll module. node-roll originally inspired by Phillip Newton's Games::Dice.

License

MIT License

Maintainer

Duane Sibilly

Contributors