discord-bots/TheArtificer
discord-bots
/
TheArtificer
mirror of https://github.com/Burn-E99/TheArtificer.git
1
1
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

Added GEQ/LEQ documentation to readme

This commit is contained in:
Ean Milligan (Bastion) 2022-05-17 00:35:42 -04:00
parent ddd091d572
commit 781092a24f
3 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -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 |
| cs<q | Optional | Yes | changes crit score to be less than or equal to q |
| cs>q | Optional | Yes | changes crit score to be greater than or equal to q |
| cfq or cf=q | Optional | Yes | changes crit fail to q |
| cf<q | Optional | Yes | changes crit fail to be less than or equal to q |
| cf>q | 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 |
| r<a | Optional | Yes | rerolls any rolls that are less than or equal to a, r3 will reroll any dice that land on 3, 2, or 1, throwing out old rolls |
| r>a | 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 |
| cs<q | Optional | Yes | changes crit score to be less than or equal to q |
| cs>q | Optional | Yes | changes crit score to be greater than or equal to q |
| cfq or cf=q | Optional | Yes | changes crit fail to q |
| cf<q | Optional | Yes | changes crit fail to be less than or equal to q |
| cf>q | 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.

2
src/constantCmds.ts
View File

@ -253,7 +253,7 @@ export const constantCmds = {
inline: true
}, {
name: "`r<q` [Optional]",
value: "Rerolls any rolls that are less than or equal to `a`, `r3` will reroll any dice that land on 3, 2, or 1, throwing out old rolls",
value: "Rerolls any rolls that are less than or equal to `a`, `r3` will reroll any dice that land on 3, 2, or 1, throwing out old rolls",
inline: true
}, {
name: "`r>q` [Optional]",

4
src/solver/roller.ts
View File

@ -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
* r<a [OPT] - rerolls any rolls that are less than or equal to a, r3 will reroll any dice that land on 3, 2, or 1, throwing out old rolls
* r>a [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
* cs<q [OPT] - changes crit score to be less than or equal to q
* cs>q [OPT] - changes crit score to be greater than or equal to q