aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2017-10-26 09:59:54 +0200
committerGitHub <noreply@github.com>2017-10-26 09:59:54 +0200
commit6446492416e2ce3912d9d3c8006682883726f6a9 (patch)
tree77316b6adfe823136d99651073aa278b87f9c351
parent1ba9e7b6d9948a7b1477792eca4016b2e8e346d9 (diff)
downloadOneRoll-6446492416e2ce3912d9d3c8006682883726f6a9.tar.gz
OneRoll-6446492416e2ce3912d9d3c8006682883726f6a9.zip
Update HelpMe.md
Add limitations and differences between diceparser platform.
-rw-r--r--HelpMe.md37
1 files changed, 36 insertions, 1 deletions
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.
+
+