foundryvtt/dnd5e release-5.1.0

on GitHub

The 5.1 release of the D&D Fifth Edition system is a large update focusing on refinements to transformations, as well as deeper integrations with the core Foundry VTT Version 13 API. In addition to the usual host of bug fixes and improvements, this release features several highlights such as updated journal, group, & encounter sheets, token ruler integrations, Scene Region integrations, improved automation around advantage and disadvantage, and improvements to resting.

⚠️ COMPATIBILITY WARNING: ⚠️ The version 5.1 release of the system ONLY SUPPORTS Foundry Virtual Tabletop version 13 and greater. To use this new game system version you must also use Foundry VTT version 13. If you do not wish to update your core software, please continue using an earlier version of the dnd5e system.

Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-5.1.0/system.json

Groups & Encounters

Groups

The group sheet has been updated to the Application V2 framework and given a new coat of paint.

It now lists all the various skills relevant to travelling for quick reference, and allows rolling for those skills, taking into account the group's travel pace. The inventory also features an improved interface for distributing items to group members.

Encounters

Encounters have now been moved to their own Actor type, with groups now reserved for representing adventuring groups.

If a primary party is present, the new encounter sheet will now also provide an estimate for encounter difficulty.

Resting

When performing a rest from the group sheet, the DM may now opt to send the request to players instead of automatically performing the rest, similar to requesting a roll. The rest request card will be updated as each creature completes their rest.

DMs also now have the option to remove the rest buttons from character sheets, in order to allow for resting exclusively by request only.

Advantage Automation

Roll mode configuration has been added to all ability checks and saving throws. These fields may now also be targeted by Active Effects, with multiple sources of advantage and disadvantage handled appropriately.

The keybindings for fast-forwarding rolls have been appropriately updated:

• SHIFT - fast forward, accepting the computed roll mode
• ALT - fast forward with an added source of advantage
• CTRL - fast forward with an added source of disadvantage
• SHIFT + ALT - fast forward always at advantage (new)
• SHIFT + CTRL - fast forward always at disadvantage (new)
• ALT + CTRL - fast forward always with neither advantage nor disadvantage (new)

Movement Automation

By leveraging the core Foundry VTT API's Token Ruler and Scene Regions, several aspects of the game's rules on movement can now be appropriately handled.

The ruler has been updated to show regions of green, yellow, and red, according to a creature's configured speed, with green representing a range within the creature's speed, yellow requiring a Dash, and red representing a distance beyond the creature's movement range.

Depending on your rules version, allied and enemy tokens will also appropriately block movement or count as difficult terrain.

Additionally, you may create regions of Difficult Terrain on the map with the use of Scene Regions.

A creature can be configured to ignore certain types of difficult terrain.

If you wish to opt out of movement automation in the system, you may disable it in the settings.

⚠️ Breaking Changes

CONFIG.DND5E.movementTypes

This config has been migrated from Record<string, string> to Record<string, MovementTypeConfig> with a deprecation path.

Spellcasting

CONFIG.DND5E.spellPreparationModes, and CONFIG.DND5E.spellcastingTypes have been deprecated, and their configs rolled into CONFIG.DND5E.spellcasting. CONFIG.DND5E.spellProgression remains, but is read-only, and its config has been rolled into CONFIG.DND5E.spellcasting.

An example of defining a custom spellcasting method that provides pact slots at a delayed rate compared to that of the Warlock:

CONFIG.DND5E.spellcasting.profane = {
  label: "Profane",
  type: "single",
  cantrips: true,
  prepares: true,
  order: 50,
  progression: {
    profane: {
      label: "Profane",
      divisor: 1,
      roundUp: true
    }
  },
  table: {
    3: { slots: 1, level: 1 },
    6: { slots: 2, level: 1 },
    7: { slots: 2, level: 2 },
    13: { slots: 2, level: 3 },
    19: { slots: 2, level: 4 }
  }
};
CONFIG.DND5E.restTypes.short.recoverSpellSlotTypes.add("profane");
CONFIG.DND5E.restTypes.long.recoverSpellSlotTypes.add("profane");

If a progression is not provided, the spellcasting method is assumed to scale with character level.

The following Actor5e methods related to spellcasting preparation have been deprecated:

• Actor5e.computePactProgression
• Actor5e.computeLeveledProgression
• Actor5e.preparePactSlots
• Actor5e.prepareLeveledSlots

Their associated hooks remain and are not deprecated. In order to customise spellcasting preparation, an implementation of dnd5e.dataModels.spellcasting.SpellcastingModel can be provided.

CONFIG.DND5E.spellcasting.profane = {
  label: "Profane",
  type: "profane",
  /* ... */
};

class ProfaneSpellcasting extends dnd5e.dataModels.spellcasting.SingleLevelSpellcasting {
  /** @override */
  static get TYPE() {
    return "profane";
  }
}

dnd5e.dataModels.spellcasting.SpellcastingModel.TYPES.profane = ProfaneSpellcasting;

The SingleLevelSpellcasting model is provided for spellcasting methods that provide slots of only a single level. For spellcasting methods that provide slots of different levels, use MultiLevelSpellcasting.

A spell's preparation state has also now been separated from its spellcasting method. SpellData#preparation#mode has been migrated to SpellData#method, omitting the "always", and "prepared" modes. SpellData#preparation#prepared has been migrated to SpellData#prepared and is now a NumberField with 0 representing 'not prepared', 1 representing 'prepared', and 2 representing 'always prepared'.

ApplicationV2 Conversions

JournalEntrySheet5e

This journal entry sheet implementation has been made the system default. JournalSheet5e has been deprecated and will be removed when the core Foundry VTT Application V1 API reaches the end of its deprecation period, at which point, all content configured to use this legacy sheet will automatically switch over to the new sheet. Any custom sheet implementations that extend JournalSheet5e will need to be updated to extend from JournalEntrySheet5e before then.

GroupActorSheet

The group sheet implementation has been converted to use the core Foundry VTT Application V2 API, with no deprecation path. foundry.dataModels.actor.GroupActor has been renamed to foundry.dataModels.actor.GroupData, with a deprecation path.

Summoning

dnd5e.documents.activity.SummonActivity.fetchActor has been migrated to dnd5e.documents.Actor5e.fetchExisting, with a deprecation path.

Natural Weapons

Natural weapons now default to using the higher of the creature's strength or dexterity by default when calculating bonuses to hit and damage. If your creatures deviate from this rule, they will need to be updated to set an explicit ability in the weapon's Attack activity.

Compendium Content

• [#1437] [#3129] Normalised item prices in the SRD 5.1 based on official rules.
• [#5739] Fixed Dragonborn Breath Weapon save DCs in the SRD 5.1.
• [#5754] [#5756] Fixed Monk's Unarmed Strike DC calculation in the SRD 5.2.
• [#5762] Fixed Rations in the SRD 5.2 not having consumption configured.
• [#5771] Fixed links to the rules of spellcasting in the SRD 5.2.
• [#5772] Fixed the SRD 5.2 Hex and Hunter's Mark damage activities not allowing critical damage.
• [#5822] Fixed spell scroll text ignoring configured rules version and always referencing the 2014 spell scroll rules.
• [#5853] Fixed spell identifiers in the SRD 5.2 not using the generic names.
• [#5869] Fixed the Prismatic Layers & Prismatic Rays roll tables from the SRD 5.2 including baked-in enrichers.
• [#5885] Fixed the poison subtypes reference page in the SRD 5.2.

Bug Fixes

• [#1824] Fixed some additional places where skill & saving throw proficiency merging during Wild Shape was not correct.
• [#2678] Fixed secret reveal button in sheets with multiple editors.
• [#2735] Fixed natural attacks not using the higher of the creature's strength or dexterity.
• [#3050] Fixed item choice advancements not correctly restricting available spells when configured to restrict selections based on the caster's available spell slots.
• [#4535] Fixed combatants being removed from a combat if their linked token had a transformation reverted.
• [#5025] Fixed extra legendary actions & resistances gained via lair being already spent.
• [#5109] Fixed +5 initiative score bonus not applying to creatures with advantage on initiative.
• [#5204] Fixed combat groups using the base Actor name rather than the Token name.
• [#5322] Fixed saving throw merging in Wild Shape for mental saves.
• [#5337] [#5487] Fixed creatures summoned via scrolls not having configured overrides applied.
• [#5382] Fixed long resting not appropriately removing 1 level of exhaustion.
• [#5394] Fixed cases where having temporary hit points left over after taking damage would not prompt for a concentration save.
• [#5408] Fixed Warlocks unable to mark spells as Prepared/Always Prepared.
• [#5429] Fixed incorrect attack bonuses when transformed with the 'keep proficiency bonus' option configured.
• [#5443] Fixed passing a name filter when rendering a Compendium Browser being ignored.
• [#5457] Fixed spell duration missing from the tags in Actor sheet item summaries.
• [#5614] Fixed filtering by an empty spell list in the Compendium Browser showing all spells.
• [#5660] Fixed display of chat message context menu in contexts where it is not available.
• [#5681] Fixed error thrown when attempting to use an activity with enchantment-granted consumptions.
• [#5682] [#5683] Fixed various deprecation warnings.
• [#5728] Fixed priority mode sorting in the spells tab.
• [#5729] Fixed some cases of Items still counting towards attunement when configured to not require attunement.
• [#5765] Fixed recharge abilities continuing to roll for defeated combatants.
• [#5767] Fixed titles supplied at advancement creation being ignored.
• [#5773] Fixed the distance unit drop-down when configuring scale value advancements.
• [#5785] Fixed some cases of temporary additions to max HP being applied twice when an Actor is transformed.
• [#5787] Fixed ignoring configured rules version when generating default advancements for backgrounds and species.
• [#5798] Fixed the Compendium Browser selections being locked to 0 CR features if spawned via Transform activity that had no CR configured.
• [#5793] [#5817] Fixed roll configuration dialog discrepancy when spawned by in-sheet roll enrichers in some cases.
• [#5821] Fixed some display issues with checkboxes.
• [#5831] Fixed error thrown when attempting to craft certain items via bastion facility.
• [#5834] Fixed clicking the 'always prepared' control for a spell toggling its prepared state.
• [#5840] Fixed journal navigation links appearing even if the user does not have permission to view the page that is being linked to.
• [#5846] Fixed enchantment rider containers not bringing their contents with them.
• [#5852] Fixed error thrown when attempting to create a spell scroll from within a compendium.
• [#5854] Fixed filtering by legendary or lair actions on the NPC features tab.
• [#5861] Fixed numerous cases where drop-downs were erroneously offering a blank option.
• [#5867] Fixed the 'separate status conditions' field still being editable on locked Active Effect sheets.
• [#5868] Fixed dragging containers from a bastion crafting result card not creating anything.
• [#5870] Fixed incorrect effect label when prompted to end concentration on one of multiple effects.
• [#5872] Fixed a tool's configured bonus not applying to tool checks in some cases.
• [#5873] Fixed attuning to enchanted items not counting towards a creature's attunement limit in some cases.
• [#5879] Fixed error thrown when reverting transformation of an unlinked token actor while viewing a different scene.
• [#5887] Fixed being unable to cast spell scrolls that were created at a higher level than the base spell.
• [#5888] Fixed some cases of transformation option adjustments not being remembered.
• [#5939] Fixed natural attacks adding their ability modifier to damage when classified as a spell attack.
• [#5944] Fixed incorrect uses displayed in-sheet for spells granted via Cast activity.
• [#5951] Fixed character characteristics modified via Active Effect being saved if the sheet is switched to edit mode.

Improvements

• [#933] Added a special movement field to Actors.
• [#1946] Apply travel pace rules to the group Actor's movement speed.
• [#2147] Add options when transforming to retain gear proficiencies, languages, and damage and condition resistances, immunities, and vulnerabilities.
• [#2219] Added units and travel pace to the group Actor's movement configuration.
• [#3076] Any chat message may now be popped-out.
• [#3124] Group actors are now created with the token data linked by default.
• [#3386] Added the option to not reset temporary modifications to max HP when long resting.
• [#3776] Initiative may now be configured with an arbitrary roll mode.
• [#3782] Added support for Difficult Terrain Scene Regions.
• [#4422] Appropriately apply the surprised condition's disadvantage to creatures' initiative rolls.
• [#4604] Divorced spellcasting method from preparation state.
• [#4804] A link to the Active Effect and Enchantment pages of the wiki is now available in the Active Effect sheet.
• [#4897] Activities may now be configured to automatically apply their enchantment to their parent item.
• [#5108] Token hidden status is now preserved between transforms.
• [#5129] The DM may now optionally request a rest via the group sheet, rather than forcing one.
• [#5130] Appropriately apply bonuses to passive scores when skills and tools are configured to roll with advantage/disadvantage.
• [#5132] Clicking the drop area in an advancement now spawns the Compendium Browser with the appropriate filters set.
• [#5137] Item choice advancements that allow spells to be dropped may now restrict those spells to certain spell lists.
• [#5164] Added support for more advancement types on feat Items.
• [#5171] Added an API method to combine sources of advantage and disadvantage appropriately.
• [#5172] Conditions that apply advantage and disadvantage to ability checks and saving throws are now accounted for.
• [#5173] Roll mode may now be configured for all ability checks and saving throws.
• [#5208] Improve integration with core Foundry VTT pause UI.
• [#5300] Features may now be configured with prerequisites on other Items.
• [#5304] Added a setting to never collapse trays in chat cards.
• [#5338] Added keybindings for forcing advantage/disadvantage or neither when fast-forwarding D20 Test rolls.
• [#5374] Converted group sheets to the ApplicationV2 framework.
• [#5402] Feature & spell Items now support Enchant activities.
• [#5410] Added minimum AC configuration during transformation.
• [#5411] Added the option to preserve spells from a given spell list when transforming.
• [#5415] Preserve favourites when an Actor is transformed if the favourited Item is also retained during the transformation.
• [#5419] When reverting transformation, HP is retained if the transformation was performed with the 'keep HP' option configured.
• [#5483] Statblocks for legacy creatures now display using 2014 statblock styling.
• [#5507] The dnd5e.applyDamage hook now passes isDelta.
• [#5517] Additional item types added downstream may now specify if their consumption or damage should always scale.
• [#5537] When configuring an item choice advancement, items dropped directly onto the advancement will bypass configured restrictions.
• [#5550] Rest recovery summaries are now visible to Observers.
• [#5581] The Transform activity may now be configured with specific creature instances to transform into.
• [#5599] Improved the migration notification.
• [#5604] Added support for the core Foundry VTT theming API.
• [#5656] Added filters for ability score increases granted by feats to the Compendium Browser.
• [#5672] Converted the journal sheet and journal page sheets to the ApplicationV2 framework.
• [#5680] The dnd5e.postRollConfiguration hook now passes information on whether the roll was a critical.
• [#5707] Added the option to reset temporary hit points when long resting.
• [#5708] BasicRoll#buildPost now populates message data if create is false.
• [#5730] Added the dnd5e.prepareSheetContext hook to allow downstream additions to the character sheet to prepare render context.
• [#5736] ASI advancements may now be configured to allow for exceeding the system's default ability score cap.
• [#5740] The Compendium Browser will prevent additional selections when the maximum number has been reached.
• [#5744] Added an option to provide a pre-selected Item type when spawning an Item creation dialog.
• [#5746] Newly-created Items and Actors now default their rules version to that of the game World.
• [#5778] Tokens now appropriately block movement or count as Difficult Terrain.
• [#5779] Creature movement speeds are now integrated with the core Foundry VTT movement action API.
• [#5795] Added support for rendering wildcard and animated token images in the Actor sheet.
• [#5796] Added support for modifying the prototype token image directly from the Actor sheet.
• [#5806] Reduced wasteful rendering in the chat log.
• [#5824] Check enrichers that specify both a skill and a tool will appropriately roll with advantage when using the modern rules if the creature rolling has proficiency in both.
• [#5825] Improved the UX around level 19 epic boon grants.
• [#5847] Unlinked spells may now have their identifier configured.
• [#5848] Skills and tools now sorted alphabetically according to the configured language.
• [#5909] Added an API method for requesting group skill checks.
• [#5957] When rolling from a prompt, a user's configured character will be used if no token is selected.

Contributors

Many thanks to the following contributors in particular: @arbron, @CS-Birb, @Dewi-Jones, @Fyorl, @JDR-Ninja, @krbz999, @mclemente, @righthandofvecna, @robertaird, @roth-michael, @vszalai , as well as all those who submitted bug reports and issues.

Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-5.1.0/system.json