From 4ed561a15b28fce481a30515f0fed6ba78c46821 Mon Sep 17 00:00:00 2001
From: Ean Milligan <ean.milligan@gmail.com>
Date: Sat, 28 Jun 2025 20:31:45 -0400
Subject: [PATCH] add success/failures to readme

---
 README.md | 90 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 48 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index 434d87f..2706a4d 100644
--- a/README.md
+++ b/README.md
@@ -70,48 +70,54 @@ The Artificer comes with a few supplemental commands to the main rolling command
   * PI and e are available for use.
   * Parameters for rolling:
 
-  |  Parameter    |  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, 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                                                                                             |
-  |  kz or khz    |  Optional   |      No       |  keeps the highest z dice, cannot be used with any other drop or keep options                                                                                            |
-  |  dhz          |  Optional   |      No       |  drops the highest z dice, cannot be used with any other drop or keep options                                                                                            |
-  |  klz          |  Optional   |      No       |  keeps the lowest z dice, cannot be used with any other drop or keep options                                                                                             |
-  |  ra or r=a    |  Optional   |      Yes      |  rerolls any rolls that match a, r3 will reroll every die that land on 3, throwing out old rolls, cannot be used with ro                                                 |
-  |  r<a          |  Optional   |      Yes      |  rerolls any rolls that are less than or equal to a, r3 will reroll every die that land on 3, 2, or 1, throwing out old rolls, cannot be used with ro                    |
-  |  r>a          |  Optional   |      Yes      |  rerolls any rolls that are greater than or equal to a, r3 will reroll every die that land on 3 or greater, throwing out old rolls, cannot be used with ro               |
-  |  roa or ro=a  |  Optional   |      Yes      |  rerolls any rolls that match a, r3 will reroll each die that lands on 3 ONLY ONE TIME, throwing out old rolls, cannot be used with r                                    |
-  |  ro<a         |  Optional   |      Yes      |  rerolls any rolls that are less than or equal to a, r3 will reroll each die that lands on 3, 2, or 1 ONLY ONE TIME, throwing out old rolls, cannot be used with r       |
-  |  ro>a         |  Optional   |      Yes      |  rerolls any rolls that are greater than or equal to a, r3 will reroll each die that lands on 3 or greater ONLY ONE TIME, throwing out old rolls, cannot be used with r  |
-  |  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 success                                                                                                                      |
-  |  !o           |  Optional   |      No       |  exploding once, rolls another dy for each original crit success                                                                                                         |
-  |  !p           |  Optional   |      No       |  penetrating explosion, rolls one dy for each crit success, but subtracts one from each resulting explosion                                                              |
-  |  !!           |  Optional   |      No       |  compounding explosion, rolls one dy for each crit success, but adds the resulting explosion to the die that caused this explosion                                       |
-  |  !=u          |  Optional   |      Yes      |  exploding, rolls another dy for every die that lands on u                                                                                                               |
-  |  !>u          |  Optional   |      Yes      |  exploding, rolls another dy for every die that lands on u or greater                                                                                                    |
-  |  !<u>         |  Optional   |      Yes      |  exploding, rolls another dy for every die that lands on u or less                                                                                                       |
-  |  !o=u         |  Optional   |      Yes      |  exploding once, rolls another dy for each original die that landed on u                                                                                                 |
-  |  !o>u         |  Optional   |      Yes      |  exploding once, rolls another dy for each original die that landed on u or greater                                                                                      |
-  |  !o<u         |  Optional   |      Yes      |  exploding once, rolls another dy for each original die that landed on u or less                                                                                         |
-  |  !p=u         |  Optional   |      Yes      |  penetrating explosion, rolls one dy for each die that lands on u, but subtracts one from each resulting explosion                                                       |
-  |  !p>u         |  Optional   |      Yes      |  penetrating explosion, rolls one dy for each die that lands on u or greater, but subtracts one from each resulting explosion                                            |
-  |  !p<u         |  Optional   |      Yes      |  penetrating explosion, rolls one dy for each die that lands on u or under, but subtracts one from each resulting 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 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                                                                                                                       |
-  |  mz           |  Optional   |      No       |  matching dice, adds labels to any dice that have z or more matches                                                                                                      |
-  |  mt           |  Optional   |      No       |  matching dice, adds labels to any dice that match, 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                                                      |
-  |  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                                                                                                        |
+  |  Parameter    |  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, 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                                                                                                             |
+  |  kz or khz    |  Optional   |      No       |  keeps the highest z dice, cannot be used with any other drop or keep options                                                                                                            |
+  |  dhz          |  Optional   |      No       |  drops the highest z dice, cannot be used with any other drop or keep options                                                                                                            |
+  |  klz          |  Optional   |      No       |  keeps the lowest z dice, cannot be used with any other drop or keep options                                                                                                             |
+  |  ra or r=a    |  Optional   |      Yes      |  rerolls any rolls that match a, r3 will reroll every die that land on 3, throwing out old rolls, cannot be used with ro                                                                 |
+  |  r<a          |  Optional   |      Yes      |  rerolls any rolls that are less than or equal to a, r3 will reroll every die that land on 3, 2, or 1, throwing out old rolls, cannot be used with ro                                    |
+  |  r>a          |  Optional   |      Yes      |  rerolls any rolls that are greater than or equal to a, r3 will reroll every die that land on 3 or greater, throwing out old rolls, cannot be used with ro                               |
+  |  roa or ro=a  |  Optional   |      Yes      |  rerolls any rolls that match a, r3 will reroll each die that lands on 3 ONLY ONE TIME, throwing out old rolls, cannot be used with r                                                    |
+  |  ro<a         |  Optional   |      Yes      |  rerolls any rolls that are less than or equal to a, r3 will reroll each die that lands on 3, 2, or 1 ONLY ONE TIME, throwing out old rolls, cannot be used with r                       |
+  |  ro>a         |  Optional   |      Yes      |  rerolls any rolls that are greater than or equal to a, r3 will reroll each die that lands on 3 or greater ONLY ONE TIME, throwing out old rolls, cannot be used with r                  |
+  |  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 success                                                                                                                                      |
+  |  !o           |  Optional   |      No       |  exploding once, rolls another dy for each original crit success                                                                                                                         |
+  |  !p           |  Optional   |      No       |  penetrating explosion, rolls one dy for each crit success, but subtracts one from each resulting explosion                                                                              |
+  |  !!           |  Optional   |      No       |  compounding explosion, rolls one dy for each crit success, but adds the resulting explosion to the die that caused this explosion                                                       |
+  |  !=u          |  Optional   |      Yes      |  exploding, rolls another dy for every die that lands on u                                                                                                                               |
+  |  !>u          |  Optional   |      Yes      |  exploding, rolls another dy for every die that lands on u or greater                                                                                                                    |
+  |  !<u>         |  Optional   |      Yes      |  exploding, rolls another dy for every die that lands on u or less                                                                                                                       |
+  |  !o=u         |  Optional   |      Yes      |  exploding once, rolls another dy for each original die that landed on u                                                                                                                 |
+  |  !o>u         |  Optional   |      Yes      |  exploding once, rolls another dy for each original die that landed on u or greater                                                                                                      |
+  |  !o<u         |  Optional   |      Yes      |  exploding once, rolls another dy for each original die that landed on u or less                                                                                                         |
+  |  !p=u         |  Optional   |      Yes      |  penetrating explosion, rolls one dy for each die that lands on u, but subtracts one from each resulting explosion                                                                       |
+  |  !p>u         |  Optional   |      Yes      |  penetrating explosion, rolls one dy for each die that lands on u or greater, but subtracts one from each resulting explosion                                                            |
+  |  !p<u         |  Optional   |      Yes      |  penetrating explosion, rolls one dy for each die that lands on u or under, but subtracts one from each resulting 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 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, 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, 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, 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, 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                                                                                                                         |
+  |  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 Repeatable, it may occur multiple times in the roll configuration.