timothymtorres / rl-dice

A module to be used with conventional Roguelike dice.

RL-Dice

A robust module to roll and manipulate roguelike dice. This has also been included in rotLove roguelike toolkit which I highly recommend if you plan on making a roguelike.

This library is compatible with:

• Lua 5.1
• Lua 5.2
• Luajit 2.0
• Luajit 2.1
• Love2D

Consult the online documentation for the API and usage examples.

The dice module provides the following:

• Dice notation strings - used to create or roll dice instances
• Dice number/faces - can be increased or decreased
• Dice bonus - can be increased or decreased
• Dice rerolls - can reroll and filter out via highest or lowest results
• Dice sets - can return multiple results
• Dice pluralism - enable bonus or rerolls to individual dice or to all dice
• Dice caching - reuses dice tables for faster performance

Unit Testing

A LuaUnit test is setup in the tests folder. There are 15 different tests that check that the metamethods, new instances, dice cache, and notation are all functioning. To run these tests simply navigate to the test folder on your shell, and execute the command lua dice_test.lua -v to see the results.