aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/HelpMe.md
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2020-03-21 00:15:54 +0100
committerRenaud G <renaud@rolisteam.org>2020-03-28 02:05:05 +0100
commita50fb80de0c1890fe03bccd239a827a8ccb67f68 (patch)
tree7534a1abe41044f837ee7028ee90b37f64f74f97 /HelpMe.md
parent352bc1dbe6510e24e70f504cb298883b42cce3b2 (diff)
downloadOneRoll-a50fb80de0c1890fe03bccd239a827a8ccb67f68.tar.gz
OneRoll-a50fb80de0c1890fe03bccd239a827a8ccb67f68.zip
update documentation.
Diffstat (limited to 'HelpMe.md')
-rw-r--r--HelpMe.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/HelpMe.md b/HelpMe.md
index dfe68af..35f3899 100644
--- a/HelpMe.md
+++ b/HelpMe.md
@@ -25,6 +25,7 @@
* [All The same](#allsame)
* [Value list](#Value-list)
* [Comment (\#)](#comment-)
+* [Functions](#Functions)
* [Managing the output](#the-output)
* [Shortcuts](#shortcuts)
* [Final Result](#final-result)
@@ -443,6 +444,26 @@ Am I evil ?
yes
```
+## Functions
+
+DiceParser provides function to deal with instructions.
+Some functions will come soon (e.g: max, min). It will allows to manage several commands at once.
+
+### Repeat
+
+> repeat(1d10,5)
+
+Output:
+```
+2 - Details [2]
+8 - Details [8]
+3 - Details [3]
+1 - Details [1]
+10 - Details [10]
+```
+
+Attention! Be careful, `repeat` works badly with multiple instruction commands
+
## The output
DiceParser provides features to let you control the command output.
@@ -612,9 +633,11 @@ This command means: roll 4 dice and they explode on 10.
### Range
-The range is defined as two bounds. You have to use square brackets and the two bounds are separated by `-`.
+The range is defined as two bounds. You have to use square brackets and the two bounds are separated by `..`.
+
+> 4d10c[8..10]
-> 4d10c[8-10]
+> 1d[-1..8]
### Boolean Condition
@@ -865,5 +888,5 @@ All lines must be part of the same messages, so prepare it first.
# Bug report and new features
-Please fulfill a ticket in our [Bug tracker](https://github.com/Rolisteam/DiceParser/issues) system.
+Please fulfill a ticket in our [Bug tracker](https://invent.kde.org/kde/rolisteam-diceparser/issues/new) system.
Or contact us on [discord](https://discordapp.com/invite/MrMrQwX) or any [other ways](http://www.rolisteam.org/contact.html)