release-1.4.4

This Release was a Test of the CI Workflow introduced in 1.5.0 and contains no code different from 1.5.0

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.4.4/downloads/system.json

release-1.6.1

A minor patch release to fix some lingering issues after the major 1.6.0 release. Please check there for the major patch notes.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.6.1/downloads/system.json

---

Patch Notes

• [#1496] Fixed issue with displaying damage on item sheets when damage type was None, Healing, or Healing (Temporary).
• [#1499] Fixed issues with advancements referencing items in compendia that were not available.
• [#1500] Fixed issue where adding dex to initiative tiebreaker was adding the whole score instead of the score/10.
• [#1503] Fixed issue where a deprecation warning implementation broke modifying CONFIG.DND5E.classFeatures.
• [#1507] Added new Item5e#advancement#byType accessor.
• [#1512] Fixed issue where compendium icons would fail to load under some circumstances.
• [#1514] Added some v10 compatibility checks to allow the advancement system to be tested in the v10 prototype.
• [#1515] Fixed issue with a warning always appearing when moving macros on the hotbar.
• [#1526] Added dnd5e.preAdvancementManagerComplete hook. See the wiki for details.
• [#1527] Fixed issue with template.json not including hp.formula for NPCs.
• [#1528] Fixed issue with AC migration in cases where AC data was malformed by modules.
• [#1529] Deprecated Actor5e#addEmbeddedItems and SelectItemsPrompt.

---

Contributors

Many thanks to Calego, Cole Schultz, Jeff 'Arbron' Hitchcock, and all those who submitted bug reports and issues.

release-1.6.0

dnd5e 1.6.0

This release has been under development for quite some time but we're confident it will have been worth the wait. The flagship feature is what we're calling the 'Advancement' system, but there have been several other improvements and features included so be sure to check the full patch notes at the bottom.

COMPATIBILITY WARNING: The version 1.6.0 release for the system ONLY SUPPORTS Foundry Virtual Tabletop version 9 (release) and greater. To use this new game system version you must also use Foundry VTT version 9. If you do not wish to update your core software, please continue using a previous version of the dnd5e system.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.6.0/downloads/system.json

While many of us on the Foundry VTT team as well as those in the wider dnd5e system development community have contributed a great deal to the design, review, and implementation of the Advancement API, I feel it's necessary to give a special mention to Jeff 'Arbron' Hitchcock who took on the bulk of the implementation and worked tirelessly to drive the release forward.

---

Advancements

The Advancements system provides a new framework for leveling up player characters in the dnd5e system and managing the changes which result from gaining levels. This includes hit points, new features, and automatic scaling of certain class abilities. Moreover this system provides a framework for us to continue automating other aspects of the level-up process like proficiencies, backgrounds, and more.

Opting out

If you do not want any level-up automation in your games, there is a new option under system settings to 'Disable level-up automation'. If you wish to disable this automation on a case-by-case basis, you can remove any advancements from the class, subclass, or background item that is about to be added to a given character.

Configuring advancements

Class, subclass, and background items now have an 'Advancement' tab that DMs can use to configure the advancements that will be granted to a character when they receive that item, or when they increase in levels.

Though the bulk of the work was concerned with building the underlying infrastructure for the Advancement system, this release does ship with three types of advancements ready to use: HitPoints, ItemGrant, and ScaleValue, which are demonstrated in the above video.

We intend to continue building out the system and adding more advancement types in future releases, eventually encompassing the entirety of character advancement.

The existing SRD classes, subclasses and background have all been configured with these new advancements, and we'd encourage you to start adding them to any custom or homebrew ones you have.

Note: Class items embedded on existing characters will not have been updated, and will not contain any advancements. To make use of these advancements on existing characters, you will either need to manually update those class items on the character, or delete them and drop a fresh one from the SRD.

Character advancement

The previous level up prompt has been replaced with one that is generated by the advancements configured on a character's items. It will trigger whenever a character levels up, allowing them to make choices before finally committing the changes to their character.

Removing levels or modifying advancement choices will also appropriately modify the character.

Custom advancements

For module developers or content creators who wish to add new types of advancements, there is a wiki article explaining the more technical details.

User Guide

For a more in-depth walkthrough of the new Advancement system, @MaxPat931 has kindly contributed a comprehensive User Guide which can be found on the wiki.

---

New Item Types

This update introduces new Background and Subclass item types that can contain advancement options.

Background

This type will display in the Backgrounds section on the "Features" tab of a character sheet and accepts advancements, but contains no special functionality.

The "Acolyte" background is included in the "Backgrounds (SRD)" compendium along with its background feature.

Subclass

This type is displayed with its associated class. Ensure that the "Class Identifier" field on the subclass matches the "Identifier" field on the class. Spellcasting data set on a subclass will override any spellcasting set on the class it is associated with, so all the Arcane Trickster rogues out there are set.

Each of the SRD subclasses have been included in the "Subclasses (SRD)" compendium.

---

Patch Notes

The full list of changes is included below:

Deprecations

Class features

Actor#getClassFeatures and Actor#loadClassFeatures are now deprecated. Code referencing them or CONFIG.DND5E.classFeatures should be updated to make use of the new Advancement API instead.

The wiki contains an example of how to configure a custom class using the new API to achieve feature parity with the deprecated methods.

Resting hook

The restCompleted hook has been moved under the dnd5e namespace and the old hook name has been deprecated. Please update references to restCompleted to dnd5e.restCompleted instead.

⚠️ Breaking Changes

Spell components

As part of the work to localise spell component abbreviations [#1313], the 'concentration' and 'ritual' abbreviations were removed from the displayed components on the item sheet. These tags remain, unabbreviated, in their own blocks on the item sheet.

Additionally, the Spell Item's label field has had a breaking change, new display-friendly labels are located at item.labels.components.all.

Subclasses

The subclass field of class items has been removed in favour of the new subclass item type.

Custom AC calculations

Due to a gap in the AC calculation API, some of our guidance around writing custom AC formulae, as well as our own examples, incorrectly made use of @attributes.ac.base. This value is intended to store the result of the AC calculation and correspond to a creature's 'base AC' per the rules, and should not be used as part of the AC calculation itself.

Instead, two new values have been created: @attributes.ac.armor, and @attributes.ac.dex. ac.armor is equal to the creature's equipped armour value (or 10 if they have no armour equipped), while ac.dex is equal to the creature's dexterity modifier, appropriately capped by their equipped armour, or set to 0 when wearing heavy armour.

Custom formulae that intended to reference a character's armoured or unarmoured AC should make use of these new values instead. A migration is provided with this release that will automatically convert references to ac.base with ac.armor in custom AC formulae as well as Active Effects.

Compendium Content

New Compendia

• Tables (SRD) contains rollable tables available in the SRD
• Backgrounds (SRD) contains advancement enabled backgrounds from the SRD
• Subclasses (SRD) contains advancement enabled subclasses for each Class in the SRD

Related Issues

• Added Forgotten Adventures token packs 23-28.
• [#1038] Improvements to SRD Figurine items.
• [#1329] Resynced SRD Monsters' and Starter Heroes' spells with updated versions in the SRD Spells compendium.
• [#1411] Added Bit & Bridle, Saddles, and Saddlebags to SRD Items compendium.
• [#1418] Fixed False Life level scaling.
• [#1427] Fixed various broken content links.
• [#1446] Updated spell scrolls to include SRD errata.
• [#1450] Fixed Purify Food and Drink ritual tag, and Zone of Truth concentration tag.
• [#1460] Added madness roll tables.
• [#1488] Added Monk-specific Unarmed Strike that uses new scaling Martial Arts die.

Features

• [#506] Added Hit Dice as an option to item resource consumption.
• [#530] Added explicit class and subclass identifiers.
• [#563] Display weapon attack, to-hit, and saving throw DC on item sheets.
• [#760] Support temporary hit points for NPC actors.
• [#1059] Added background item type.
• [#1080] Added subclass item type.
• [#1094] Max character level is now configurable and no longer hard-coded.
• [#1197] Added Honor and Sanity optional ability scores and the ability to configure ability scores used by the system.
• [#1300] Added attunement field to tools.
• [#1311] Added max attunement slots to character data.
• [#1313] Added localisation for spell component abbreviations.
• [#1393] Added the ability for additional spell tags to be configured.
• [#1439] Added ac.armor and ac.dex computed AC values to fix hole in AC calculation API.
• [#1484] Improved hook documentation.

Bug Fixes

• [#1040] Use spellcasting modifier as default modifier for spell scrolls.
• [#1093] Fixed creating a level 1 duplicate of a class if one was dropped onto a sheet where there was already a 20th level version of the same class.
• [#1345] Fixed broken Bardic Inspiration content links in several places.
• [#1374] Fixed the incorrect AC preview being shown for custom AC formulae that referenced @attributes.ac.base.
• [#1392] Fixed ability check bonuses not being applied to tool checks that used a non-default ability.
• [#1412] Fixed the rollMode not being passed to the roll object as part of a d20Roll.
• ...

release-1.5.7

Bug Fixes

• Fixed spell attack rolls not using proficiency dice when enabled.
• Fixed Adult Green Dragon and Otyugh damage formulae.
• Allowed ammunition to be consumed when using non-attack abilities.
• Added missing Marvelous Pigments and Truth Serum to SRD item compendium.
• Fixed an error when cancelling a spell template placement workflow triggered from somewhere other than a character sheet.
• Fixed Defense Fighting Style's Active Effect bonus sometimes being concatenated to the existing value rather than added.
• Fixed a race with the ProficiencySelector cache loading.
• Fixed incorrect speaker data when making a damage roll.
• Updated some SRD class features to appropriately provide a minimum of 1 use where applicable.

Contributions

Many thanks to Eric Triebe, Chris Seieroe, @d1no1, @MaxPat931, Jeff 'Arbron' Hitchcock, @TheGiddyLimit, and all those who submitted bug reports and issues.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.7/downloads/system.json

release-1.5.6

Version 1.5.6 is a minor release which adds final touches of compatibility for both Foundry Virtual Tabletop v8 and v9.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.6/downloads/system.json

Applied Changes: https://gitlab.com/foundrynet/dnd5e/-/milestones/46

release-1.5.5

A minor release to revert the use of v9 spell icons that were mistakenly included.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.5/downloads/system.json

release-1.5.4

This is a minor release contains small quality-of-life fixes, and some bug fixes. Notably, all consumables except rods, trinkets, and wands are excluded from the requirement of being marked as 'equipped' in order to provide their Active Effects.

Additionally, this release provides a migration for all existing spell icons to now use those provided by the core foundry software. It uses the same mechanism as the earlier non-spell icon migration in 1.5.0, so please refer to those release notes for details on how to apply this migration to your own compendia.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.4/downloads/system.json

release-1.5.3

A minor release to fix an issue with the minimum core version. Also included is a macro icon migration, some additional small fixes to the token and icon migrations, and some further compendium data cleaning.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.3/downloads/system.json

release-1.5.2

Minor release to fix some missing files from 1.5.0. Please refer to the release notes from that release, here.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.2/downloads/system.json

release-1.5.0

In addition to numerous bug fixes and compendium fixes, this update brings several useful features and additions to the system, including: extra data on items to help proficiency determination; the proficiency dice variant rule; extra critical damage and threshold fields on weapons; a couple of popular critical hit house rules; as well as the ability to set individual ability check and saving throw bonuses. (And a bonus feature for those of you dabbling in the v9 prototype).

Features

That Longsword +1 you just picked up can have its base weapon type set appropriately now so the system can better determine if you're proficient with it or not.

Your DM is now able to switch their game to use this proficiency dice variant rule as presented in the DMG and have it appropriately affect all attack rolls, ability checks, and saving throws.

Vicious or Vorpal weapons can now have their extra critical hit damage configured, as well as any homebrew items you may have with special critical hit thresholds.

There's now built-in support for a couple of popular critical hit house rules, as well as a more flexible API for modders who want to tweak things further.

Ability scores and skills can now be individually configured to set additional bonuses to the skill or ability in question, any passive scores, or to the associated saving throw. All of these new fields may also be targeted by Active Effects.

Bonus Feature

And the bonus feature is scrolling text if you happen to be using the v9 prototype.

Developer Tooling

Another big focus of the update was on developer tooling with the goal of making it easier for others to contribute to the system, and faster for us to review those contributions. Those of you who are interested in that should take a look at the new CONTRIBUTING.md that has been added as part of this release.

We've also made it a lot easier to review compendium contributions. If you aren't interested in developing, but still want to submit fixes to compendium content, it should be much simpler now. Feel free to implement the fix, export the item or actor, and then attach it to an issue for us to review.

Many thanks to Calego additionally for implementing a CI workflow in the repository, allowing us to streamline the release process as well as strip out files from the final release that were only used in development.

Icon and Token migrations

Courtesy of our friends at Forgotten Adventures this update ships with brand new tokens from Token Packs 20, 21 & 22, as well as all existing tokens in WEBP format. The monsters and heroes compendia have been updated to use these new WEBP tokens, and a migration will be applied to your world to update any of the old PNG tokens in use with their new, WEBP counterparts. The old PNGs won't be going anywhere, they're still there so as to not break any actors you might have stashed away in compendia or from modules. If you would like to update those compendia though, you can run the following against them:

game.dnd5e.migrations.migrateCompendium(pack);

Additionally, many of the item icons have been switched to use the ones provided by core foundry (which are also in WEBP format), and a similar migration has been added to convert those in your world too. Like with the token images, the original icons are not being removed from the system, so you can still use them. If you would like to update any of those icon paths in your compendia to the core foundry ones, you can run the same migration as above.

Patch Notes

The full list of changes is included below:

Features

• Added proficiency dice variant rule.
• Improve automatic proficiency determination across weapons, tools, and armour.
• Added the ability to configure individual ability check and saving throw bonuses.
• Split out the compendia into individual JSON files and added tooling around packing and unpacking them.
• Added currency abbreviation localisations.
• Added support for some critical hit house rules.
• Added CONTRIBUTING.md and package.json to provide better support to contributors.
• Added a way for items to prompt for ability check rolls, similar to saving throws.
• Tool items can now be configured with an individual bonus.
• Added critical hit threshold and extra critical damage fields to weapons.
• Added an ESLint configuration to the repository to aid new contributors in passing code style checks.
• Most bonus fields now support data references.
• Ability check bonuses now apply to initiative rolls when appropriate.

Bug Fixes

• Fixed several issues where invalid roll formulae would break character sheets.
• Fixed some issues with roll formula simplification.
• Fixed the missing Active Effects tab on Vehicle sheets.
• Fixed spell to spell scroll conversion sometimes missing some data.
• Numerous compendium data clean ups.
• Fixed Vehicles trying to use a proficiency bonus they didn't have.
• Fixed clicking on an Active Effect icon attempting a roll.
• Fixed macro duplication logic.

Contributors

Thanks to Calego, Connor McCormick, 'DFreds', 'Giddy', Jeff 'Arbron' Hitchcock, Johannes Loher, 'Kandashi', Phil Best, 'Surge D20', and all those who submitted bug reports and issues.

Installation: To manually install this release, please use the following manifest URL: https://gitlab.com/foundrynet/dnd5e/-/releases/release-1.5.0/downloads/system.json