Skip to main content

A library for parsing and evaluating dice notation

Project description

Latest PyPI version Travis-CI build status

A library and command line tool for parsing and evaluating dice notation.

Usage

From the command line:

roll 3d6

From python:

import dice
dice.roll('3d6')

Notation

The expression works like a simple equation parser with some extra operators.

The following operators are listed in order of precedence.

The dice (‘d’) operator takes an amount (A) and a number of sides (S), and returns a list of A random numbers between 1 and S. For example: 4d6 may return [6, 3, 2, 4].

If A is not specified, it is assumed you want to roll a single die. d6 is equivalent to 1d6.

Basic integer operations are available: 16 / 8 * 4 + 2 - 1 -> 9.

A set of rolls can be turned into an integer with the total (t) operator. 6d1t will return 6 instead of [1, 1, 1, 1, 1, 1]. Applying integer operations to a list of rolls will total them automatically.

A set of dice rolls can be sorted with the sort (s) operator. 4d6s will not change the return value, but the dice will be sorted from lowest to highest.

The lowest or highest rolls can be selected with ^ and v. 6d6^3 will keep the highest 3 rolls, whereas 6d6v3 will select the lowest 3 rolls.

Licence

The MIT License (MIT)

Copyright (c) 2013 Sam Clements

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dice-1.0.2.tar.gz (7.5 kB view details)

Uploaded Source

Built Distributions

dice-1.0.2-py2.py3-none-any.whl (12.4 kB view details)

Uploaded Python 2 Python 3

dice-1.0.2-py2-none-any.whl (12.4 kB view details)

Uploaded Python 2

File details

Details for the file dice-1.0.2.tar.gz.

File metadata

  • Download URL: dice-1.0.2.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dice-1.0.2.tar.gz
Algorithm Hash digest
SHA256 743fc1105f93a3bf09b0dadbe6b4cae9947cabff65c616da0ff3516eb7f0b18f
MD5 bb176fddad0a9acb9e77180cda2f190a
BLAKE2b-256 b01e413619b187cc59cfbce72ccdb3d5d2b796b9724897e6bc9cb6ad5eb36bec

See more details on using hashes here.

File details

Details for the file dice-1.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for dice-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d1c2a912fa5c6a7b30f58e4a23e3cd01b19affce3a11919011ee3b29ca4cef73
MD5 0a199136156875ca43aac2d066169fbf
BLAKE2b-256 bae7acc4a1ba88719712f11520ee7f956dd592c5294da38d2dfc86cfc5d1ba16

See more details on using hashes here.

File details

Details for the file dice-1.0.2-py2-none-any.whl.

File metadata

File hashes

Hashes for dice-1.0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 6c64fc853cd4f612c4e9b423ea8f4fbd43740890633f0239e2ed251f68b676e4
MD5 204170c25db5d6e793cbddcd1cce63d6
BLAKE2b-256 26c6b1700897eb0633abfd30b178818b0d252f20b4138a3d2b894565b5046b0d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page