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

4
README.md
View File

@ -62,7 +62,7 @@ The Artificer comes with a few supplemental commands to the main rolling command
* Parameters for rolling: * Parameters for rolling:
| Paramater | Required? | Repeatable? | Description | | Paramater | Required? | Repeatable? | Description |
|---------------|-------------|---------------|--------------------------------------------------------------------------------------------------| |---------------|-------------|---------------|------------------------------------------------------------------------------------------------------------------------------------|
| x | Optional | No | number of dice to roll, if omitted, 1 is used | | 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 | | 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 | | dz or dlz | Optional | No | drops the lowest z dice, cannot be used any other drop or keep options |
@ -70,6 +70,8 @@ The Artificer comes with a few supplemental commands to the main rolling command
| dhz | Optional | No | drops 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 | | 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 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 | | 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 less than or equal to q |
| cs>q | Optional | Yes | changes crit score to be greater than or equal to q | | cs>q | Optional | Yes | changes crit score to be greater than or equal to q |

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 * 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 * dhz [OPT] - drops the highest z dice, cannot be used with kz
* klz [OPT] - keeps the lowest z dice, cannot be used with dz * 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 * 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 less than or equal to q
* cs>q [OPT] - changes crit score to be greater than or equal to q * cs>q [OPT] - changes crit score to be greater than or equal to q