From 4a7464869dd03af50448e3e29448a91f97b669d9 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Mon, 13 Nov 2017 10:37:28 +0100 Subject: Update HelpMe.md add toc --- HelpMe.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index d2570e0..c086074 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -1,4 +1,19 @@ [![Logo](https://raw.githubusercontent.com/Rolisteam/rolisteam/master/resources/logo/1000-rolisteam.png)](http://www.rolisteam.org) + +**Table of Contents** + +* [DiceParser](#diceparser--what-is-it-) +* [Platforms](#roll-dice-on-each-platform) +* [Limitations](#known-limitations) +* [Roll a die](#how-to-roll-a-die) +* [List of operator](#list-of-operator) +* [Arithmetic](#arithmetic) +* [Arithmetic and Dice](#arithmetic-and-dice) +* [Validator](#validator) +* [Value from set](#select-value-from-list) +* [Miscellaneous examples](#examples) +* [Best Practices](#best-practices) + # Documentation: ## DiceParser : What is it ? @@ -78,6 +93,7 @@ Thanks of several operations and options, you can tune a bit your rolling comman * m : Merge * i : if * g : Group +* \# : Comment ### Keep @@ -217,6 +233,21 @@ If you plan to use if operator to display text message. You must surround text w Roll 5 dice and then try to group them to make group of 10 [7th sea system]. +# 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 ? + +``` +What the answer is ? +yes +``` + ## example: > 1d6i[<4]{3} @@ -358,6 +389,15 @@ The L operator (meaning list) can offer you the opportunity to pick up value fro > 1L[sword,bow,knife,gun,shotgun] +With comment + +> 1L[yes,no] # Am I evil ? + +``` +What the answer is ? +yes +``` + ## Examples > 3D100 -- cgit v1.2.3-70-g09d2 From 96dd9952245829434068b707e2da0a758e1fabaf Mon Sep 17 00:00:00 2001 From: Renaud G Date: Fri, 17 Nov 2017 18:30:41 +0100 Subject: Update HelpMe.md Add link to discord --- HelpMe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index c086074..2fa7c39 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -33,7 +33,7 @@ Please, remember it is important to prefix all you command by `!`. This will all | platform | start character(s) | more information | |---|---|--- | | Rolisteam |```!```| [Documentation](http://wiki.rolisteam.org/index.php/En:Dice) | -| Discord |```!```| | +| Discord |```!```| To install DiceParser on your server [http://www.rolisteam.org/discord.html](http://www.rolisteam.org/discord.html) | | 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 | -- cgit v1.2.3-70-g09d2 From f55e6faa30624e76e2d82f8461cf3d8beb9e8168 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Tue, 21 Nov 2017 10:10:07 +0100 Subject: Update HelpMe.md fix display about validator type. --- HelpMe.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 2fa7c39..51cdac7 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -346,9 +346,10 @@ or ## Validator There are three kind of Validator: --Scalar --Range --Boolean expression + +* Scalar +* Range +* Boolean expression Any operator which requires validator (such as `a,r,e,c`) can use those three kind. -- cgit v1.2.3-70-g09d2 From 3692fd4eaa66c413e2e69514cb93ef1c4173346b Mon Sep 17 00:00:00 2001 From: Renaud G Date: Tue, 21 Nov 2017 14:34:46 +0100 Subject: Update HelpMe.md fix question --- HelpMe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 51cdac7..7266e38 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -244,7 +244,7 @@ So DiceParser can answer question: > 1L[yes,no] # Am I evil ? ``` -What the answer is ? +Am I evil ? yes ``` -- cgit v1.2.3-70-g09d2 From ddf524d6f0de517551d21e73b81abdf724a9ca35 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Tue, 21 Nov 2017 14:39:40 +0100 Subject: Update HelpMe.md update contact zone --- HelpMe.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'HelpMe.md') diff --git a/HelpMe.md b/HelpMe.md index 7266e38..0e46ec3 100644 --- a/HelpMe.md +++ b/HelpMe.md @@ -24,7 +24,6 @@ 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 @@ -53,6 +52,12 @@ Please, remember it is important to prefix all you command by `!`. This will all We can't set some aliases for any platform but It has to be labelled with game's name. +## Bug report and new features + +Please fulfill a ticket in our [Bug tracker](https://github.com/Rolisteam/DiceParser/issues) system. +Or contact us on [discord](https://discordapp.com/invite/MrMrQwX) or any [other ways](http://www.rolisteam.org/contact.html) + + ## How to roll a die It is real simple. you have to call: -- cgit v1.2.3-70-g09d2