-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
74 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
**xdice** | ||
|
||
*xdice* is a lightweight python library for managing dice, scores, and dice-notation patterns. | ||
|
||
It allows to easily interpret literal expressions as rolls of dice ('1d6', '3d4+3', '12d6+1d4'...etc.), then manipulate the results. | ||
|
||
#### Python Versions | ||
|
||
DiceRollParser has been tested with python 3.3+ | ||
|
||
#### Examples: | ||
|
||
import dice | ||
|
||
## Roll simple dices with **rolldice()** | ||
|
||
score = rolldice(6, amount=2) | ||
|
||
# manipulates score as an integer | ||
|
||
print( score, score * 2, score == 11 ) | ||
>> 11 22 True | ||
|
||
|
||
# Iterates over the results | ||
|
||
for result in score: | ||
print(result) | ||
>> 5 | ||
>> 6 | ||
|
||
# Parse patterns with **roll()** | ||
|
||
ps = roll("2d6+18") | ||
|
||
print( ps, ps.format() ) | ||
>> 28 '[5,6]+18' | ||
|
||
|
||
#### CLI | ||
|
||
Run `python roll.py [options] <expr>` | ||
|
||
Usage: | ||
roll [options] <expr> | ||
|
||
Options: | ||
-s Numeric score only | ||
|
||
-h --help Displays help message | ||
--version Displays current xdice version | ||
|
||
|
||
#### CONTRIBUTION | ||
|
||
Any opinion / contribution is welcome, please contact us. | ||
|
||
#### TO INSTALL | ||
|
||
pip install xdice | ||
|
||
#### License | ||
|
||
*xdice* is under GNU License | ||
|
||
#### Author | ||
|
||
Olivier Massot, 2017, with *Cro-ki Lab* | ||
|
||
#### Tags | ||
|
||
dice roll d20 game random parser dices role board | ||
|
This file was deleted.
Oops, something went wrong.