Feature: Dice Roller

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.92.0

DiceRollerVid.gif

Dice Roller

At the bottom of most pages, there will be this icon RollerButton.png. When it is clicked (as the animation shows) it will open a small window which can be used to either roll, or return the results of actions triggered by clicking other elements of the site. (usually triggered by a link on the page that most often look like 2d10 this. (There are some instructions on how to do this within the JSON data in the Renderer Demo should you want to enable this for your own documents - see Homebrew.


Instructions (How to use it)

The roller uses the common format for dice rolling (that being <a>d<X> where <a> is the number of dice rolled <X> number of times. The results of the roll(s) is(are) presented to the roller window with separate entries and then the sum of the rolls are calculated as well.


Commands
<text>: <formula>
Anything before a colon is treated as a label (ie Fireball: 4d6) will result in
fireball: # ([die_result1]+[die_result2]+[die_result3]+[die_result4])
<a>d<X>
Where <a> = number of time to roll and <X> is the number of sides of the die(ce)
or more accurately -- generate a random number between 1 and <X>; <a> number of times.
(ie 3d6 rolls a 6 sided die 3 times; a d20 will return a single resulting random number between 1 and 20
Optional Parameters
dh<x>
Drop highest; The results will drop the highest results <x> number of times
eg. 8d6dh2 would return 8 roll results which removes the 2 highest rolls.
dl<x>
Drop lowest; The results will drop the lowest results <x> number of times
eg. 8d6dl2 would return 8 roll results which removes the 2 lowest rolls.
/macro <option> <name> <roll_formula>
Optional Parameters
/macro add <name> <roll_formula>
Creates (or updates) a macro designated with <name> parameter, to be equal to <roll_forumula>
eg. /macro add Sneak_attack 2d20+2+2
/macro list
Lists the current macros
/help
returns the following
Drop highest (2d4dh1) and lowest (4d6dl1) are supported.
Up and down arrow keys cycle input history.
Anything before a colon is treated as a label (Fireball: 8d6)
Use /macro list to list saved macros.
Use /macro add myName 1d2+3 to add (or update) a macro. Macro names should not contain spaces or hashes.
Use /macro remove myName to remove a macro.
Use #myName to roll a macro.
Use /clear to clear the roller.



framless

Controls

⬆️ and ⬇️ scroll up and down the roller's window's contents



Feature Support


Known Issues/Limitations

Looks like its perfect... (Did we miss anything?)


NAME OF THE ISSUE
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Work Around  : Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


FAQ

Nothing's here (Do you have any suggestions?)
Best Practices

None as yet (Do you have any suggestions?)



Related Features



Did that answer your question(s)?

If not please check the under section Feature Support Known Isseus/Limitations or visit the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.