Releases: foundryvtt/dnd5e
release-2.3.0
dnd5e 2.3.0
This release of the dnd5e system contains several additional features, improvements and fixes. Please read on for the full breakdown of all the changes.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.3.0/system.json
Features
Ability Score Improvement Advancement
Jeff's continued hard work on the Advancement framework brings us the Ability Score Improvement Advancement, allowing players to pick ability scores to increase whenever they reach certain levels in their classes. There is a game setting provided for those tables using the optional rules for Feats, allowing players to drag and drop a feat in place of taking an increase to their ability scores.
Configuring points allocation
Configuring fixed increases or decreases
Applying the Ability Score Improvement
Automatic Proficiencies
Weapons, Armour, and Tools can now have their proficiency set to 'Automatic'. When rolling with these items, the character's proficiency bonus will be appropriately included or withheld based on the character's configured proficiencies, though there are still no penalties enforced by the system for equipping armour that a character is not proficient in.
Editing Quantities
Item quantities can now be edited from within the actor sheet, including group sheets.
Patch Notes
The full list of changes is included below:
⚠️ Breaking Changes
Consumable Resources
DND5E.consumableResources
is now an explicit list of actor properties that can be consumed by an item. It is no longer used to filter the list of trackable token attributes, the two concepts have been separated entirely. TokenDocument5e.getConsumedAttributes
is still called as part of marshalling consumable attributes, but its return value has changed to string[]
. It presently just returns the value of DND5E.consumableResources
, but modules may override this method to provide alternative functionality.
Compendium Content
- Added Forgotten Adventures token packs 46-48.
- ASI Advancements added to SRD classes.
- Diversified armour & shield icons.
- Diversified various miscellaneous item icons.
- Added some missing or incomplete Active Effects to items.
- Organised the system's compendium packs into folders.
- Fixed missing FA token art.
- Fixed non-magical items being given a rarity.
- Minor data fixes.
Features
- [#2056] Added an 'empty group' label for group actors with no members.
- [#532] Item quantity now editable in-line in the actor sheet.
- [#1822] Selecting 'keep spells' when transforming an actor also retains the host's spellcasting ability.
- [#2266] Added a detection mode for blindsight.
- [#2067] Creating a feature on an NPC actor now automatically sets the feature type to 'monster feature'.
- [#2309] Added 'Arcane Shot' as an available feature sub-type.
- [#1309] Added attuned item count to actor sheet, with the ability to override an actor's maximum attunements.
- [#2172] Added ammunition, container, and spellcasting focus IDs to the system configuration.
- [#974] [#1122] Added 'any', 'creature or object', and 'willing creature' to the list of available target types.
- [#1241] Spell scrolls auto-created from spell items will include a note on whether the spell requires concentration.
- [#2026] Added 'none' as an option when selecting an item's ability modifier.
- [#2121] Removed hard-coding around pact slot progression and made it configurable.
- [#2119] Removed hard-coded limit on maximum spell level and made it configurable.
- [#1082] Added 'automatic' as an option for proficiency for weapons, armour, and tools.
- [#2036] [#1088] Added 'adamantine', 'silvered', and 'magical' as available properties for ammunition.
- [#1403] Added the Ability Score Improvement Advancement.
- [#1013] Added a configurable maximum to ability scores.
Bug Fixes
- [#2151] Fixed group sheet inputs not accepting deltas.
- [#2134] Fixed the 'charges' column on the group sheet inventory not being correctly populated.
- [#2257] Fixed the ruler not providing accurate measurements when the game is set to Euclidean diagonals.
- [#1874] Fixed icon migrations not applying to Roll Tables.
- [#2097] Fixed long actor names being unceremoniously truncated on the group sheet.
- [#2250] Improved template preview drawing logic to inform the user of any errors encountered rather than silently failing.
- [#2049] [#2228] Fixed prototype token sizing being reset when adding an actor into a compendium.
- [#2196] Fixed tools and containers not having anywhere to toggle their equipped/attuned states on their item sheets.
- [#829] Fixed the interactable bounding box on item names on actor sheets not matching their hovered bounding box.
- [#2362] Fixed item recovery formulae resetting whenever the item is updated.
- [#2397] Fixed validation error thrown whenever a vehicle is created.
- [#2363] Fixed spell slots not being available as item resource consumption targets.
- [#2284] Fixed pact slots not being available as token trackable attributes.
- [#2337] Fixed the Item Choice Advancement drop area being smaller than intended.
- [#2339] Fixed Item Choice Advancements breaking Background items when a value was input into the 'Any Level' field.
- [#1821] Fixed selecting 'keep mental/physical ability scores' also retaining the host's saving throw proficiencies regardless of whether 'keep saving throw proficiencies' was checked.
- [#2382] Fixed scrolling status text still showing for tokens that had been hidden by the GM.
- [#2233] The attunement icon now appropriately displays as highlighted when attuned, and greyed-out when unattuned.
- [#2369] Fixed in-memory tool migration not working.
- [#2305] Fixed proficiency setting on a tool item not being used when rolling from that item.
- [#2328] Fixed error when configuring the prototype token of a group actor.
Contributors
Many thanks to the following contributors in particular:
- Jeff 'Arbron' Hitchcock
- MaxPat931
- M0nk3yy
- Righthandofvecna
- Taverna del Beerholder
- Zhell
... as well as all those who submitted bug reports and issues.
release-2.2.2
A small patch release containing fixes for some disruptive issues. For the full 2.2 release notes, see here.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.2.2/system.json
Bug Fixes
- [#2360] Fixed incorrectly migrated icon paths.
- [#2214] Fixed Item Grant Advancement configs from not opening if any items could not be found.
- [#2336] Fixed being unable to roll initiative via 'Roll All' if any Combatant had an initiative bonus including data terms like
@prof
. - [#2332] Fixed being unable to select HP as a trackable attribute for vehicle tokens (v11 only).
- [#2327] Fixed tool Items not having their proficiency set based on the Actor's proficiency.
- [#2335] Fixed being unable to roll initiative via 'Roll All' if any Combatant referenced a Token with no represented Actor.
- [#2223] Fixed Token HP bars being rendered incorrectly if a very large
tempmax
was applied to the represented Actor. - [#2358] Fixed being unable to set expertise proficiency in a tool if the Actor had tool Items in its inventory set to expertise proficiency at time of migration.
- [#2273] Fixed being unable to set the Source field of vehicle Actors.
- [#2221] Fixed the Hit Points Advancement Flow throwing a console error if attempting to proceed without entering a hit point value for the level or selecting 'take average'.
- [#2192] Fixed some migrations failing due to source data being
null
orundefined
. - [#2357] Fixed Item price and weight being set to 0 whenever the Item was equipped or unequipped.
- [#2277] Fixed an empty string being appended to the initiative formula whenever an Actor had no initiative bonus.
- [#2333] Fixed being unable to create NPC actors if the Honor or Sanity optional rules were enabled.
- [#2195] Fixed transforming an actor with 'keep class active effects' enabled actually keeping effects from
feat
Items instead ofclass
Items.
Contributors
- Chris Seieroe
- Ikaguia
- M0nk3yy
- Zhell
release-2.2.1
A small patch release to fix some issues with using the system in v10. For the full 2.2 release notes, see here.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.2.1/system.json
Bug Fixes
- [#2294] Fixed error throw when deleting advancements.
- [#2302] Fixed error during tools migration of vehicles and group actors (no re-migration necessary since they did not have tools to migrate anyway).
- [#2301] Fixed localisation error on vehicle sheets.
- [#2298] [#2296] Fixed a number of deprecation warnings.
- [#2295] Fixed being unable to open token config in v10.
- [#2297] Fixed custom SRD rules sheet in v10.
release-2.2.0
dnd5e 2.2.0
This version of the dnd5e system for Foundry Virtual Tabletop follows in the wake of its Version 11 release, unlocking some of the features available in that version. Despite this, it remains fully compatible with Foundry Virtual Tabletop Version 10, and contains many other additions, improvements, and bug fixes unrelated to the core software.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.2.0/system.json
Features
The biggest feature by far is the addition of the Item Choice Advancement type. Jeff has been steadily building on the Advancement framework, and this latest addition brings the much-anticipated ability for players to pick from set options when advancing their characters. The Advancement type offers lots of customisation, and I've included Jeff's video examples of the feature here that hopefully demonstrate some of its power.
Choosing from a list of options at level-up
item-choice-basic.webm
Dropping choices onto the Advancement
item-choice-drops.webm
Making additional choices on top of those from a previous level
item-choice-previous-choices.webm
Patch Notes
The full list of changes is included below:
⚠️ Breaking Changes
Abilities
The structure of DND5E.abilities
has changed, which each ability value an object now instead of a translation string. The object includes the abbreviation translation string, making DND5E.abilityAbbreviations
redundant.
Tools
In order to fix some long-standing issues such as the record of a character's expertise with tools disappearing if they ever delete the tool item, tool proficiencies have been moved into the main character's data. Proficiency and expertise can now be managed directly on the character sheet, and tool checks can now be rolled for things like vehicle proficiencies directly from the sheet without needing a corresponding item.
In order to accommodate this, traits.toolProf
has been moved under tools
, and several areas of the codebase have been refactored to share code between skills and tools.
Deprecated Methods & Properties Removed
dnd5e.entities
->dnd5e.documents
dnd5e.rollItemMacro
->dnd5e.documents.macro.rollItem
dnd5e.macros
->dnd5e.documents.macro
ActorSheet5e#getData
returnscontext.system
now instead ofcontext.data
.ItemSheet5e#getData
returnscontext.system
now instead ofcontext.data
.Advancement#data
has been rolled into the mainAdvancement
object, will all properties now existing at the top level.DND5E.skills
shim for its old format has been removed.DND5E.areaTargetTypes
shim for its old format has been removed.Actor5e#_computeArmorClass
->Actor5e#_prepareArmorClass
Actor5e#_computeEncumbrance
->Actor5e#_prepareEncumbrance
Actor5e#_computeInitiativeModifier
->Actor5e#_prepareInitiative
Actor5e#_computeSpellcastingProgression
->Actor5e#_prepareSpellcasting
Actor5e#_simplifyBonus
->dnd5e.utils.simplifyBonus
Compendium Content
- Added Forgotten Adventures token packs 42-45.
- Item Choice Advancements added to SRD classes.
- Minor data fixes.
Features
- [#1401] Added Item Choice Advancements.
- [#1258] Added "Until Dispelled" and "Until Dispelled or Triggered" spell durations.
- [#1858] Improved item sheet UX by conditionally showing/hiding fields as appropriate.
- [#1867] Expanded the size of the limited uses maximum field.
- [#1846] Allow ability score defaults to be configured.
- [#1848] Allow 'mental' and 'physical' ability score distinctions to be configured.
- [#774] Allow tool expertise to be configured on character sheets directly, and be rolled from the sheet.
- [#1438] Add 'mythic' action type.
- [#2209] Use item roll data rather than actor when computing recharges for an item.
Bug Fixes
- [#2124] Fixed bugs with dropping classes and subclasses onto class journal pages.
- [#2166] Fixed crewed/uncrewed toggle not working on vehicle sheets.
- [#2162] [#2185] Fixed sheet layout issues with very long class or background names.
- [#2175] Fixed max HP tooltip incorrectly claiming a max HP override was in place when it wasn't.
- [#2211] Fixed display issues with the class journal sheet editor.
- [#2231] Fixed class journal sheet not rendering if the class does not have a
HitPointsAdvancement
. - [#2176] Fixed the SRD compendium sheet not having a minimum width and height.
- [#2161] Fixed changes
DND5E.currencies
not being reversible.
Contributors
Many thanks to the following contributors in particular:
- Jeff 'Arbron' Hitchcock
- Righthandofvecna
- Zhell
... as well as all those who submitted bug reports and issues.
release-2.1.5
This release fixes a number of outstanding bugs and replaces the OGL with the CC-BY-4.0 license for SRD content.
Bug Fixes
- [#2114] Fix error when expanded items on actor sheet are deleted
- [#2124] Fix bug dropping classes onto class summary journal pages
- [#2132] Fix items to expanding multiple times on group sheet & not retaining expanded state
- [#2180] Fix issue preventing old AC and movement migrations from running
- [#2181] Fix generated spell scrolls missing spell descriptive text
- [#2205] Fix
renderSheet
not being respected when transforming linked actors
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.1.5/system.json
release-2.1.4
A small patch release to fix issues with localised character sheets. For the previous releases notes, see here, and for the full 2.1 release patch notes, please see here.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.1.4/system.json
release-2.1.3
While it is only a small version bump, this release contains some nice quality-of-life improvements around Advancements, as well as in other areas, and several bug fixes. For the full 2.1 release patch notes, please see here.
Features & Improvements
- [#244] Preserve the expanded/collapsed state of item descriptions during actor sheet re-rendering.
- [#2041] Mark fields as disabled on the actor sheet if they are modified by an Active Effect and cannot be edited.
- [#1564] Converted the armor bonus breakdown into a tooltip.
- [#2018] Switch from using HTML
title
attributes to using the core tooltip API. - [#1774] Automatically unapply Advancements when the Items containing them are deleted from an Actor.
- [#1771] Add the ability to copy Advancements by dragging-and-dropping them between Items.
- [#1465] Add the ability to drop an Item onto the Advancement tab of another Item to migrate the target's Advancements to those of the dropped Item.
- [#1605] Prepare scale values earlier so that they can be targeted by Active Effects.
Compendium Content
- [#2102] Use built-in weapon proficiency choices for Starter Heroes rather than the custom field.
- [#2089] Fix Action Surge and Second Wind having a recharge of 1.
- [#2082] Fix Cloak of Protection not granting a +1 bonus to Saving Throws.
Bug Fixes
- [#2045] Fix crew and passengers not being visible on vehicle sheets.
- [#2084] Fix some instances of spurious console warnings when certain items are updated.
- [#2066] Fix items being created with the wrong type when clicking '+ Add' on the actor sheet.
- [#2058] Fix being unable to input decimal values for movement speeds.
- [#2057] Fix being unable to modify movement speed units.
- [#2055] Fix spells not being converted into scrolls when dropped onto vehicle sheets.
- [#2080] Fix an extra '1' being added to certain formulae that contained parentheses before a dice term.
- [#2033] Fix parenthetical dice terms in situational bonuses not being appropriately doubled on critical hits.
- [#2064] Fix legacy Actors or Items missing most of their data after being imported.
- [#2075] Fix validation errors when attempting to polymorph an Actor.
- [#2061] Fix item level not being available in max uses & duration formulae.
- [#2053] Fix spell overrides not appearing on a sheet if the actor in question had no spell slot progression.
https://github.com/foundryvtt/dnd5e/releases/download/release-2.1.3/system.json
release-2.1.2
Another small release to fix some common data validation issues that users have encountered. For the full 2.1 release patch notes, please see here.
Bug Fixes
- [#2047] Fix group actor sheet having no minimum width or height.
- [#2039] Fix duplication translation keys in
en.json
. - [#2043] Provide a migration for worlds that had bad
ac.formula
data. - [#2040] Remove unused
hp.min
field.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.1.2/system.json
release-2.1.1
A small patch to fix an issue with the trait selector on character sheets. Full patch notes can be found here.
Installation: To manually install this release, please use the following manifest URL: https://github.com/foundryvtt/dnd5e/releases/download/release-2.1.1/system.json
release-2.1.0
dnd5e 2.1.0
This version of the dnd5e system for Foundry Virtual Tabletop includes a very long list of technical changes, improvements, bug fixes, and features. The most important change, from a technical standpoint, is the use of the core software's DataModel
API for all Actor and Item data. This enables more robust validation for your data to help prevent you from inadvertently using bad or incorrect data in your worlds, and makes the process of migrating it easier and more seamless. A special mention once again for Jeff 'Arbron' Hitchcock, who contributed the bulk of the DataModel
code to the system.
COMPATIBILITY WARNING: The version 2.1.0
release for the system ONLY SUPPORTS Foundry Virtual Tabletop version 10 (release) and greater. To use this new game system version you must also use Foundry VTT version 10. 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://github.com/foundryvtt/dnd5e/releases/download/release-2.1.0/system.json
Features
Though the largest changes were technical in nature, there were still plenty of features added in this version.
Group Actor
A new 'group' type actor has been added that can be used to represent a group of creatures as they travel together as part of a hexcrawl, a shared inventory of items, or just as a useful reference sheet for the whole party.
Class Summary Page
A new 'class' type journal page has been added which will show an automatically generated class advancement table based on a class and/or subclass' configured advancement data.
Initiative Rolls
Initiative rolls have been given a configuration menu to allow for special bonuses to initiative to be added. When rolling for initiative, players will now be prompted with a dialog similar to the ability check roll dialog, allowing them to input any situational modifiers, or allow them to roll with advantage or disadvantage.
HP Automation
A character's max HP can now be automatically calculated based on their hit point advancement data. Hit points have also been given a configuration menu, allowing you to override the calculated value, or apply a bonus hit point amount per level. New characters will have this automation enabled automatically, but existing characters will not be affected. In order to opt-into this automation on existing characters, open the HP configuration menu and delete the overridden value.
Transformation Options
Several new transformation options have been added when transforming one actor into another, including controls for active effect transference, and an 'appearance-only' transformation.
Patch Notes
The full list of changes is included below:
⚠️ Breaking Changes
DataModel
s
The DataModel
s in use in the dnd5e system offer much stricter validation. This has the unfortunate consequence of rendering some Actors or Items in existing worlds invalid, even though they might have been working fine before. We don't anticipate this will affect many worlds, only those with particularly old data but in order to prevent disruption, when your GM loads into their world for the first time in 2.1.0, if any validation errors are detected, the world will be marked as 'legacy', and switch to more permissive validation. New worlds, or worlds with no validation errors, will be able to make use of the stricter validation.
Note that in Foundry Virtual Tabletop version 11, this permissive validation mode will no longer be available, however version 11 will include better tools for locating and fixing validation errors in your worlds.
In order to accommodate changes introduced by the move to DataModel
s, the template data prepared by Actor and Item sheets has been adjusted. If you develop a module that relies on this data, be sure to check its new format and adjust your template code accordingly. Similarly, the return result of toObject(false)
differs from what downstream module code may have been used to, no longer containing any derived properties that do not exist as part of the DataModel
's schema. This is an area where we are considering making changes in the core software to address. For now, retrieving a full copy of an Actor or Item's derived data for mutation purposes, without affecting the original Actor or Item can be achieved by clone
ing the Actor or Item in question.
Price Data
Price data for Items has changed from a single value to an object with value
, and denomination
properties.
Targeting Data
How targeting data is represented in the system's configuration variables has changed. DND5E.rangeTypes
has been added. DND5E.areaTargetTypes
has been converted to have object values instead of strings.
Deprecated Methods & Classes Removed
SelectItemsPrompt
CONFIG.DND5E.classFeatures
- Non-namespaced
restCompleted
hook (usednd5e.restComplete
instead). Actor5e#addEmbeddedItems
Actor5e#getClassFeatures
Actor5e#loadClassFeatures
Compendium Content
- Added Forgotten Adventures token packs 37-41.
- A number of minor data adjustments to match the updated
DataModel
s and fix errors. - Extraneous derived data has been removed, significantly reducing the weight of the packs.
- Added new class summary journal page type capable of auto-generating its class summary table from advancement data.
- Added missing tables from the SRD5.1.
- Fixed the items and spells no longer being in alphabetical order.
Features
- [#1684] Allow access to count & dice size for single dice scale values.
- [#1316] Added an initiative configuration dialog and the ability to add situational modifiers and advantage or disadvantage when rolling initiative.
- [#1885] Centralised trait configuration, deprecating the old
TraitSelector
in favour of a new one, and adding a newTrait
module to handle logic around actor traits. - [#1997] Added
dnd5e.preRollInitiative
anddnd5e.rollInitiative
hooks. - [#1835] Implemented system
DataModel
s for Actors and Items. - [#866] Hit points calculation can now be fully automated and calculated based on a character's stored advancement. Migrated actors will not use this by default and must enable it by configuring their hit points and deleting the overridden value.
- [#1714] Allow use of roll data in NPC hit point formulae.
- [#1348] Feature Items now have a
type
andsubtype
field that can be configured. - [#1979] Added
attributes.spellmod
to actor roll data. - [#1970] Added a context menu to items on the actor sheet.
- [#1857] Removed the
none
option from various fields where it was redundant with the blank option. - [#1687] Improved conversion when switching between scale value types during scale value configuration.
- [#1686] Added a Challenge Rating scale value type.
- [#1505] Allow for customisation of dice sizes in scale value advancement.
- [#1716] Use
DataModel
for Advancement data. - [#1456] Rolling hit dice should now trigger scrolling text.
- [#1901] Attack rolls are now affected by the critical threshold of any consumed ammunition.
- [#1572] Removed unused
components.value
from spell Items. - [#1100] Added an 'appearance only' option when transforming Actors.
- [#1139] Added several options for configuring active effect transfer when transforming Actors.
- [#1391] Retain token display name and bar configurations when transforming Actors.
- [#1066] Propagate any triggering click event to
Item5e#use
. - [#1629] Attempting to delete an item from an Actor's sheet now prompts for confirmation.
- [#1506] Add a copy button to copy scale value identifiers to clipboard.
- [#1559] Added some missing
title
and tooltips. - [#2003] Implement a system for dynamically attaching art provided by modules to Actors in compendium packs. See the wiki for details.
- [#1935] Add the
group
actor that can represent several Actors with a combined HP, travel speed, and a shared inventory.
Bug Fixes
- [#1839] Fix providing extra
parts
toActor#rollAbility
exclusively using only thoseparts
. - [#1985] Fix upcasting a spell not using the correct
@item.level
if included in its attack bonus. - [#1239] Fix displaying 'consume resource' checkbox when rolling an item with both charges and ammunition.
- [#1238] Fix actor biographies and item descriptions not evaluating inline rolls with the correct dat.
- [#1958] Allow spells to have a blank school.
- [#1891] Fix the armour configuration dialog including shield bonus when configuring a flat or natural armour calculation.
- [#1817] Fix shorthand
dX
dice expressions not being appropriately doubled on criticals. - [#1680] Fix restoring a transformation resetting a token's elevation to 0.
- [#681] Fix apostrophes in image file names preventing them from displaying correctly in some contexts.
- [#1975] Fix error in base item determination preventing an item sheet from rendering.
- [#1934] Add
width
andheight
at...