From 9fb08a03b5630952cc07dfaeaca4f4958f76c8b7 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Wed, 25 Oct 2017 15:33:42 +0200 Subject: Update HelpMe.md make documentation clearer --- HelpMe.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 4db864e..3c16e8d 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -183,9 +183,9 @@ There are 3 different methods. * **One Of Them** : at least one die must fit the condition to trigger the true instruction. If no dices fit the condition the false instruction is run. * **On Scalar** : the condition is evaluated on the scalar result of the dice roll. -To switch the operator to act in **All Of Them** method you must add **\*** character as compare method position. -To switch the operator to act in **One Of Them** method you must add **.** character as compare method position. -To switch the operator to act in **On Scalar** method you must add **:** character as compare method position. +To switch the operator to act in **All Of Them** method you must add ```*``` character as compare method position. +To switch the operator to act in **One Of Them** method you must add ```.``` character as compare method position. +To switch the operator to act in **On Scalar** method you must add ```:``` character as compare method position. ## example: -- cgit v1.2.3-70-g09d2 From 1ba9e7b6d9948a7b1477792eca4016b2e8e346d9 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Wed, 25 Oct 2017 16:21:58 +0200 Subject: Update HelpMe.md more details about if. --- HelpMe.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 3c16e8d..c6ed209 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -187,6 +187,9 @@ To switch the operator to act in **All Of Them** method you must add ```*``` cha To switch the operator to act in **One Of Them** method you must add ```.``` character as compare method position. To switch the operator to act in **On Scalar** method you must add ```:``` character as compare method position. +If you plan to use if operator to display text message. You must surround text with ```"```. Example available below. + + ## example: @@ -206,11 +209,17 @@ if at least one die is equal to 6, then roll another d6 and add it to the result if all dice are equal to 6, then roll another d6 and add it to the result. +> 2d10i:[>15]{"Success"}{"Fail"} + +if the sum of two dice is greater than 15, It displays "Success", override it displays "Fail". + +> 2d10i:[>15]{"Success %1 "}{"Fail %1"} -> 2d10i:[>15]{"Success"} +Same as above, but the final result is displayed beside Success or Fail. -if the sum of two dice is greater than 15, It displays "Success". +> 2d10i:[>15]{"Success %1 [%2]"}{"Fail %1 [%2]"} +Same as above, but the result of each die is displayed inside square brackets. ## Arithmetic -- cgit v1.2.3-70-g09d2 From 6446492416e2ce3912d9d3c8006682883726f6a9 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Thu, 26 Oct 2017 09:59:54 +0200 Subject: Update HelpMe.md Add limitations and differences between diceparser platform. --- HelpMe.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index c6ed209..cb8d297 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -13,10 +13,43 @@ make make install ``` -## Irc and Chat +## DiceParser : What is it ? + +DiceParser is a software component dedicated to roll dice through simple commands. This software component is available on different platform. +Such as: Irc bot, discord bot, included in Rolisteam, web server, on twitter etc. + +Each platform has its own limitations. +Let's take a look about it: + + +### Roll dice on each platform + Please, remember it is important to prefix all you command by `!`. This will allow the system to identify your command. To clarify the documentation, the `!` is not repeated before all commands. +| platform | start character(s) | more information | +|---|---|--- | +| Rolisteam |```!```| [Documentation](http://wiki.rolisteam.org/index.php/En:Dice) | +| Discord |```!```| | +| Twitter | ```#roll``` | Twit any message starting with #roll following by dice command (e.g: ```#roll 2d6```) | +| IrcBot |```!```| | +| webserver | nothing | No public published yet. Has dedicated text field | +| dice | nothing | dice is a command line application to roll dice: ```dice "2d6"``` | + + +### Known Limitations + +| platform | descriptions | +|---|---| +| Rolisteam | no support for comments yet. Rolisteam is a big software. You may not have all the most recent feature from diceparser. | +| Discord | no support for p operator. Color are badly managed by discord so we can't waste time about it. If the command takes too much time. It is cancel | +| Twitter | Result such be short | +| IrcBot | | +| webserver| | +| dice | | + + + ## How to roll a die It is real simple. you have to call: @@ -378,3 +411,5 @@ Old World in darkness system. Exalted 2nd edition system. + + -- cgit v1.2.3-70-g09d2 From 5a7d52ee7121be6e963b15e3d0c013805e1cb0a4 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Thu, 26 Oct 2017 10:16:35 +0200 Subject: Update HelpMe.md about aliases --- HelpMe.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index cb8d297..95a29f7 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -42,13 +42,13 @@ Please, remember it is important to prefix all you command by `!`. This will all | platform | descriptions | |---|---| | Rolisteam | no support for comments yet. Rolisteam is a big software. You may not have all the most recent feature from diceparser. | -| Discord | no support for p operator. Color are badly managed by discord so we can't waste time about it. If the command takes too much time. It is cancel | -| Twitter | Result such be short | -| IrcBot | | -| webserver| | -| dice | | - +| Discord | no support for p operator. Color are badly managed by discord so we can't waste time about it. If the command takes too much time. It is canceled. There is really few aliases. You may ask for new aliases| +| Twitter | Result such be short. No aliases | +| IrcBot | No aliases | +| webserver| No aliases | +| dice | No aliases | +We can't set some aliases for any platform but It has to be labelled with game's name. ## How to roll a die -- cgit v1.2.3-70-g09d2 From be75cdb7fdb3748def522ebd49ed8bb0363955cf Mon Sep 17 00:00:00 2001 From: Renaud G Date: Thu, 26 Oct 2017 13:23:11 +0200 Subject: Update HelpMe.md Adding best practices chapter --- HelpMe.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 95a29f7..6b2dde0 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -411,5 +411,17 @@ Old World in darkness system. Exalted 2nd edition system. +# Best Practices +As DiceParser provides more and more features, you may find several ways to do the same thing. We want here to explain the difference between those several approaches. Then you will be able to use the right one. + +## Roll several kind of dice and sum them + +```Bad``` +> 2d8;2d10m + +```Good``` +> 2d8+2d10 + +The merge operator is useful when you want to use dice operator on all rolled dice. -- cgit v1.2.3-70-g09d2 From d421174d765c472bc74c75c6942e6d4329b45bb3 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Sat, 28 Oct 2017 02:30:07 +0200 Subject: Update HelpMe.md Add group operator. --- HelpMe.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 6b2dde0..c2832a0 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -1,18 +1,6 @@ [![Logo](https://raw.githubusercontent.com/Rolisteam/rolisteam/master/resources/logo/1000-rolisteam.png)](http://www.rolisteam.org) # Documentation: -## Build - -``` -git clone git@github.com:Rolisteam/DiceParser.git -cd DiceParser -mkdir build -cd build -cmake ../ -make -make install -``` - ## DiceParser : What is it ? DiceParser is a software component dedicated to roll dice through simple commands. This software component is available on different platform. @@ -89,6 +77,7 @@ Thanks of several operations and options, you can tune a bit your rolling comman * p : Paint dice * m : Merge * i : if +* g : Group ### Keep @@ -222,7 +211,11 @@ To switch the operator to act in **On Scalar** method you must add ```:``` chara If you plan to use if operator to display text message. You must surround text with ```"```. Example available below. +# Group + +> 5d10g10 +Roll 5 dice and then try to group them to make group of 10 [7th sea system]. ## example: @@ -321,7 +314,7 @@ There are three kind of Validator: -Range -Boolean expression -Any operator which requires validator (such as `a,r,e,c') can use those three kind. +Any operator which requires validator (such as `a,r,e,c`) can use those three kind. ### Scalar -- cgit v1.2.3-70-g09d2 From a543a6ca8ddc2826a4433044ed1a040acbbf36a3 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Sun, 29 Oct 2017 03:30:04 +0100 Subject: Update HelpMe.md add pow --- HelpMe.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index c2832a0..d2570e0 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -297,6 +297,11 @@ Substract 4 to 6 and then roll two dice. Divide by 2 the result of 1 die. +> (2+2)^2 +Result: 16 + +> 1d10^2 + ## Roll two (or more) kinds of dice at once. To make it, you have to separate all dice commands by `;` -- cgit v1.2.3-70-g09d2