From 781092a24fc144ba925d05a39c6aacfa3fbbaead Mon Sep 17 00:00:00 2001 From: "Ean Milligan (Bastion)" Date: Tue, 17 May 2022 00:35:42 -0400 Subject: [PATCH] Added GEQ/LEQ documentation to readme --- README.md | 34 ++++++++++++++++++---------------- src/constantCmds.ts | 2 +- src/solver/roller.ts | 4 +++- 3 files changed, 22 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 3fb2793..4f41e37 100644 --- a/README.md +++ b/README.md @@ -61,22 +61,24 @@ The Artificer comes with a few supplemental commands to the main rolling command * PI and e are available for use. * Parameters for rolling: - | Paramater | Required? | Repeatable? | Description | - |---------------|-------------|---------------|--------------------------------------------------------------------------------------------------| - | x | Optional | No | number of dice to roll, if omitted, 1 is used | - | dy | Required | No | size of dice to roll, d20 = 20 sided die | - | dz or dlz | Optional | No | drops the lowest z dice, cannot be used any other drop or keep options | - | kz or khz | Optional | No | keeps the highest z dice, cannot be used any other drop or keep options | - | dhz | Optional | No | drops the highest z dice, cannot be used any other drop or keep options | - | klz | Optional | No | keeps the lowest z dice, cannot be used any other drop or keep options | - | ra | Optional | Yes | rerolls any rolls that match a, r3 will reroll any dice that land on 3, throwing out old rolls | - | csq or cs=q | Optional | Yes | changes crit score to q | - | csq | Optional | Yes | changes crit score to be greater than or equal to q | - | cfq or cf=q | Optional | Yes | changes crit fail to q | - | cfq | Optional | Yes | changes crit fail to be greater than or equal to q | - | ! | Optional | No | exploding, rolls another dy for every crit roll | + | Paramater | Required? | Repeatable? | Description | + |---------------|-------------|---------------|------------------------------------------------------------------------------------------------------------------------------------| + | x | Optional | No | number of dice to roll, if omitted, 1 is used | + | dy | Required | No | size of dice to roll, d20 = 20 sided die | + | dz or dlz | Optional | No | drops the lowest z dice, cannot be used any other drop or keep options | + | kz or khz | Optional | No | keeps the highest z dice, cannot be used any other drop or keep options | + | dhz | Optional | No | drops the highest z dice, cannot be used any other drop or keep options | + | klz | Optional | No | keeps the lowest z dice, cannot be used any other drop or keep options | + | ra | Optional | Yes | rerolls any rolls that match a, r3 will reroll any dice that land on 3, throwing out old rolls | + | ra | Optional | Yes | rerolls any rolls that are greater than or equal to a, r3 will reroll any dice that land on 3 or greater, throwing out old rolls | + | csq or cs=q | Optional | Yes | changes crit score to q | + | csq | Optional | Yes | changes crit score to be greater than or equal to q | + | cfq or cf=q | Optional | Yes | changes crit fail to q | + | cfq | Optional | Yes | changes crit fail to be greater than or equal to q | + | ! | Optional | No | exploding, rolls another dy for every crit roll | * If the parameter is Required, it must be provided at all times. * If the parameter is Repeatable, it may occur multiple times in the roll configuration. diff --git a/src/constantCmds.ts b/src/constantCmds.ts index 9271887..0b8b07a 100644 --- a/src/constantCmds.ts +++ b/src/constantCmds.ts @@ -253,7 +253,7 @@ export const constantCmds = { inline: true }, { name: "`rq` [Optional]", diff --git a/src/solver/roller.ts b/src/solver/roller.ts index 1f7b0a8..99c5d60 100644 --- a/src/solver/roller.ts +++ b/src/solver/roller.ts @@ -19,7 +19,9 @@ export const roll = (rollStr: string, maximiseRoll: boolean, nominalRoll: boolea * kz || khz [OPT] - keeps the highest z dice, cannot be used with dz * dhz [OPT] - drops the highest z dice, cannot be used with kz * klz [OPT] - keeps the lowest z dice, cannot be used with dz - * ra [OPT] - rerolls any rolls that match a, r3 will reroll any dice that land on 3, throwing out old rolls + * ra || r=a [OPT] - rerolls any rolls that match a, r3 will reroll any dice that land on 3, throwing out old rolls + * ra [OPT] - rerolls any rolls that are greater than or equal to a, r3 will reroll any dice that land on 3 or greater, throwing out old rolls * csq || cs=q [OPT] - changes crit score to q * csq [OPT] - changes crit score to be greater than or equal to q