From 5c7dede4cd289b80f6e2af877ee1621d91e968d7 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Tue, 6 Nov 2018 13:54:14 +0100 Subject: Update README.md improve readme --- README.md | 91 +++++++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 54 insertions(+), 37 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 510a37d..4f49bd6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,60 @@ # DiceParser -Rolisteam Dice Parser +Rolisteam Dice Parser run dice commands. It is available on several platforms. +The syntax is simple and powerful. + +[Full documentation here](https://github.com/Rolisteam/DiceParser/blob/master/HelpMe.md) + + +## [Invite to Your Discord Server](https://discordapp.com/oauth2/authorize?&client_id=279722369260453888&scope=bot&permissions=0) + +[![Discord Bots](https://discordbots.org/api/widget/279722369260453888.svg)](https://discordbots.org/bot/279722369260453888) + + +## Features + +* `99.9%` uptime +* Roll any kind of dice +* Customizable prefix +* Custom alias/macro to improve game experience +* Manage colorized dice +* Many operators + +## Examples: + +### 3D100 +Roll 3 dice with 100 faces + +### 10D10e[=10]s +Roll 10 dice with 10 faces, 10 explodes, and sort the result. + +### 100291D66666666s +roll 100291 dice with 66666666666 faces and sort result + +### 15D10c[>7] +roll 15 dice with 10 faces and it counts number of dice which are above 7 + +### 1D8+2D6+7 +roll 1 die with 8 faces and add the result to 2 dice with 6 faces and add 7. + +### D25 +roll 1 die with 25 faces + +### 88-1D20 +88 minus the value of 1 die of 20 faces + +### 8+8+8 +compute: 24 + + + +### 100/28*3 +compute: 100/28 = 3 +3*3 = 9 + + +More examples at : https://github.com/Rolisteam/DiceParser/blob/master/HelpMe.md ## Grammar The grammar is something like this: @@ -50,39 +103,3 @@ Parenthese =: (expression) Count =: c Validator ``` - -## Example: - - -### 3D100 -Roll 3 dice with 100 faces - -### 10D10e[=10]s -Roll 10 dice with 10 faces, 10 explodes, and sort the result. - -### 100291D66666666s -roll 100291 dice with 66666666666 faces and sort result - -### 15D10c[>7] -roll 15 dice with 10 faces and it counts number of dice which are above 7 - -### 1D8+2D6+7 -roll 1 die with 8 faces and add the result to 2 dice with 6 faces and add 7. - -### D25 -roll 1 die with 25 faces - -### 88-1D20 -88 minus the value of 1 die of 20 faces - -### 8+8+8 -compute: 24 - - - -### 100/28*3 -compute: 100/28 = 3 -3*3 = 9 - - -More examples at : https://github.com/Rolisteam/DiceParser/blob/master/HelpMe.md -- cgit v1.2.3-70-g09d2 From 00945681bdf2cde54e08715e7385dc567903a979 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Tue, 6 Nov 2018 13:55:44 +0100 Subject: add logo add logo --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4f49bd6..bad8c40 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ - -[![Build Status](http://www.rolisteam.org/sites/default/files/pixture_reloaded_logo.png)](http://www.rolisteam.org) +[![Logo](https://raw.githubusercontent.com/Rolisteam/rolisteam/master/resources/logo/1000-rolisteam.png)](http://www.rolisteam.org) # DiceParser -- cgit v1.2.3-70-g09d2