aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/HelpMe.md
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2020-01-29 01:40:46 +0100
committerRenaud G <renaud@rolisteam.org>2020-01-29 01:40:46 +0100
commitec4e06259947921b6958e3cdf27786904a79af2f (patch)
treeea3fd9964199a43217419e1317ebb4519264d8d1 /HelpMe.md
parent825bcda767d2bab9f470d81cd76b9e5985fbea9c (diff)
downloadOneRoll-ec4e06259947921b6958e3cdf27786904a79af2f.tar.gz
OneRoll-ec4e06259947921b6958e3cdf27786904a79af2f.zip
Output tags for dice list.
Diffstat (limited to 'HelpMe.md')
-rw-r--r--HelpMe.md99
1 files changed, 63 insertions, 36 deletions
diff --git a/HelpMe.md b/HelpMe.md
index 7350271..406291b 100644
--- a/HelpMe.md
+++ b/HelpMe.md
@@ -407,25 +407,73 @@ Same as above, but the final result is displayed beside Success or Fail.
Same as above, but the result of each die is displayed inside square brackets.
+### Group
+
+Group dices, then count the number of group (7th sea system).
+
+#### Example
+
+> 3d20g10
+
+This will roll 3 dices and then try to group them to make groups of 10. If you get `9 9 2`, you can only create one group whose value is more or equal to ten (`{9,2}`, the second `9` being "wasted").
+
+The `g` operator is allowed to re-order dices to create groups. When rolling `4d20g10`, if you get `7 4 3 6`, the result will be `2` (`{7,3}` and `{6,4}`).
+
+
+### Comment (\#)
+
+> 2D6 # Sword attack
+
+Display "Sword attack" and the result of the two dice.
+DiceParser ignore everything after the \#. The whole part is treated as one comment.
+So DiceParser can answer question:
+
+> 1L[yes,no] # Am I evil ?
+
+```
+Am I evil ?
+yes
+```
+
+## The output
+
+DiceParser provides features to let you control the command output.
+The final instruction must be a string instruction.
+String instruction starts with `"` and ends with `"`.
+
+Rolling:
+> `"result"`
+
+Output:
+`result`
+You can set string instruction inside if operator:
-#### String Result
+> 1d6i:[>3]{"Success"}{"Fail"}
-To improve readability, it is possible to set the text that should be displayed after the roll.
+Output:
+`Success` or `Fail`
-Several data can be displayed:
-* %1: last scalar result from each instruction.
-* %2: all dice results
-* %3: last scalar result from the last instruction.
+It offers a quick answer but sometimes you need to see the rolled values.
+DiceParser can replace some special tags in order to see values, computation result and whatever.
+
+### Shortcuts
+
+There are 3 shortcut tags.
+
+* `%1`: last scalar result from each instruction.
+* `%2`: all dice results.
+* `%3`: last scalar result from the last instruction.
The default output is `%1 details[%2]`.
So, it shows the last scalar result of each instruction and dice result.
-%1 and %3 are equivalent when there is only one instruction (no \;).
+`%1` and `%3` are equivalent when there is only one instruction (no \;).
+They are really useful but if you have many instructions that can become a bit messy.
-#### Specific value from instrustion
+### Final result
It is also possible to set reference to the scalar result of specific instruction.
- To reference the first instruction: `$1`
@@ -434,8 +482,7 @@ It is also possible to set reference to the scalar result of specific instructio
etc…
The number of instruction is not limited.
-
-#### Examples:
+#### Let see some examples:
> 8d10;$1c[>6];$1c1;$2-$3
@@ -451,40 +498,20 @@ or
In this example, the critical fail happens when there are more fails than success.
-
-
In the next example, the critical fail happens when there was no success and a least one fail.
> 8d10;$1c[>6];$1c1;$2-$3;$4i:[=0]{"Fail $4 [%2]"}{$4i:[>0]{"$2 Success[%2]"}{$2i:[=0]{"Critical Fail $4 [%2]"}{"Fail $4 [%2]"}}}
+### Dice Result
-### Group
-
-Group dices, then count the number of group (7th sea system).
-
-#### Example
-
-> 3d20g10
+DiceParser provides tags to display dice result (and each rolled values from a specific instruction).
-This will roll 3 dices and then try to group them to make groups of 10. If you get `9 9 2`, you can only create one group whose value is more or equal to ten (`{9,2}`, the second `9` being "wasted").
+To show dice values from a specific instrustion, just add `@` followed by the instruction's number (e.g: `@1`)
-The `g` operator is allowed to re-order dices to create groups. When rolling `4d20g10`, if you get `7 4 3 6`, the result will be `2` (`{7,3}` and `{6,4}`).
+> `2d6;3d8;"Result $2 - d8:[@2] - d6:[@1]"`
-
-### Comment (\#)
-
-> 2D6 # Sword attack
-
-Display "Sword attack" and the result of the two dice.
-DiceParser ignore everything after the \#. The whole part is treated as one comment.
-So DiceParser can answer question:
-
-> 1L[yes,no] # Am I evil ?
-
-```
-Am I evil ?
-yes
-```
+The output:
+`Result 15 - d8:[7,4,4] - d6:[3,6]`
## Arithmetic