Ready Set Roll for 5e - FoundryVTT Module

Ready Set Roll is a Foundry VTT module that accelerates the built in rolling system of the Foundry DnD5e system. It allows for quick rolls with advantage, disadadvantage, and other modifiers for skills, items, ability checks, and saving throws. This module is a complete rewrite and modernisation of RedReign's Better Rolls for 5e module, which is no longer supported, and no longer functional as of more recent versions of FoundryVTT.

If you are feeling generous, and would like to support my work, you can do so through this Paypal link, or through the sponsorship options in the sidebar. Thank you!

Installation

Method 1

1. Start up Foundry and click "Install Module" in the "Add-on Modules" tab.
2. Search for "Ready Set Roll" in the pop up window.
3. Click "Install" and the module should download and appear in your modules list.
4. Enjoy!

Method 2

1. Start up Foundry and click "Install Module" in the "Add-on Modules" tab.
2. Paste one of the following into the "Manifest URL" field:
   • Latest Release: https://raw.githubusercontent.com/MangoFVTT/fvtt-ready-set-roll-5e/master/module.json
   • Previous Releases: A link to the module.json file from any of the previous releases.
3. Click "Install" and the module should download and appear in your modules list.
4. Enjoy!

Compatibility

IMPORTANT: Ready Set Roll is not compatible with other modules which modify DnD5e rolls or chat cards (for example, Midi-QOL). While it is possible that such modules may also still work, using their roll automation features alongside this module is likely to cause issues, and is not recommended.

Verified Modules

The following modules have been verified as compatible from the specified module release onward. Note that updates to Foundry VTT or the module in question may cause incompatibilities that need to be re-tested. Furthermore, each verified module is tested with Ready Set Roll in isolation. Combining modules is likely to still work, however may cause issues. Always proceed with caution (keep backups) when installing and using multiple modules.

• Dice So Nice ^(1.2.0+)

Implemented Features

Quick Rolls

• Rolls for skills, abilities, and items are outputted automatically to chat instead of relying on the default roll dialog system. These quick rolls can be enabled or disabled individually for each category of rolls, or bypassed in favour of the default behaviour by holding alt when clicking the roll.
• Items will automatically output damage, calculate critical damage (taking into account system settings for powerful criticals or critical numerical modifiers), place area templates, print Save DC buttons, and a variety of other options that can all be configured independently for each item.
• Using modifier keys such as shift and ctrl allows for the roll to immediately output with advantage or disadvantage, and will automatically add in any required additional rolls (e.g. for Elven Accuracy). Rolls with advantage or disadvantage highlight the correct roll, indicating which roll is used.

• If the correct setting is enabled, quick rolls can also always display the maximum amount of correct dice for a roll (2 normally, 3 for an Elven Accuracy roll) even when the roll does not have advantage or disadvantage. This can be interchangeably combined with using modifier keys to grant a roll advantage or disadvantage, in which case the correct roll out of those displayed will be highlighted as normal.

Roll Configuration & Alt Rolls

• Rolls can be configured via a "Quick Rolls" tab while editing an item. This allows you to select what parts of the item are actually outputted to the quick roll.
• If enabled, items can also output an alternate roll when holding alt. This alternate roll can be configured independently of the default configuration. Enabling alternate rolls for items disables the ability to use the default dialog rolling for items.

Retroactive Roll Editing

• If enabled via the module settings, quick rolls can be edited post creation, allowing for retroactively rolling advantage, disadvantage, or critical damage for a roll after it has already been created.
• Changes to the roll will automatically live edit the quick roll's chat card, displaying the new data alongside the already existing roll.

Individual Dice Rerolling - TEMPORARILY DISABLED IN 3.0

• If enabled via the module settings, individual dice rolls in quick rolls can be rerolled by clicking on that individual dice within the chat card.
• Rerolling dice will automatically live edit the quick roll's chat card, displaying the new rolls and roll totals alongside the already existing dice.

Apply Individual Damage

• If enabled via the module settings, each damage field in a quick roll chat card can apply damage or healing to selected or targeted tokens via overlay buttons. This extends core system behaviour (applying damage via context menus) to allow for the application of each damage field individually instead of as a single whole.
• Damage fields can be applied in a specific manner (damage or healing) regardless of the actual damage type. This is intended to allow Players or GMs to manually decide what to do with the damage field in the event of edge cases (such as a specific damage type healing instead of doing damage for a particular creature).

Damage Context

• Damage fields can be given additional context strings to convey extra information about that particular damage group. This context will be then shown on the chat card, as either part of the overall damage description or a replacement to default damage titles/type strings.
• Damage context can be configured via the module settings to be placed at various positions of the chat card, and even replace default damage title and type labels.

Macro Support - TEMPORARILY DISABLED IN 3.0

• Module-specific macros can be called to directly create quick rolls with custom options, or to output a set of damage rolls without any attached item.
• Macros are available in the following format:
  • rsr5e.macro.rollItem('item ID or name', 'actor ID or name (optional)', options = {})
  • rsr5e.macro.rollDamage([['formula 1', 'damage type 1'], ['formula 2', 'damage type 2'], ...], options = {})

String Queries - TEMPORARILY DISABLED IN 3.0

• Macro scripts can call rsr5e.query() on a Roll20 style query (e.g. '?{Select Die Value|1d4,4|1d6,6|1d8,8}'.
• This will bring up a dialog prompt parsed from that query when the macro is executed, and return the selected value for later use.

Planned Features

• See [FEATURE] Issues List

Known Issues

• See [BUG] Issues list

Acknowledgements

• Atropos and the Foundry development team for making a truly fantastic VTT.
• RedReign for creating the original Better Rolls for 5e module, without which this module would not exist.
• All the wonderful folks on the Foundry VTT discord for their tireless community efforts.

License

The source code is licensed under GPL-3.0.