Skip to content

An advanced JS based dice roller that can roll various types of dice and modifiers, along with mathematical equations.

License

Notifications You must be signed in to change notification settings

dice-roller/rpg-dice-roller

Repository files navigation

RPG Dice Roller

RPG Dice Roller

npm (scoped) Build Status Coverage Status npm type definitions License npm downloads

A JS based dice roller that can roll various types of dice and modifiers, along with mathematical equations.

Install

npm install @dice-roller/rpg-dice-roller

Documentation

Check out the documentation at https://dice-roller.github.io/documentation

Usage in the wild

Official

  • Vue components - For Tailwind, Bootstrap, basic HTML, and renderless
  • Vuepress plugin - Dice roller plugin used in this documentation
  • CLI - Command Line Interface for rolling dice

Contributing

We're always happy for community contributions. You can find our contributing guide in the docs: https://dice-roller.github.io/documentation/contributing

Licence

This dice roller has been released under the MIT licence, meaning you can do pretty much anything you like with it, so long as the original copyright remains in place.

You can use it in commercial products.

If the licence terminology in the licence.txt is confusing, check out this: https://www.tldrlegal.com/l/mit