Skip to content

Commit

Permalink
Implement various wiki changes for 4.1 release (#4659)
Browse files Browse the repository at this point in the history
  • Loading branch information
arbron authored Nov 8, 2024
1 parent bbcf059 commit aacb0a6
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 12 deletions.
2 changes: 1 addition & 1 deletion wiki/Active-Effect-Guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Up to date as of 3.2.0](https://img.shields.io/static/v1?label=dnd5e&message=3.2.0&color=informational)
![Up to date as of 4.1.0](https://img.shields.io/static/v1?label=dnd5e&message=4.1.0&color=informational)

This document only covers Active Effects available to the Core dnd5e System.

Expand Down
8 changes: 7 additions & 1 deletion wiki/Compendium-Browser.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Up to date as of 4.0.0](https://img.shields.io/static/v1?label=dnd5e&message=4.0.0&color=informational)
![Up to date as of 4.1.0](https://img.shields.io/static/v1?label=dnd5e&message=4.1.0&color=informational)

The compendium browser is a new application for finding content from across multiple compendiums using searching and filtering. The browser can be accessed using the "Open Compendium Browser" button at the top of the Compendium Packs sidebar tab.

Expand All @@ -16,6 +16,12 @@ The browser can also be activated from elsewhere in the system in locked mode. I

![Compendium Browser - Class Selection](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/compendium-browser/class-selection.jpg)

## Source Configuration

GMs have the option to modify what sources appear in the compendium browser, customizing which specific compendiums are offered by different modules. These options are available using the "Configure Sources" button in the system settings or the gear on the top right of the compendium browser itself.

![Compendium Browser - Configure Sources](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/compendium-browser/configure-sources.jpg)

## Module Support

The compendium browser will automatically pick up content from any enabled modules, displaying results to players so long as they are able to view a given compendium pack. There is no need for modules to do anything for their users to gain access to content through the compendium browser, but additional hints may be provided to aid in its functionality.
Expand Down
45 changes: 38 additions & 7 deletions wiki/Enchantment.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Up to date as of 4.0.0](https://img.shields.io/static/v1?label=dnd5e&message=4.0.0&color=informational)
![Up to date as of 4.1.0](https://img.shields.io/static/v1?label=dnd5e&message=4.1.0&color=informational)

Enchantments are a special type of Active Effect that makes changes on the item to which they are added, rather than the actor like normal Active Effects. They are configured in much the same way as normal Active Effects, but rely on different attribute keys that are documented below.

Expand Down Expand Up @@ -30,7 +30,7 @@ system.description.value

#### Changing the Name

You can reference the original name using a pair of curly brackets (`{}`) and the `override` change mode (e.g. `{}, +1` for a +1 weapon).
You can reference the original name using a pair of curly brackets (`{}`) and the `override` change mode (e.g. `{}, +1` for a +1 weapon would result in `Shortsword, +1`).

| Attribute Key | Change Mode | Effect Value | Roll Data? |
| ------------- | ----------- | ------------ | ---------- |
Expand All @@ -44,7 +44,7 @@ You can reference the original name using a pair of curly brackets (`{}`) and th

#### Changing the Description

You can reference the original description using a pair of curly brackets (`{}`) and the `override` change mode (e.g. `{} <p>Some more description</p>`).
You can reference the original description using a pair of curly brackets (`{}`) and the `override` change mode (e.g. `{} <p>Some more description</p>`) or use the `add` change mode to add to the end of the existing description. Note that any added description should be written using HTML, which can be copied from an existing item using the "Source HTML" button in the description editor.

| Attribute Key | Change Mode | Effect Value | Roll Data? |
| -------------------------- | ----------- | ------------ | ---------- |
Expand Down Expand Up @@ -89,7 +89,6 @@ The valid effect values depend on the item type, and in the case of consumables
>
> | Equipment Property | Abbreviation |
> | -------------------- | --------------------- |
> | Concentration | `concentration` |
> | Magical | `mgc` |
> | Stealth Disadvantage | `stealthDisadvantage` |
>
Expand All @@ -99,9 +98,8 @@ The valid effect values depend on the item type, and in the case of consumables
> <details>
> <summary>Tool Properties</summary>
>
> | Tool Property | Abbreviation |
> | Tool Property | Abbreviation |
> | -------------------- | --------------------- |
> | Concentration | `concentration` |
> | Magical | `mgc` |
>
> Source: `CONFIG.DND5E.validProperties.tool`
Expand All @@ -124,7 +122,6 @@ The valid effect values depend on the item type, and in the case of consumables
>
> | Scroll Property | Abbreviation |
> | --------------- | --------------- |
> | Concentration | `concentration` |
> | Magical | `mgc` |
> | Ritual | `ritual` |
> | Somatic | `somatic` |
Expand Down Expand Up @@ -383,3 +380,37 @@ Since damage is both a roll formula and damage type, you need to include both wh
>
> Source: `CONFIG.DND5E.damageTypes`
> </details>
## Activity Changes

Enchantments can also target changes to item activities based on their type. This is done using the format `activities[<type>].<change path>`.

### Attack Activity Examples

#### Changing the Attack Ability

| Attribute Key | Change Mode | Effect Value | Roll Data? |
| ----------------------------------- | ----------- | ------------ | ---------- |
| `activities[attack].attack.ability` | Override | `[string]` | No |

#### Setting Flat To Hit

| Attribute Key | Change Mode | Effect Value | Roll Data? |
| --------------------------------- | ----------- | ------------ | ---------- |
| `activities[attack].attack.bonus` | Override | `[formula]` | Yes |
| `activities[attack].attack.flat` | Override | `true | No |

#### Lowering the Critical Threshold

| Attribute Key | Change Mode | Effect Value | Roll Data? |
| ---------------------------------------------- | ----------- | ------------ | ---------- |
| `activities[attack].attack.critical.threshold` | Downgrade | `[number]` | No |

### Save Activity Examples

#### Setting a Specific Save DC

| Attribute Key | Change Mode | Effect Value | Roll Data? |
| -------------------------------------- | ----------- | ------------ | ---------- |
| `activities[save].save.dc.calculation` | Override | | No |
| `activities[save].save.dc.formula` | Override | `[formula]` | Yes |
27 changes: 24 additions & 3 deletions wiki/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Frequently Asked Questions

## How to Wildshape
## How to Wildshape
To use the built-in Wild Shape feature, open the character sheet of the actor that you would like to transform, then drag the actor they should transform into onto that character sheet (e.g. open the Druid's character sheet and drag the Wolf actor onto it). In the resulting pop-up dialog, click the Wild Shape button. This must be done by the Gamemaster, unless the System Setting "Allow Polymorphing" is enabled, the player must also have "Observer" access to the actors they can transform into and the permissions to "Create New Actors" and "Create New Tokens". To exit Wild Shape, open the actor sheet and click the Restore Transformation button in the sheet's title bar. Because Players cannot have permissions to delete actors, if used by a player the transformed actor will remain, if used by the Gamemaster the transformed actor will be deleted.

Unsoluble has a great video guide available here https://www.youtube.com/watch?v=YjcugG_akk4
Expand All @@ -13,8 +13,29 @@ Unsoluble has a great video guide available here https://www.youtube.com/watch?v
## How to create Spell Scrolls
There are two ways to create a Spell Scroll from a spell, either by using the Right Click context menu and using the "Create Scroll" option or by dragging a Spell onto an Actor's Inventory tab. A dialog will be displayed with options as to what description should be shown and what levels the spell should be created at (defaults to the spell's base level). A reference to the spell scroll rules or their entire text from the SRD rules will be added to the spell's description.

## What are the plans for the upcoming 2024 rulebook releases?
In September Foundry will be publishing an official premium module for the updated Player's Handbook. Until the revised SRD is published in 2025 this will be the only way to access pre-made content from the new rulebooks in the system. Once the revised SRD is made available the content will be added to the system in the same way the SRD 5.1 content is currently available.
## What are the plans for the 2024 rulebook releases?
Foundry publishes official premium modules for the updated [Player's Handbook](http://foundryvtt.com/packages/dnd-players-handbook) and [Dungeon Master's Guide](https://foundryvtt.com/packages/dnd-dungeon-masters-guide), and the upcoming [Monster Manual](https://foundryvtt.com/packages/dnd-monster-manual) is available for pre-order. Until the revised SRD is published in 2025 this will be the only way to access pre-made content from the new rulebooks in the system. Once the revised SRD is made available, the content will be added to the system in the same way the SRD 5.1 content is currently available.

> [!IMPORTANT]
> The current Dungeons & Dragons 5th Edition system will remain compatible with all content based on both the 2014 and the 2024 rulebook update.
For the places where the 2024 rules and 2014 rules are mutually exclusive, there is a system setting that allows for toggling between them:

![Rules Version Setting](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/settings/rules-version.jpg)

This rule affects a number of things in the system including:
- DC 30 cap on saving throws to maintain concentration
- Exhaustion effects
- Recovered hit dice on a Long Rest
- Alert adding to initiative rolls
- Jack of All Trades applying to initiative
- Remarkable Athlete effect
- Former Half Progression for spell slots that rounds down
- Initial DC & attack to hit for player-crafted spell scrolls
- Language organization & presence of "Common Sign Language"
- Wild Shape transformation preset
- Several wording changes
- Armor Proficiency -> Armor Training
- Exotic Languages -> Rare Languages
- Race -> Species
- Radius -> Emmanation
Binary file modified wiki/images/compendium-browser/advanced-mode.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified wiki/images/compendium-browser/class-selection.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified wiki/images/compendium-browser/standard-mode.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/settings/rules-version.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aacb0a6

Please sign in to comment.