@dice-roller/rpg-dice-roller/readme.md

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

<p align="center">
    <img src="https://dice-roller.github.io/documentation/dice-roller-logo.png" alt="RPG Dice Roller" style="max-width: 100%;" width="200"/>
</p>

# RPG Dice Roller

[![npm (scoped)](https://img.shields.io/npm/v/@dice-roller/rpg-dice-roller?label=version)](https://www.npmjs.com/package/@dice-roller/rpg-dice-roller)
[![Build Status](https://github.com/dice-roller/rpg-dice-roller/actions/workflows/build.yml/badge.svg)](https://github.com/dice-roller/rpg-dice-roller/actions/workflows/build.yml)
[![Coverage Status](https://coveralls.io/repos/github/dice-roller/rpg-dice-roller/badge.svg?branch=main)](https://coveralls.io/github/dice-roller/rpg-dice-roller?branch=main)
![npm type definitions](https://img.shields.io/npm/types/@dice-roller/rpg-dice-roller)
[![License](https://img.shields.io/npm/l/@dice-roller/rpg-dice-roller)](./licence.txt)
[![npm downloads](https://img.shields.io/npm/dm/@dice-roller/rpg-dice-roller)](https://www.npmjs.com/package/@dice-roller/rpg-dice-roller)

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


## Install

```bash
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](https://github.com/dice-roller/vue) - For Tailwind, Bootstrap, basic HTML, and renderless
* [Vuepress plugin](https://github.com/dice-roller/vuepress-plugin) - Dice roller plugin used in this documentation
* [CLI](https://github.com/dice-roller/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