Metadata-Version: 2.1
Name: jarniadice
Version: 0.1.3
Summary: A library for parsing and evaluating Jarnia Dice Notation
Home-page: https://github.com/jaderebrasil/python-roller
License: MIT
Keywords: dice,game,rpg,roller,jarnia
Author: Jader Brasil
Author-email: jaderbrasil@protonmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)
Classifier: Topic :: Games/Entertainment :: Role-Playing
Classifier: Topic :: Games/Entertainment :: Turn Based Strategy
Classifier: Topic :: Utilities
Requires-Dist: numpy (>=1.23.1,<2.0.0)
Project-URL: Repository, https://github.com/jaderebrasil/python-roller
Description-Content-Type: text/x-rst

===========
Jarnia Dice
===========
A library for parsing and evaluating Jarnia Dice Notation.

In the future, we aim to have all the features of standard Dice Notation,
but also more.

The current stage of development is pre-alpha, and I'm running
this library only on a private telegram bot and implementing
the features as I need.

Documentation (Draft)
=====================
Run three d6 and return the **sum**::

    $ python -m jarniadice '3d6'

Run two d10 and return the value of the **higher**::

    $ python -m jarniadice '2d10kh'

Run two d10 and return the value of the **lower**::

    $ python -m jarniadice '2d10kl'

Run two d10 and return **all** the values as a 
`numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>`_::

   $ python -m jarniadice '2d10kl'
