dart_dice_parser 1.2.0

A dart library for parsing dice notation (like "2d6+4", "3d6", or "3d10 + 2d6 - 5d4")

dart_dice_parser

A library for parsing dice notation

Supported syntax

Supported notation:

• AdX -- roll A dice of X sides, total will be returned as value

• special dice variations:

  • AdF -- roll A fudge dice (sides: [-1, -1, 0, 0, 1, 1])
  • Ad% -- roll A percentile dice (equivalent to 1d100)
  • AD66 -- roll A D66, aka 1d6*10 + 1d6 (NOTE: this must use uppercase D, lowercase d will be interpreted as 66-sided die)

• dropping high/low:

  • AdX-HN -- roll A X-sided dice, drop N highest
  • AdX-LN -- roll A X-sided dice, drop N lowest
  • NOTE: the '-H' and '-L' operators have higher precedence than the arithmetic operators, so 4d10-L2+2 is equivalent to (4d10-L2)+2

• addition/subtraction/multiplication and parenthesis are allowed

• numbers must be integers, and division is is not supported.

examples:

• 2d6 + 1 -- roll two six-sided dice, sum results and add one
• 2d(2*10) + 3d100 -- roll 2 twenty-sided dice, sum results, add that to sum of 3 100-sided die
• 1D66 -- roll a D66 -- aka two six-sided dice, multiply first by 10 and sum results
• 1d% -- roll one percentile dice
• 4dF -- roll four fudge dice
• 2d20-H -- roll 2d20, drop highest (disadvantage)
• 2d20-L -- roll 2d20, drop lowest (advantage)
• 10d10-L3 -- roll 10d10, drop 3 lowest results
• (2d10+3d20)-L3 -- roll 2d10 and 3d20, combine the two results lists and drop lowest 3 rolls

TODO:

• exploding dice
  • for this to work, need to pass along info about dice up to parser (to know which is max#)... or, could do 3d10!=10 (explode if equal 10)
• drop conditionally
  • 3d10-<3 drop any less than 3
  • 3d10->3 drop any greater than 3
  • 3d10-=3 drop any equal 3
• cap/clamp
  • 3d10C<3 treat any value less than 3 as 3
  • 3d10C>3 treat any value greater than 3 as 3
• count
  • 3d10# -- count how many have maximum
  • 3d10#>6 -- count how many are greater than 6
  • 3d10#=7 -- count how many are equal to 7
  • 3d10#<3 -- count how many are less than 3

Usage

A simple usage example:

    import 'package:dart_dice_parser/dart_dice_parser.dart';

    main() {
      var diceExpression = "2d6 + 1 + 3d10";

      print("$diceExpression : ${DiceParser().roll(diceExpression)}");
    }

Features and bugs

Please file feature requests and bugs at the issue tracker.