Bardic Inspiration Die Implementor Extension (for 5E)
THIS EXTENSION IS NO LONGER AVAILABLE.
As of late September 2023 I've not played D&D in over a year now.
It's doubtful that I will return in the near future.
Currently I have no interest, nor time, to maintain it.
This extension ensures most uses of a Bardic Inspiration Die conform to th 5E rule stipulation: "the inspiration die may be used after a roll result is stated but before the outcome of the roll is announced". The Lucky Feat has similar rules so it too is supported.
STOP!! ## Before downloading and trying to use this extension
READ, UNDERSTAND and be willing to COMPLY with the instructions and limitations
stated in posts #2 and #3 of this thread. ## STOP!!
The following posts to this thread contain this information:
#2 - How to use the extension (Use, part 1).
#3 - Limitations and Caveats (Use, part 2).
#4 - Versioning information, Known issues. And what ever else.
(The versioning information also acts as a pseudo-index, of sorts, to new and added functionality, often pointing to specific posts in this thread that detail changes.)
The current version of this extension (v0.0.10) released on Nov 27, 2022.
FGU users can subscribe to receive automated updates of this extension in the Forge (here).
This extension is not available for FGC.
3 Attachment(s)
Extension Use (Part 1 - the Good Stuff)
Extension Necessity:
From the Bardic Inspiration section of the Bard's Class in the 5E Player's Handbook: "The creature can wait until after it rolls the d20 before deciding to use the Bardic Inspiration die, but must decide before the DM says whether the roll succeeds or fails." Restated: Some features that use the Bardic Inspiration Die rely on the player knowing the outcome of the roll of the dice but not whether that roll succeeded or failed at its intended use.
Fantasy Grounds does a lot of the math work for us for many rolls of the dice. It also announces the results, success or failure, for most of those rolls if the "Chat: Show Results to Client" option in the Options Manager is "On". This extension inserts itself in between the adjudication of the dice roll and the announcement of the result for three specific features of the Bardic Inspiration Die feature: Bardic Inspiration, Combat Inspiration and Cutting Words.
If you are a DM that announces the results of every dice roll this extension is of no use to you.
Extension Effect:
When properly set up and employed the extension will modify what Fantasy Grounds displays in the Chat Box. The following image is comprised of two screenshots, the upper portion is the Chat, Character Sheet and Combat Tracker for the PC Thayus and the lower portion is similar but that of the DM.
Attachment 39570
Two attack rolls by the PC Thayus are displayed, one (circled in blue) is without the extension coming into play, the second (circled in red) is when the extension does its thing. When the "Bardic Inspiration" Effect is applied to Thayus and he makes his attack, the outcome of the throw is displayed but its result is not (for the player). However the DM is privy to the adjudication of the roll. Note that the "[EFFECT] Bardic Inspiration" is displayed to both Chats as a reminder that something additional is expected. The DM should announce the roll total and the player needs to decide whether or not that's sufficient for the desired outcome, and if not, whether or not a Bardic Inspiration Die roll might sufficiently affect the result.
Extension Environment:
In the next screenshot, of the Fantasy Grounds Options Manager, three of the options that affect, to varying degrees, what is displayed to the players in the chat box are circled in blue. The most important of these (in red) is the "Chat: Show Results to Client". If this option is "Off" this extension is also turned off, because all results have to be verbally announced by the DM anyway.
Attachment 39571
Some setup is required. The DM or the player with a Bard character must add a couple of Effects to the Bard's character sheet. I suppose one could add them to the Effects Manager instead. The Effects' names cannot be changed, the extension uses those specific strings to key off of. The following screenshot displays all the details.
Attachment 39572
As of version v0.0.10, additional parameters or notes are allowed with the Effect Names (see post #80 of this thread).
Typically the Bard will only have two of the three Effects available since "Combat Inspiration" and "Cutting Words" are Bard College specific. The example of descriptive content marked with orange is not necessary but I find it can be helpful to have it all on the Actions tab with the Effects.
Extension Use:
The typical scenario for this extension's use is: during the Bard's turn the player can elect to apply the appropriate effect to whichever other player they wish. Note that once the Bard reaches 3rd level the Cutting Words Effect is always present (for a College of Lore Bard). When the triggering circumstances occur (e.g. attack, save, damage, etc.) the extension intercepts the results announcement and displays "[Effect] <effects name>". At this point the affected player must decide if they wish to use a Bardic Inspiration Die to affect the results. Then the DM has a little math to do.
Versioning Information and Whatever Else
NOV 27, 2022 v0.0.10 - nil value error fixed, BIDI Effects syntax relaxed (post #80)
MAY 15, 2022 v0.0.9 - supports incidental area of effect saves (post #47)
APR 21, 2022 v0.0.8 - minor extension.xml changes for better Forge support
APR 21, 2022 v0.0.7 - discontinued support for FGC
FEB 29, 2022 v0.0.6 - Support for Lucky Feat announced (posts #41 & #43).
FEB 16, 2021 v0.0.6 - New FG release broke the extension (constants in FG changed values).
SEP 22, 2020 v0.0.5 - Announcement and BIDI initial release.