### 16 releases (7 stable)

new 2.2.1 | Nov 23, 2020 |
---|---|

2.1.0 | Oct 17, 2020 |

1.0.1 | Aug 27, 2020 |

0.5.0 | Aug 8, 2020 |

#**35** in Game dev

**134** downloads per month

Used in disle

**MIT**license

45KB

1K
SLoC

# Caith

A dice roller library written in Rust.

The different features are inspired by https://github.com/Humblemonk/DiceMaiden and https://github.com/ArtemGr/Sidekick.

Dìsle is a Discord bot build upon

.`caith`

# Usage

`use` `caith``::``{`Roller`,` RollResult`,` RollResultType`}``;`
`//` ...
`let` result `=` `Roller``::`new`(``"`1d6 : initiative`"``)``.``unwrap``(``)``.``roll``(``)``.``unwrap``(``)``;`
`printf``(``"`{}`"``,` result`)``;`

# Syntax

`xdy ``[``OPTIONS``]` `[``TARGET``]` `[``FAILURE``]` `[``!` `REASON``]`
roll `x` `dice``(`s`)` with `y` sides
`y` can also be `"`F`"` or `"`f`"` `for` fudge dice`.` In this case`,` no option applies and ignored `if` provided`.`
Options`:`
`+` `-` `/` `*` `:` modifiers
e`#` `:` Explode value`.` If number is omitted`,` we `use` dice sides
ie`#` or `!``#` `:` Indefinite explode value`,` If number is omitted`,` we `use` dice sides
K`#` `:` Keeping `#` highest `(`upperacse `"`K`"``)`
k`#` `:` Keeping `#` lowest `(`lowercase `"`k`"``)`
D`#` `:` Dropping the highest `(`uppercase `"`D`"``)`
d`#` `:` Dropping the lowest `(`lowercase `"`d`"``)`
r`#` `:` Reroll `if` `<=` value
ir`#` `:` Indefinite reroll `if` `<=` value
Target`:`
t`#` `:` minimum value to count `as` success
Failure`:`
f`#` `:` value under which it`'s` counted `as` failure
Repetition`:`
a roll can be repeated with ``^`` operator`:` ``(`2d6 `+` `6``)` `^` `8`` will roll eight times the expression`.`
Summed repetition`:`
with the ``^``+`` operator`,` the roll will be repeated and all the totals summed`.`
Sorted repetition`:`
with the ``^``#`` operator`,` the roll will be repeated and sorted by total`.`
`OVA` roll`:`
positive`:` ``ova``(``12``)`` or negative`:` ``ova``(``-``5``)``
Reason`:`
`:` `:` Any text after ``:`` will be a comment

# Examples

These examples are directly taken from DiceMaiden's Readme:

: Roll two six-sided dice and three ten-sided dice.`2d6 + 3d10`

: Roll three six-sided dice and add five. Other supported static modifiers are add (+), subtract (-), multiply (*), and divide (/).`3d6 + 5`

: Roll three six-sided dice and explode on sixes. Some game systems call this 'open ended' dice. If the number rolled is greater than or equal to the value given for this option, the die is rolled again and added to the total. If no number is given for this option, it is assumed to be the same as the number of sides on the die. Thus, '3d6 e' is the same as '3d6 e6'. The dice will only explode once with this command. Use `3d6 e6`

for indefinite explosions.`ie`

or `3d6 ie6`

: Roll three six-sided dice and explode on sixes indefinitely within reason. We will cap explosions at 100 rolls to prevent abuse.`3d6 !`

: Roll three ten-sided dice and drop one die. The lowest value will be dropped first. `3d10 d1`**NOTE:** These dice are dropped before any dice are kept with the following

command. Order of operations is : roll dice, drop dice, keep dice`k`

: Roll three ten-sided dice and keep two. The highest value rolled will be kept.
Using lowercase `3d10 K2`

`k`

will keep the lowest.

: Roll four six-sided dice and reroll any that are equal to or less than two once. Use `4d6 r2`

for indefinite rerolls.`ir`

: Roll four six-sided dice and reroll any that are equal to or less than two (and do the same to those dice). This is capped at 100 rerolls per die to prevent abuse.`4d6 ir2`

: Roll six ten-sided dice and any that are seven or higher are counted as a success. The dice in the roll are not added together for a total. Any die that meets or exceeds the target number is added to a total of successes.`6d10 t7`

: f# denotes a failure number that each dice must match or be beneath in order to count against successes. These work as a sort of negative success and are totalled together as described above. In the example roll, roll five ten-sided dice and each dice that is 8 or higher is a success and subtract each one. The total may be negative. If the option is given a 0 value, that is the same as not having the option at all thus a normal sum of all dice in the roll is performed instead.`5d10 t8 f1`

: Roll four ten-sided dice and keep the lowest three dice rolled.`4d10 k3`

: Roll four six-sided dice and add comment to the roll.`4d6 : Hello World!`

These commands can be combined. For example:

: Roll ten six-sided dice , explode on sixes and keep eight of the highest rolls and add four.`10d6 e6 K8 +4`

#### Dependencies

~1.7–2.3MB

~50K SLoC