Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Geobert/caith
A dice roller library written in Rust
https://github.com/Geobert/caith
Last synced: 25 days ago
JSON representation
A dice roller library written in Rust
- Host: GitHub
- URL: https://github.com/Geobert/caith
- Owner: Geobert
- Created: 2020-08-05T18:02:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-07T21:12:33.000Z (about 2 years ago)
- Last Synced: 2024-03-12T07:03:09.477Z (9 months ago)
- Language: Rust
- Size: 76.2 KB
- Stars: 19
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-pest - caith - A dice roller crate. (Projects)
README
[](https://docs.rs/caith)
[](https://crates.io/crates/caith)
[](https://crates.io/crates/caith)
# Caith
A dice roller library written in Rust (and also a card drawer).
This crate aims at providing everything needed for playing tabletop RPG.
The different features are inspired by [DiceMaiden](https://github.com/Humblemonk/DiceMaiden)
and [Sidekick](https://github.com/ArtemGr/Sidekick).
[Dìsle](https://github.com/Geobert/disle/) is a Discord bot build upon `caith`.
# Usage
```rust
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
tt# : minimum value to count as two successes
t[] : enumeration of values considered 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.
Reason:
: : Any text after `:` will be a comment
```
# Helpers
Some helpers are provided to interpret the roll result according to specific RPG rules.
See the helpers documentation for more details.
You'll need to add the feature flag of the helpers that you need.
At the moment, the supported feature flags are:
- `ova`: helper for "OVA: The Anime Role-Playing Game result"
- `cde`: helper for "Hong Kong, Les Chroniques de l'étrange"
None is activated by default
# Cards
`caith` can create a standard deck of 52 cards plus optional Jokers if the feature `cards`
is activated. See [`cards::Deck`].
# Limitations
To avoid OOM issue, there is a limit of 5000 dices of 5000 sides maximum.
# Examples
These examples are directly taken from DiceMaiden's Readme:
`2d6 + 3d10` : Roll two six-sided dice and three ten-sided dice.
`3d6 + 5` : Roll three six-sided dice and add five. Other supported static modifiers are
add (+), subtract (-), multiply (*), and divide (/).
`3d6 * 1.5` : Roll three six-sided dice and add 50%.
`3d6 e6` : 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 `ie` for indefinite explosions.
`3d6 ie6` or `3d6!` : Roll three six-sided dice and explode on sixes indefinitely within reason.
We will cap explosions at 100 rolls to prevent abuse.
`3d10 d1` : Roll three ten-sided dice and drop one die. The lowest value will be dropped first.
`3d10 K2` : Roll three ten-sided dice and keep two. The highest value rolled will be kept.
Using lowercase `k` will keep the lowest.
`4d6 r2` : Roll four six-sided dice and reroll any that are equal to or less than two once.
Use `ir` for indefinite rerolls.
`4d6 ir2` : 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.
`6d10 t7` : 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.
`5d10 t8 f1` : 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 tt10` : 8 and 9 are counted as success, 10 are counted twice.
`3d6 t[2,4,6]` : only even result will count as success (handy for games like "Knight").
`4d10 k3` : Roll four ten-sided dice and keep the lowest three dice rolled.
`4d6 : Hello World!`: Roll four six-sided dice and add comment to the roll.
These commands can be combined. For example:
`10d6 e6 K8 +4` : Roll ten six-sided dice , explode on sixes and keep eight of the highest rolls
and add four.