add success/failures to readme

This commit is contained in:
Ean Milligan 2025-06-28 20:31:45 -04:00
parent 15fd57ea18
commit 4ed561a15b
1 changed files with 48 additions and 42 deletions

View File

@ -71,7 +71,7 @@ The Artificer comes with a few supplemental commands to the main rolling command
* Parameters for rolling: * Parameters for rolling:
| Parameter | Required? | Repeatable? | Description | | Parameter | 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, replace y with `F` to roll the dice as Fate dice | | dy | Required | No | size of dice to roll, d20 = 20 sided die, replace y with `F` to roll the dice as Fate dice |
| dz or dlz | Optional | No | drops the lowest z dice, cannot be used with any other drop or keep options | | dz or dlz | Optional | No | drops the lowest z dice, cannot be used with any other drop or keep options |
@ -106,12 +106,18 @@ The Artificer comes with a few supplemental commands to the main rolling command
| !!=u | Optional | Yes | compounding explosion, rolls one dy for each die that lands on u, but adds the resulting explosion to the die that caused this explosion | | !!=u | Optional | Yes | compounding explosion, rolls one dy for each die that lands on u, but adds the resulting explosion to the die that caused this explosion |
| !!>u | Optional | Yes | compounding explosion, rolls one dy for each die that lands on u or greater, but adds the resulting explosion to the die that caused this explosion | | !!>u | Optional | Yes | compounding explosion, rolls one dy for each die that lands on u or greater, but adds the resulting explosion to the die that caused this explosion |
| !!<u | Optional | Yes | compounding explosion, rolls one dy for each die that lands on u or under, but adds the resulting explosion to the die that caused this explosion | | !!<u | Optional | Yes | compounding explosion, rolls one dy for each die that lands on u or under, but adds the resulting explosion to the die that caused this explosion |
| m | Optional | No | matching dice, adds labels to any dice that match | | m | Optional | No | matching dice, adds labels to any dice that match, cannot be combined with Target Number/Successes or Target Failures |
| mz | Optional | No | matching dice, adds labels to any dice that have z or more matches | | mz | Optional | No | matching dice, adds labels to any dice that have z or more matches, cannot be combined with Target Number/Successes or Target Failures |
| mt | Optional | No | matching dice, adds labels to any dice that match, changes result to be the count of labels added | | mt | Optional | No | matching dice, adds labels to any dice that match, changes result to be the count of labels added, cannot be combined with Target Number/Successes or Target Failures |
| mtz | Optional | No | matching dice, adds labels to any dice that have z or more matches, changes result to be the count of labels added | | mtz | Optional | No | matching dice, adds labels to any dice that have z or more matches, changes result to be the count of labels added, cannot be combined with Target Number/Successes or Target Failures |
| s or sa | Optional | No | sort dice, sorts the list of dice for a roll in ascending order | | s or sa | Optional | No | sort dice, sorts the list of dice for a roll in ascending order |
| sd | Optional | No | sort dice, sorts the list of dice for a roll in descending order | | sd | Optional | No | sort dice, sorts the list of dice for a roll in descending order |
| =z | Optional | Yes | target number/success, counts and marks dice as successful when they land on z, cannot be combined with the Dice Matching option |
| <z | Optional | Yes | target number/success, counts and marks dice as successful when they land on z or less, cannot be combined with the Dice Matching option |
| >z | Optional | Yes | target number/success, counts and marks dice as successful when they land on z or greater, cannot be combined with the Dice Matching option |
| fz or f=z | Optional | Yes | target failures, counts and marks dice as failed when they land on z, cannot be combined with the Dice Matching option |
| f<z | Optional | Yes | target failures, counts and marks dice as failed when they land on z or less, cannot be combined with the Dice Matching option |
| f>z | Optional | Yes | target failures, counts and marks dice as failed when they land on z or greater, cannot be combined with the Dice Matching option |
* If the parameter is Required, it must be provided at all times. * 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. * If the parameter is Repeatable, it may occur multiple times in the roll configuration.