aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2014-12-09 20:42:04 +0100
committerRenaud G <renaud@rolisteam.org>2014-12-09 20:42:04 +0100
commitcf23e20af397b228702531b749107846a4025b13 (patch)
treefd2884956218935d4e94d494c01bd96f8999d1aa
parent81dbddb4524d9cb1e1ac8c1552b6999e7d39d75c (diff)
parent04a48e730e421724531c2a0e015e35134452e7d7 (diff)
downloadOneRoll-cf23e20af397b228702531b749107846a4025b13.tar.gz
OneRoll-cf23e20af397b228702531b749107846a4025b13.zip
Merge branch 'master' of github-as-renaud:obiwankennedy/DiceParser
-rw-r--r--HelpMe.md74
1 files changed, 58 insertions, 16 deletions
diff --git a/HelpMe.md b/HelpMe.md
index 60e80ab..484a972 100644
--- a/HelpMe.md
+++ b/HelpMe.md
@@ -7,7 +7,7 @@ It is real simple. you have to call:
The first number is the count of dice you want to roll. The second number should be die's faces count.
-### Example
+### Examples
> 1d6
Roll one six-faced die.
@@ -48,44 +48,86 @@ The option sorts the resulting die list and select the X better.
Dice explose if their value are at the die maximum, the option sorts the resulting die list, the it selects the X better.
+### Sorting
+
> 3D10s
The dice list is sorted in descending order.
+### Counter
+
+> 3D10c[Validator]
+
+Count how many dice respect the condition and display the number (See Validator for more details about syntax)
+
+### Reroll
+
+> 3D10r[Validator]
+
+Reroll the die if the previous value fits the validator (See Validator for more details about syntax).
+
+### Explose
+
+> 3D10e[Validator]
+
+Explose while the value fits the Validator (See Validator for more details about syntax).
+
+### Add
+
+> 3D10a[Validator]
+
+Reroll the die if its value fits the Validator and add the new value to the previous one. It does that only once.
+
+
+## Arithmetic
-> 3D10c[condition]
+Rolisteam Dice Parser is able to compute primary arithmetic operation such as: +, -, /, * and it also manages those operator priority and it can also manage parenthesis.
-Count how many dice respect the condition. And display the number. (See boolean condition and range for more details about the condition)
+> 8+8+8
-> 3D10rX
+Result: 24
+> 24-4
+
+Result: 20
+
+
+
+## Examples
+
+> 3D100
-### 3D100
Roll 3 dice with 100 faces
-### 10D10e[=10]s
+> 10D10e[=10]s
+
Roll 10 dice with 10 faces, 10 exploses, and sort the result.
-### 100291D66666666s
-roll 100291 dice with 66666666666 faces and sort result
+> 100291D66666666s
+
+Roll 100291 dice with 66666666666 faces and sort result
+
+> 15D10c[>7]
-### 15D10c[>7]
roll 15 dice with 10 faces and it counts number of dice which are above 7
-### 1D8+2D6+7
+> 1D8+2D6+7
+
roll 1 die with 8 faces and add the result to 2 dice with 6 faces and add 7.
-### D25
+> D25
+
roll 1 die with 25 faces
-### 88-1D20
+> 88-1D20
+
88 minus the value of 1 die of 20 faces
-### 8+8+8
+> 8+8+8
+
compute: 24
+> 100/28*3
+
-### 100/28*3
-compute: 100/28 = 3
-3*3 = 9