ndice

Role a nice dice (or [n|d]ice?)

Table of Contents

• About
• Installation
  • Binary
  • Cargo
• Usage
• Contributing
  • Where to start?
  • Tooling
  • Install dev build
• License

About

ndice is a cli dice roller.

Dices are writen in the format ${number}d{$sides}, e.g. 1d6 means 1 six-sided dice. There's no limit to sides so a non-existing dice like 1d13 can be rolled.

• Each space-speparated argument is counted as one dice notation.
• Dices can be mixed, so ndice 1d6 2d8 4d10 works.
• Invalid arguments are ignored.

Installation

⬆️ Back to Top

Binary

Download a pre-compiled binary from the release page

Cargo

Install with cargo:

$ cargo install ndice

Usage

⬆️ Back to Top

$ ndice [dice]

Examples:

# Roll 1 six-sided dice
$ ndice 1d6
Rolled: ["d6 => 1"]
Result: 1
# Roll 2 8 sided dice and 2 four sided dice
$ ndice 2d8 2d4
Rolled: ["d8 => 6", "d8 => 3", "d4 => 1", "d4 => 1"]
Result: 11

Contributing

⬆️ Back to Top

We love and welcome every form of contribution.

Where to start?

Here are some good places to start:

• Issues with label Good first issue
• Issues with label Documentation
• Providing example implementations or usage demos

Tooling

• mktoc is used for table of content generation in the README.md (neat!)
• criterion for benchmarking

Install dev build

Sometimes it's nice to install a specific version of mktoc, this can be done with the following command:

# install specific commit
cargo install --git https://github.com/KevinGimbel/mktoc --force --rev $COMMIT_ID
# install branch
cargo install --git https://github.com/KevinGimbel/mktoc --force --branch $BRANCH_NAME

License

⬆️ Back to Top

MIT, see LICENSE file.