From 7f609ac6c679186e15c6a35c2c99fcb0327a1af7 Mon Sep 17 00:00:00 2001 From: obiwankennedy Date: Tue, 14 Jan 2014 19:04:11 +0100 Subject: Update README.md Adding examples --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1e8dc4..7fd7c84 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ -DiceParser -========== + +[![Build Status](http://www.rolisteam.org/sites/default/files/pixture_reloaded_logo.png)](http://www.rolisteam.org) + +# DiceParser + + Rolisteam Dice Parser +## Grammar The grammar is something like this: Command =: Expression @@ -18,3 +23,38 @@ ScalarOperator =: [x,-,*,x,/] number =: [0-9]+ Validator =: number | [operator number] | [ number - number ] + + +## Example: + + +### 3D100 +Roll 3 dice with 100 faces + +### 10D10e[=10]s +Roll 10 dice with 10 faces, 10 exploses, 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 + -- cgit v1.2.3-70-g09d2