@colinaut/dice-roller v0.2.10

Dice Roller Web Component

This is a dice roller web component. I created this mainly for use with playing table top role playing games online. This can be used just as a simple web dice roller or incorporated into interactive rule books or character sheets.

Demo Page

Usage

Install the dice-roller.js script and add the <dice-roller></dice-roller> to your html. Clicking on the dice makes them roll. You can change the dice and how they are totaled using the attributes. The component can be styled using css variables (I have plans for more styling later). More detailed instructions TBD.

Attributes

1. dice: string comma separated list of dice to roll (i.e., "6,8,10,6")
2. total: how the total is arrived at
3. modifier: + or - after dice are rolled
4. bonus-die: additional die added after dice are summed up
5. difficulty: number required for success
6. size: visual size of dice

Installation

Add the dice-roller.js script to your web site, then add the <dice-roller></dice-roller> web component to your html.

CDN

<script src="https://unpkg.com/@colinaut/dice-roller/dist/dice-roller.js"></script>

NPM/PNPM/YARN

npm i @colinaut/dice-roller

pnpm i @colinaut/dice-roller

yarn add @colinaut/dice-roller

Eleventy static site

If you are using Eleventy, and want to install locally rather than rely on the CDN, you can install via NPM/PNPM/YARN and then pass through the js file so that it is included in the output. Then you would just need to add it to the head.

eleventyConfig.addPassthroughCopy({
    "node_modules/@colinaut/dice-roller/dist/dice-roller.js": "js/dice-roller.js",
})

<script src="/js/dice-roller.js"></script>

To Do

• add dice name attribute for each component
• make roll totals trigger custom event. Use dice name attribute for event name
• add modifiers attribute for + or - to rolls
• add bestOf attribute for best of 2 dice for Agon and some PbtA advantage rolls and for Blades in the Dark
• add lowest die
• add built in form field for adjusting dice values
• add svg for dice shape to match different polyhedrons
• highlight the highest dice when BestOf is set
• Add Bonus die for Agon
• Strip out form from dice-roller
• Create dice-box component for listing dice roll history
• Create dice-pbta, dice-agon, and dice-fitd components for each rolls in those systems
• Add clear total function with delay
• Add custom event handlers for roll and clearing totals
• Add difficulty check
• Allow for multiple difficulty levels
• Add way to remove header