This can be used to easily search for specific dice, look for the left-most operand, expr ] >, ] >, ] > ] operations = > op =+ right = ] > ] operations = > op =+ right => comment = None >įrom here, Expression.children returns a tree of nodes representing the expression from left to right, each of which

The raw results of dice rolls are returned in Expression Note that while allow_comments is enabled, AST caching is disabled, which may lead to slightly worse performance. Annotations are purely visual and do not affect the evaluation of the roll by default.Īdditionally, when allow_comments=True is passed to roll(), the result of the roll may have a comment: > from d20 import roll > result = roll ( '1d20 I rolled a d20', allow_comments = True ) > str ( result ) '1d20 (13) = `13`' > result. roll ( '4d6e6kh3', stringifier = MyStringifier ()) > str ( result ) 'The result of the roll 4d6e6kh3 (X, 5, 6!, 6!, X, X) was 17' Annotations and CommentsĮach dice node supports value annotations - i.e., a method to 'tag' parts of a roll with some indicator. return f 'The result of the roll ' > result = d20. Then, simply pass an instance of your stringifier into the roll() function! > import d20 > class MyStringifier ( d20. (or d20.SimpleStringifier as a starting point), and implement the _str_* methods to customize how your dice tree is stringified. To change this behaviour, you can create a subclass of d20.Stringifier total 3 > str ( r ) '(1d4 (2) + 1, ~~3~~, ~~2d6kl1 (2, 5)~~)kh1 = `3`' Custom Stringifierīy default, d20 stringifies the result of each dice roll formatted in Markdown, which may not be useful in your application. total 9 > str ( r ) '2d6ro> r = roll ( '8d6mi2' ) # roll 8d6s, with each die having a minimum roll of 2 > r. X > from d20 import roll > r = roll ( '4d6kh3' ) # highest 3 of 4 6-sided dice > r.

SyntaxĪll values in this set that are literally this value. Selectors select from the remaining kept values in a set. Rolls another die for each matched value. Rerolls up to one matched value once, keeping the original roll. Rerolls all matched values until none match. Operators are always followed by a selector, and operate on the items in the set that match the selector. These operations can be performed on dice and sets. Note that (3d6) is equivalent to 3d6, but (3d6,) is the set containing the one element 3d6. These are the atoms used at the base of the syntax tree.

This is the grammar supported by the dice parser, roughly ordered in how tightly the grammar binds. ast ) '1d20 + 5' DocumentationĬheck out the docs on Read the Docs! Dice Syntax

Tree-based dice representation for easy traversal.

Built-in execution limits against malicious dice expressions.

Highly extensible API for custom behaviour and dice stringification.

Optimized for speed and memory efficiency.

A fast, powerful, and extensible dice engine for D&D, d20 systems, and any other system that needs dice! Key Features

Dieroll d20