rust-roll 0.1.0

A command-line dice roller for tabletop RPGs, following the D&D 5e rules
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

//! A dice-rolling library and command-line tool using tabletop RPG
//! notation such as `2d6+3`.
//!
//! The library has two parts:
//!
//! - [`notation`] parses dice notation into a validated [`notation::Notation`].
//! - [`roller`] rolls a notation in one of several modes, such as advantage
//!   or ability scores, following the D&D 5e (2014) rules.
//!
//! # Examples
//!
//! ```
//! use rust_roll::notation::Notation;
//! use rust_roll::roller::{roll, RollType};
//!
//! let notation: Notation = "d20+5".parse().unwrap();
//! let rolls = roll(RollType::Advantage(notation), &mut rand::rng());
//!
//! assert_eq!(rolls.len(), 2);
//! assert!(rolls[0].total >= rolls[1].total);
//! ```

pub mod notation;
pub mod roller;
#[cfg(test)]
mod test_helpers;