diceroll Tutorial

_images/dice_tut.png

Rolling the Dice

Once diceroll.py is installed and your code is able to import the module, its roll() function can be used right away. This function returns an integer, by the way. So it can be used as any other integer would be used. But first, we must give this function a value to work from.

roll(dice)
dice = a string of three ordered concatenated values:

number_of_dice + dice_type + dice_roll_modifier

As examples:
dice = ‘2’ + ‘D10’ + ‘-2’
dice = str(3) + ‘D6’ + ‘+2’
dice = ‘FLUX’

dice_roll_modifier must include a ‘+’ or ‘-‘ with its value.

Note that both number_of_dice and dice_roll_modifier are optional, and may
not even be used by some dice_type rolls.

Those of you that have used dice rolling programs before will notice that something is different. And that is, roll() uses a string for its input:

>>> die1 = roll('1D6')
>>> die2 = roll('1d6')
>>> dice = '3D4+1'
>>> print die1, die2+4, roll(dice)
3, 6, 9

The return values from roll() are always integer.

New in version 2.2

Notice that the inputted string values can be upper or lower case.

The dice types to roll are:

D3, D4, D6, D8, D10, D12, D20, D30, D100, D66, DD, FLUX, GOODFLUX, and BADFLUX

New in version 2.3

Three additional dice types are now available:

BOON, BANE, and D2

Note

You may recognize some of these dice types from various tabletop role-playing games. Not all dice types are covered by diceroll. However, more are planned for in future releases.

diceroll uses a simple standard when it comes to rolling various dice types.

Some examples are:

roll('D6') or roll('1D6') # roll one 6-sided die
roll('2D6') # roll two 6-sided dice
roll('D09') # roll a 10-sided die (0 - 9)
roll('D10') # roll a 10-sided die (1 - 10)
roll('D099') # roll a 100-sided die (0 - 99)
roll('D100') # roll a 100-sided die (1 - 100)
roll('D66') # roll for a D66 chart
roll('FLUX') # a FLUX roll (-5 to 5)
roll('3D6+6') # add +6 DM to roll
roll('4D4-4') # add -4 DM to roll
roll('2DD+3') # roll (2D6+3) x 10
roll('BOON') # roll 3D6 and keep the higher two dice
roll('4dF') # make a FATE roll

Deprecated in version 1.9.

D00 has been replaced with D100.

New in version 2.4

diceroll can now be used directly at a CMD prompt:

C:\>diceroll.py roll('2d6-2')

Your 2D6-2 roll is 10.

C:\>diceroll.py 2d6-2

Your 2D6-2 roll is 7.

Note

Typing diceroll.py -h will provide some help.

New in release 2.4.1

A TEST roll that calculates percentages for 2D6 has been added:

>>> roll('test')
      6x6 Roll Chart Test
     1    2    3    4    5    6
1  262  296  250  292  292  241
2  270  315  299  236  279  261
3  295  274  288  274  291  295
4  273  284  279  276  249  273
5  293  280  291  276  280  283
6  270  276  282  272  273  280
            6x6 Roll Chart Percentage
        1       2       3       4       5       6
1   2.62%   5.66%   8.60%  11.38%  13.93%  16.23%
2   5.66%   8.60%  11.38%  13.93%  16.23%  13.95%
3   8.60%  11.38%  13.93%  16.23%  13.95%  11.02%
4  11.38%  13.93%  16.23%  13.95%  11.02%   8.25%
5  13.93%  16.23%  13.95%  11.02%   8.25%   5.56%
6  16.23%  13.95%  11.02%   8.25%   5.56%   2.80%

The roll will return a list of percentages for 2-12 rolled.

New in release 2.4.2

D09 rolls will generate a range of 0 - 9.

New in release 2.4.3

D99 rolls will generate a range of 0 - 99.

Fixed in release 2.4.7

Minor fixes with input spacing, and logging any negative dice rolled.

New in version 3.0

D2 rolls now generate a range of 0 - 1. The 4dF roll type for FATE has been added.