d20tek-dicenotation 5.1.2

Introduction

d20Tek.DiceNotation

DiceNotation library written to provide dice notation parsing, evaluation, and rolling. This library is built on .NET 9, so you can incorporate it into any of your .NET Core and beyond projects.

Dice notation (also known as dice algebra, common dice notation, RPG dice notation, and several other titles) is a system to represent different combinations of dice in role-playing games using simple algebra-like notation such as 2d6+12.

The specification for the dice notation supported in the current version on the library is located here. There are also examples of dice notation strings.

To build the source code, please read Building Code page.

Installation

This library is a NuGet package so it is easy to add to your project. To install these packages into your solution, you can use the Package Manager. In PM, please use the following commands:

PM > Install-Package d20tek-dicenotation -Version 5.1.1

To install in the Visual Studio UI, go to the Tools menu > "Manage NuGet Packages". Then search for d20Tek.dicenotation and install it from there.

Read more about this release in our Release Notes.

Usage

d20Tek.DiceNotation has a couple of different modes that it can be used in depending on how you want to build up the dice expression:

Programmatically:

You can build up the dice to roll by coding the various parts that make up a dice expression. The expression can be build by chaining together operations (as a Fluent API style).

IDice dice = new Dice();

// equivalent of dice expression: 4d6k3 + d8 + 5
var expression = DiceExpression.Create().AddDice(6, 4, choose: 3)
										.AddDice(8)
										.AddConstant(5);
DiceResult result = dice.Roll(expression, new RandomDieRoller());
Console.WriteLine("Roll result = " + result.Value);

Dice Notation String:

You can also create the dice expression by parsing a string that follows the defined Dice Notation language. When you parse the text, we create a similar expression tree as the programmatic version that is then evaluated.

IDice dice = new Dice();
DiceResult result = dice.Roll("d20+4", new RandomDieRoller());
Console.WriteLine("Roll result = " + result.Value);

Dice Rollers:

Both of the usage options above use the RandomDieRoller, which uses the .NET Random class to produce the random dice rolls. There are additional die rollers:

• ConstantDieRoller - lets you create a roller that always returns the same value. This roller is great for testing features and expressions because the results will be consistent in your unit tests.
• CryptoDieRoller - uses Cryptography API to create a more random number generator.
• MathNetDieRoller - provides various strategies for random number generators to produce our die rolls.

Finally, the library defines a IDieRoller interface that you can use to build your own custom die rollers. If the random number generators in our libraries don't suffice, you can override it with your own rolling implementation.

Samples:

For more detailed examples on how to use this DiceNotation library, please review the following samples:

• Sample - DiceCli
• Sample - DiceRoller Windows 10
• Sample - DiceRoller ASP.NET MVC

Feedback

If you use this library and have any feedback, bugs, or suggestions, please file them in the Bugs section of this repository.

I have plans for better notation support, so there will be updates coming for this project. Your feedback would be appreciated.