Build-a-Bonus

2022 Package Jam winner of the 'Most Polished' category and runner-up for 'Best Package'

A module for the Foundry dnd5e system. After installing this module, you can find a 'Build-a-Bonus' application in any actor's, items, or effect's header. This gives you the ability to apply a bonus to any attack roll, damage roll, saving throw DC, saving throw, ability check, or hit die roll, for bonuses that should apply only under specific circumstances. If a bonus is embedded in an item or effect, they transfer with the item/effect if placed on another actor.

Any bonuses you create will automatically be calculated and applied when you perform a relevant roll. The module uses filters to determine when and if a bonus should be applied. For example:

• Implement the alchemist artificer's feature to add their intelligence modifier (@abilities.int.mod) to the damage rolls of all spell-type items, and have Build-a-Bonus filter the bonus so it only applies to spells, only if it deals acid, fire, necrotic, poison, or healing, and only if it has a material (M) component.
• Give your wizard player a bonus to the saving throw DC with just divination spells, and make the bonus equal to the level of the spell (@item.level).
• Give your magical pugilist a feature akin to Brutal Critical and have it apply only to melee spell attacks.
• Give your paladin an aura that grants each enemy within 10 feet a −2 to melee attack rolls.
• Give your rogue player a magic item that creates a 15-foot radius template, inside which everyone gets a damage roll bonus equal to the rogue's sneak attack dice.

The Build-a-Bonus has countless options for how or what to apply and when. Scroll down to the bottom for the full list.

How to Use

Open any actor's sheet, any item sheet, or any effect config, then click the otter icon in the header. Choose the type of bonus you want to create, then fill out the name, description, and the bonus. Then start narrowing down when and how the bonus should apply, using the available filters to the right.

Once the bonus is created, you can configure it further on the main view of the application on the right.

If you need additional hints, hover over any of the labels to get tooltips. Not all filters are available for each type of bonus. Below is an example using the artificer's Alchemical Savant feature.

Once you are done creating the bonus, save it, and your actor should now have their bonus apply when they perform the relevant roll, given that they match the filters of the bonus.

Bonus Creation and Configuration

This is the full array of configurations, filters, and choices you can make in the Build-a-Bonus. For any fields that support roll data (such as bonuses or comparison fields detailed below), you can use the roll data of the target as well as your own; use roll data as you normally would, and for targets simply prefix with @target.

In addition, when a bonus is 'transferred' either via an effect being copied through a template aura or regular aura, the roll data used will be source's roll data, if any. This means that your paladin player can have their Aura of Protection set up using @abilties.cha.mod and all allies within the aura will receive a bonus equal to the paladin's Charisma modifier, not their own Charisma modifier.

One thing to keep in mind is that bonuses use the source's roll data, while the filters use the recipient's roll data.

Required Fields

Name. The human-readable name of the bonus (you can put anything you like here). The ID shown next to it is the unique identifier that the module uses to refer to the bonus, which is also used in several API methods (see below).

Description. A blurb of your choosing describing the bonus. This text is enriched and supports roll data.

Bonuses and Modifiers

Depending on the type you choose, Build-a-Bonus can add on top of the value or roll, or even several kinds at once. For example, for attack rolls, you can add bonuses on top of the roll itself, but also increase the critical range and the fumble range. This can be roll data and scale values, such as @abilities.int.mod, or just integers or dice expressions.

For damage rolls and hit dice rolls, you can also affect die modifiers. The supported modifiers are minimum and maximum values, rerolling, and explosive dice, as well as the quantity of the dice.

Aura and Template Configuration

You can set the bonus to act as an aura within a set range or within a template created by an item, and define if the aura should apply to allied targets, enemy targets, or all within range or within the template, and whether it applies to the owner or not.

The bonus is applied when another token actor makes a relevant roll. The module never makes use of token movement to calculate ranges, so the usage of auras and templates is incredibly lightweight.

You can configure a list of effect statuses that prevent the aura from affecting targets and the owner (such as if the source of the aura is dead or unconscious). The Keys button in the builder will help you pick out statuses from those that exist on the token HUD. The field itself is not validated; if you are able to give an effect a status of your own choosing, that is respected as well; simply write the status in the field.

Lastly, you can configure a non-template aura to require direct line of sight from the source token to the rolling token's actor, or to require an unobstructed path of movement.

Item-Specific Bonuses

For any bonus created on an item (spell, feature, weapon, etc.), if that bonus does not produce a valid aura of any kind, you may toggle it in the Build-a-Bonus to only apply to that item in question. This is good for any unique weapons for example that have certain properties that should apply only to themselves.

Optional Bonuses and Consumption

If the bonus additively affects an attack roll, damage roll, saving throw, or ability check (adding a bonus on top), the bonus can be toggled to be optional. Other types of bonuses will apply regardless. The actor will then have the choice when adding the bonus, which is shown in the roll configuration dialog when making the roll.

If the bonus is optional as described above, the bonus can also be configured to consume limited uses, item quantity, spell slots, hit points, currencies, or the active effect on which it is created. You can configure the minimum required consumption, as well as the maximum if the bonus should scale.

For example, if you create an item with 10 limited uses, a bonus of "1d6", configure that the bonus is optional, and consumes between 2 and 6 uses when opted into, the actor making the roll can easily add between 2d6 and 6d6 in the roll configuration dialog, and the expended uses are automatically subtracted. This works similarly for spell slots, instead using 1 slot and scaling with spell level. A bonus consuming its effect cannot scale.

Available Filters

These are the available filters that narrow down if the bonus should apply when making a roll.

Abilities. The ability score used for the roll. This respects items set to use defaults, such as spells using the spellcasting ability, or finesse weapons using either Strength or Dexterity.

Actor Conditions. Filter the bonus to only apply if the actor is affected by any of the included status conditions while having none of the excluded status conditions. This uses the statuses stored in status conditions, as detailed above.

Arbitrary Comparisons. An array of arbitrary comparisons you can use for anything that is not covered in the Build-a-Bonus natively. This supports numbers, roll data, and strings. If you enter strings, you can use the inequalities to match substrings. It will otherwise attempt to determine numeric values after replacing roll data with the roll data of the item and actor performing the roll. For example, you can have a bonus apply only when the actor is below full health with @attributes.hp.value <= @attributes.hp.max. Unlike other filters, you can add this filter to the builder multiple times.

Attack Types. Filter the bonus to only apply if the item used to perform the roll has an attack roll of that specific kind.

Available Spell Slots. Filter the bonus to apply only if the actor performing the roll has more than the set minimum amount of spell slots available and/or less than the set maximum amount of spell slots available. Not both fields are required.

Base Armors. Filter the bonus to only apply if the actor is wearing a specific type of armor or a shield.

Base Weapons. Filter the bonus to only apply if the item is a weapon with one of these base weapon types, such as 'battleaxe' or 'blowgun'.

Actor Creature Types. Filter the bonus to only apply if you are belonging to one of the included creature types, such as 'undead', 'fey', or 'humanoid', while not belonging to any of the excluded creature types.

Target Creature Types. Filter the bonus to only apply if you are targeting an enemy belonging to one of the included creature types, such as 'undead', 'fey', or 'humanoid', while not targeting any of the excluded creature types.

Custom Scripts. A blank text field for users to write any JavaScript code they like. The script must be fully synchronous and return true or false. The available variables declared for the script will vary by the roll type, but actor, item, token, and bonus are always provided if possible, as well as an object, details, used for the iteration of parsing the validity of the bonuses. For those uncomfortable with having all clients execute these scripts, a setting is available for the module which will completely ignore the scripts and simply immediately return true.

Damage Types. Filter the bonus to only apply if the item used to perform the roll has a damage formula with any of the included damage types while having none of the excluded damage types.

Health Percentages. A percentage value and whether the actor must have at least or at most this amount of remaining hit points for the bonus to apply.

Item Types. The type of item the bonus should apply to. For example if you want to increase the save DC globally but only for equipment type items, not spells.

Proficiency Levels. The level of proficiency that the actor must have with the roll made. This is available for ability checks, saving throws, and attack rolls.

Save DC Ability. Filter the bonus such that it only applies if the DC is set using a specific ability. This respects spellcasting abilities in case the item has its save DC set using 'Spellcasting'.

Saving Throw Types. The type of saving throw the bonus should apply to (any ability score as well as death saving throws). If you are using the module Concentration Notifier, you can also apply a bonus specifically to saves for maintaining concentration.

Skills. The type of skill the roll must be for the bonus to apply. For example Athletics, Nature, or Survival.

Spell Components. Filter the bonus to only apply if the item is a spell that has any one (or all) of the given components.

Spell Levels. Filter the bonus to only apply if the item is a spell and is or was cast at one of the given levels.

Spell Preparation Modes. Filter the bonus to only apply if the item is a spell and is set as one of a selected few preparation modes such as 'pact magic' or 'innate'.

Spell Schools. Filter the bonus to only apply if the item is a spell belonging to one of the given spell schools.

Target Conditions. Filter the bonus to only apply if the target (of the client performing the roll) is affected by any of the included status conditions while having none of the excluded status conditions.

Token Sizes. Filter the bonus to only apply if the target (of the client performing the roll) is a token of a certain size or greater (or smaller), and optionally clamped using the roller's token's size.

Tool Types. The type of tool the item must be for the bonus to apply. For example Herbalism Kit, Thieves' Tools, or Cobbler's Tools.

Weapon Properties. Filter the bonus to only apply if the item is a weapon that has at least one of the included weapon properties while having none of the excluded properties.

API

An API can be accessed at game.modules.get("babonus").api or through the global namespace babonus. The parameter object below refers to an Actor, ActiveEffect, Item, or MeasuredTemplateDocument. The methods are currently:

• getId(object, id) returns the bonus with the given id on the given document.
• getIds(object) returns the ids of all bonuses on the document.
• getName(object, name) returns the bonus with the given name on the given document. Returns the first one found if multiple have the same name.
• getNames(object) returns the names of all bonuses on the document.
• getType(object, type) returns all bonuses on the object of the given type (e.g. "attack", "damage", "save", "throw", "test", "hitdie").
• getCollection(object) returns a Collection of bonuses on the object.
• fromUuid(uuid) returns a bonus on a given document. The uuid is the uuid of the parent document appended with .Babonus.< id >.
• createBabonus(data) returns a new Babonus document created with the provided data. This does not create the bonus on the document, only in memory.
• embedBabonus(object, bonus) embeds the data of the given babonus into the given actor, item, or effect.
• copyBonus(original, other, id) copies a bonus with the given id from one document to another. Note that a bonus can also be dragged and dropped via the ui.
• deleteBonus(object, id) removes the bonus with the given id from the document.
• moveBonus(original, other, id) copies a bonus with the given id from one document to another, then removes the original bonus.
• toggleBonus(object, id, state=null) enables or disables a bonus, or sets it to the given state (true or false).
• findEmbeddedDocumentsWithBonuses(object) returns an object with two arrays containing items and effects on the given document that have a bonus.
• findTokensInRangeOfAura(object, id) returns all token documents that are in range of an aura with the given id on the document.
• findTokensInRangeOfToken(token, radiusFt) returns an array of token placeables that are within the given range of the given token placeable.
• openBabonusWorkshop(object) opens the Build-a-Bonus workshop for the given document.
• getAllContainingTemplates(tokenDoc) returns the ids of all templates on the scene that overlap with the token document.
• getMinimumDistanceBetweenTokens(tokenA, tokenB) returns the minimum distance between two token placeables, evaluating every grid cell that they occupy.
• sceneTokensByDisposition(scene) returns an object of four arrays; the tokens on the scene split into four arrays by disposition (friendly, neutral, hostile, and none). If no scene is provided, the currently viewed scene is used.
• getOccupiedGridSpaces(tokenDoc) returns all grid spaces that a token occupies on its scene.
• Within the API's filters object, you can find all the filtering functions used by the module internally. They are too numerous to list here.

Hooks

A single hook, babonus.applyOptionalBonus is called when applying an optional bonus; after updates or deletions are performed, but before the bonus is applied to the roll. It provides the babonus, the rolling item or actor, the item, actor, or effect that was updated or deleted, and an object with the bonus that will be applied. The bonus to be applied can be modified. Explicitly returning false will prevent the bonus from being applied entirely.

Compatibility

You should not expect this module to work with other modules that overhaul or destroy core roll behaviour, particularly WIRE, RSR, and MIDI. These modules are unsupported, and any compatiblity is nothing but a happy accident.