https://github.com/finitum/roll-rs
Rust dice roller using dice notation
https://github.com/finitum/roll-rs
dice dice-notation dice-roller dnd dnd-tools hacktoberfest wasm
Last synced: about 1 year ago
JSON representation
Rust dice roller using dice notation
- Host: GitHub
- URL: https://github.com/finitum/roll-rs
- Owner: finitum
- License: eupl-1.2
- Created: 2020-11-25T18:29:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-30T13:28:52.000Z (over 3 years ago)
- Last Synced: 2024-08-09T18:37:04.649Z (almost 2 years ago)
- Topics: dice, dice-notation, dice-roller, dnd, dnd-tools, hacktoberfest, wasm
- Language: Rust
- Homepage: https://finitum.github.io/roll-rs/
- Size: 87.9 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roll-rs
roll-rs is a dice roller that allows one to roll arbitrary dice and potentially combine them with arithmetic
## Usage Modes
**Normal usage**
```
$ roll d8 + 2d4
d8 d4
d8 + 2d4 = 8
3 1
4
```
**Short mode**
```
$ roll -s d8 + 2d4
d8 + 2d4 = [3] + [1, 4] = 8
```
**Advanced mode**
_this allows using dice rolls to determine the sides and amount of another roll_
```
$ roll -a (d8)d(2d4)
d8 d7 d4
(d8)d(2d4) = 5
2 3 3
2 4
```
## Notation
**Standard**
Standard notation allows you to roll any sided die any number of times
```shell script
d # roll a single 20 sided die
1d20 # equivalent
```
**Percentile**
You can use `%` as a shorthand for 100 sides
```shell script
3d% # roll a percentile die 3 times and add them together
3d100 # equivalent
```
**Keep**
The keep modifier allows you to roll multiple dice but only keep the highest or lowest result(s)
```shell script
4d8kh2 # roll a d8 4 times and keep the highest 2 rolls
4d8k2 # equivalent to the above
4d8kl1 # roll a d10 4 times and keep the lowest roll
```
**Drop**
The keep modifier allows you to roll multiple dice but drop the highest or lowest result(s)
(Opposite of Keep).
```shell script
4d8dl2 # roll a d8 4 times and drop the lowest 2 rolls
4d8d2 # equivalent to the above
4d8dh1 # roll a d8 4 times and drop the highest roll
```
## Maths
Roll-rs supports the following arithmetic operators
| Operator | Description |
| -------- | ----------- |
| + | Plus |
| - | Minus |
| * | Multiplication |
| / | Division |
| // | Integer division |
| mod | Modulo |
| ** | Exponentiation |
Roll-rs follows the normal order of operations and also allows the use of parenthesis to affect this.