Skip to content

A module for modifying sheet rolling functions on Foundry VTT Character sheets for Star Wars 5th Edition.

License

Notifications You must be signed in to change notification settings

sw5e-foundry/fvtt-ready-set-roll-sw5e

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ready Set Roll for sw5e - FoundryVTT Module

This is a work-in-progress transition to sw5e for Ready Set Roll; there might be a few issues, be aware!

Ready Set Roll for sw5e is a Foundry VTT module that accelerates the built in rolling system of the Foundry sw5e 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.

Check out MangoFVTT, the original author of Ready Set Roll for dnd5e!

Installation

Method 1

  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/RainingDragon/fvtt-ready-set-roll-sw5e/working-sw5e/module.json
  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 sw5e rolls (for example, Midi-QOL or MRE). 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.

Ready Set Roll requires libWrapper as a dependency to avoid conflicts with other modules. This dependency will be automatically resolved by Foundry when installed. It is recommended to have the latest version of libWrapper installed at all times.

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.

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.

quickrolls

  • 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.

alwayson

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.
  • Item configuration extends system support for thrown items, consumables, ammunition, and items with otherwise limited quantities.
  • 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.

rollconfig

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.

retroactiveoverlay

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 tokens individually 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).
  • Applying critical damage to a token will display a prompt allowing for critical damage to be ignored if desired. This can be disabled via a setting to always apply critical damage.

damageoverlay

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.

damagecontext

Known Issues

Come here for issues (do NOT report issues to MangoFVTT, sw5e is slightly different): https://github.com/RainingDragon/fvtt-ready-set-roll-sw5e/issues

  • Chat icon for weapon or spell is off, we're looking into though!

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.
  • MangoFVTT for creating the new Ready Set Rolls for 5e module, without it we wouldn't have it for sw5e!
  • All the wonderful folks on the Foundry VTT discord for their tireless community efforts.

License

The source code is licensed under GPL-3.0.

About

A module for modifying sheet rolling functions on Foundry VTT Character sheets for Star Wars 5th Edition.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.1%
  • HTML 10.5%
  • CSS 2.4%