Features

• ANTLR-based parser generates objects from dice notation (BNF grammar included)

• Easy-to-use model, just call the ‘roll’ method

• Classes to support plain dice

Documentation

Documentation sources are included with the project, and used to generate the documentation sites:

• The latest docs are always generated for the latest release, kept in the ‘master’ branch

• The development docs are generated from the latest code in the ‘develop’ branch

The source files for the docs, a small Sphinx project, are kept in the ‘docs folder.

These can be built if needed:

python setup.py build_docs

Usage

The application has been coded in Python, and does not require any particular framework.

To use it just import the parser:

from dice_notation.parser import DiceParser

And then use it to parse a dice notation expression:

parser = DiceParser()
dice = parser.parse('1d6+2')

The result can be accessed just by calling the ‘value’ method as many times as needed, which will generate a new random value each time it is called:

print(dice.roll())
print(dice.roll())

Testing

The tests included with the project can be run with:

python setup.py test

This will delegate the execution to tox.

It is possible to run just one of the test profiles, in this case the py36 profile:

python setup.py test -p "py38"

Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

• Reporting errors and asking for extensions through the issues management

• or forking the repository and extending the project

License

The project has been released under the MIT License.