Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
olinox14 committed Sep 21, 2017
1 parent 6c981bc commit 0cc5ca1
Show file tree
Hide file tree
Showing 35 changed files with 14,995 additions and 25 deletions.
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7bbf894653e3da1328d24cac321745e4
tags: 645f666f9bcd5a90fca523b33c5a78b7
73 changes: 73 additions & 0 deletions docs/_build/html/_sources/index.md.txt
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

Binary file added docs/_build/html/_static/ajax-loader.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0cc5ca1

Please sign in to comment.