JSPM

jsdice

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q48111F

A simple d20 dice parser and roller based on http://jsdice.com

Package Exports

  • jsdice

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdice) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jsDice

adopted and mangled from jsDice.com

The standard dice rolling format for tabletop games is [times]d[sides]. Typical dice strings could add/subtract formats and static numbers together.

jsDice is a small library for parsing dice formula strings as well as rolling the dice.

Basic Usage

var Dice = require('jsdice');
var dieroll = new Dice('4d6 + d20 - 3');
var results = dieroll.roll();
console.log(results.total);
// 24
console.log(results.results);
// [ 2, 5, 4, 5, 11, -3 ]

Installation

This adaptation of jsDice is written for Node.js, and may be used browser-side with browserify.

npm install jsdice

Stats Template Usage

When initializing the dice, you can pass a stats object as a second argument to be using in the formula.

var stats = {dex: 12, str: 4, int: 19, agility: 9};
diceroll = new Dice('d10 + {str}', stats);
console.log(diceroll.roll());
//{ results: [ 3, 4 ], total: 7 }