# dicecup

> Interprets strings (e.g. '1d6+1') to roll dice.

Latest version **1.1.2** (published 2019-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install dicecup
pnpm add dicecup
yarn add dicecup
bun add dicecup
```

Provides the command `cup`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2019-05-06 |
| First published | 2015-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jim Kang |
| Maintainers | jimkang |

## Links

- npm: https://www.npmjs.com/package/dicecup
- Repository: https://github.com/jimkang/dicecup
- Issues: https://github.com/jimkang/dicecup/issues
- npm.io page: https://npm.io/package/dicecup

## Dependencies (2)

- [probable](https://npm.io/package/probable.md) ^1.1.0
- [lodash.isobject](https://npm.io/package/lodash.isobject.md) ^3.0.2

## Recent versions

- 1.1.2 (latest) — 2019-05-06
- 1.1.1 — 2019-05-01
- 1.1.0 — 2015-01-18
- 1.0.9 — 2015-01-18
- 1.0.7 — 2015-01-16
- 1.0.6 — 2015-01-13
- 1.0.5 — 2015-01-10
- 1.0.4 — 2015-01-10
- 1.0.3 — 2015-01-10
- 1.0.2 — 2015-01-10
- 1.0.1 — 2015-01-10
- 1.0.0 — 2015-01-10

## README

dicecup
==================

Interprets strings (e.g. '1d6+1') to roll dice. This module uses the parser from the excellent [node-dice](https://github.com/NickMele/node-dice) with a few tweaks to interpret strings in [http://en.wikipedia.org/wiki/Dice_notation](dice notation) to make die rolls and report the results as JSON.

It will apply modifiers (pluses and minuses) and will provide a total for each space-separated group in the string. For example, the results for the `dicecup.roll('3d6 3d6 1d52 1d4')` will be something like:

    [
      {
        rolls: [
          4,
          6,
          5
        ],
        total: 15
      },
      {
        rolls: [
          4,
          3,
          4
        ],
        total: 11
      },
      {
        rolls: [
          22
        ],
        total: 22
      },
      {
        rolls: [
          3
        ],
        total: 3
      }
    ]

By default, there's no limits on the number of dice you want to roll. `node cup.js 999999d6` works on my machine. It's up to you to to limit the resources taken up by `roll` by creating diceCup with the `numberOfFacesOnLargestDie` and `numberOfRollsLimit` opts like so: 

    var cup = createDiceCup({
      probable: mockProbable,
      numberOfFacesOnLargestDie: 50000,
      numberOfRollsLimit: 125000
    });

Installation
------------

    npm install dicecup

Usage
-----

    var createDiceCup = require('dicecup');
    var cup = createDiceCup();
    console.log(cup.roll('2d4'));

As a command:

    npm -g dicecup
    cup "3d6 3d6 1d52 1d4"

Tests
-----

Run tests with `make test`.

License
-------

MIT.

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