# @dice-roller/rpg-dice-roller

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

Latest version **5.5.1** (published 2025-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dice-roller/rpg-dice-roller
pnpm add @dice-roller/rpg-dice-roller
yarn add @dice-roller/rpg-dice-roller
bun add @dice-roller/rpg-dice-roller
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 5.5.1 |
| Published | 2025-02-08 |
| First published | 2021-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0 |
| Dependencies | 2 |
| Unpacked size | 575 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 284 |
| Author | GreenImp Media |
| Maintainers | greenimp |
| Keywords | dice, roller, rpg, roll, d&d, dnd, random, prng, roleplay, pathfinder, notation |

## Links

- npm: https://www.npmjs.com/package/@dice-roller/rpg-dice-roller
- Repository: https://github.com/dice-roller/rpg-dice-roller
- Homepage: https://dice-roller.github.io/documentation
- Issues: https://github.com/dice-roller/rpg-dice-roller/issues
- Funding: https://github.com/sponsors/dice-roller
- npm.io page: https://npm.io/package/@dice-roller/rpg-dice-roller

## Dependencies (2)

- [mathjs](https://npm.io/package/mathjs.md) ^14.2.0
- [random-js](https://npm.io/package/random-js.md) ^2.1.0

## Recent versions

- 5.5.1 (latest) — 2025-02-08
- 6.0.0-alpha.6 (next) — 2023-05-12
- 5.5.0 — 2023-11-28
- 5.4.1 — 2023-07-18
- 5.4.0 — 2023-07-06
- 5.3.2 — 2023-05-12
- 6.0.0-alpha.5 — 2023-05-12
- 5.3.1 — 2023-05-11
- 5.3.0 — 2023-05-11
- 6.0.0-alpha.4 — 2023-05-09
- 6.0.0-alpha.3 — 2023-05-09
- 6.0.0-alpha.2 — 2023-05-09
- 5.2.2 — 2023-05-09
- 6.0.0-alpha.1 — 2023-05-09
- 6.0.0-alpha.0 — 2023-05-09
- … 4 more at https://npm.io/package/@dice-roller/rpg-dice-roller/versions

## README

<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

---
_Source: https://npm.io/package/@dice-roller/rpg-dice-roller · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._