Skip to content

Commit

Permalink
Update AE Guide, Enrichers, & Roll Formulas, document Module Registra…
Browse files Browse the repository at this point in the history
…tion (#4136)
  • Loading branch information
arbron authored Sep 13, 2024
1 parent 1c05a71 commit db6560b
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 8 deletions.
1 change: 1 addition & 0 deletions wiki/Active-Effect-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ system.attributes.ac.bonus
calc
cover
flat
min
```

### Add a Bonus to AC
Expand Down
5 changes: 1 addition & 4 deletions wiki/Compendium-Browser.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
![Up to date as of 3.3.0](https://img.shields.io/static/v1?label=dnd5e&message=3.3.0&color=informational)

> [!IMPORTANT]
> The compendium browser takes advantage of new features introduced in Foundry V12 and only works in that version or later. None of the features described on this page will be available in Foundry V11.
![Up to date as of 4.0.0](https://img.shields.io/static/v1?label=dnd5e&message=4.0.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 Down
10 changes: 8 additions & 2 deletions wiki/Enrichers.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The `[[/check]]`, `[[/skill]]`, `[[/tool]]` starting terms are all interchangeab

For skill checks, the ability is optional. If one is provided then the person rolling have that ability selected by default even if it isn't the default on their sheet. Otherwise they will use whatever ability is set for that skill on their character sheet.

For tool checks, the ability is required. A check like `[[/tool thief]]` will not parse because the ability must be explicitly set like `[[/tool thief dex]]`. A list of the tool ids to use for this enricher is provided below.
For tool checks, the ability is required. A check like `[[/tool thief]]` will not parse because the ability must be explicitly set like `[[/tool thief dex]]`. A list of the tool ids to use for this enricher is provided below.

> <details>
> <summary>Tool Ids</summary>
Expand Down Expand Up @@ -99,6 +99,10 @@ Item enrichers allow you to use an item from an enriched link. There are several

This functions similarly to a system macro, as if you had dragged that item to the macro hotbar. When clicked, it will check for a selected token, or your assigned actor. If the token or actor has an item of a matching name, it will be used, otherwise a warning will be displayed.

**By Item & Activity Name**: `[[/item Bite activity=Poison]]`

Using the item name without an activity will cause the activity selection dialog to open if more than one activity is present. To trigger a specific activity on the item the activity name can be included. The activity name must be proceeded by `activity=`, and it must be wrapped in quotes if there is a space in the name (e.g. `[[/item Tentacles activity="Escape Tentacles"]]`).

**By UUID**: `[[/item Actor.p26xCjCCTQm5fRN3.Item.amUUCouL69OK1GZU]]`

A UUID contains references to an Actor and an Item it owns. When clicked, the enricher will find the specified Actor and use the specified Item.
Expand All @@ -107,6 +111,8 @@ A UUID contains references to an Actor and an Item it owns. When clicked, the en

A Relative ID can contain a reference to an owned Item either by an ID, or a relative UUID (note the preceding `.`). When clicked, the enricher will use its location (either in an Actor Sheet, Item Sheet, or Chat Card) to determine the Token or Actor that owns that card or sheet in order to use the specified item from that owner.

The activity name can also be used when referring to an item using its ID in the same manner as above with item name.

![Item Enricher](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/enricher-item.png)

## Lookup Enrichers
Expand Down Expand Up @@ -289,5 +295,5 @@ Using the enricher is very simple, simply type `&Reference` with the name of the
> <summary>Other Rules (selected)</summary>
>
> <p>Inspiration, Carrying Capacity, Encumbrance, Hiding, Passive Perception, Falling, Suffocating, Lightly Obscured, Heavily Obscured, Bright Light, Dim Light, Darkness, Blindsight, Darkvision, Truesight, Surprise, Difficult Terrain, Size, Grappling, Shoving, Half Cover, Three-Quarters Cover, Total Cover, Instant Death, Death Saving Throws, Underwater Combat, Attunement, Telepathy</p>
>
>
> Source: `CONFIG.DND5E.rules`
1 change: 1 addition & 0 deletions wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
- [Frequently Asked Questions](FAQ.md)
- [Hooks](Hooks.md)
- [Journal Pages](Journal-Pages.md)
- [Module Registration](Module-Registration.md)
- [Roll Formulas](Roll-Formulas.md)
- [System HTML](System-HTML.md)
- Tutorials
Expand Down
48 changes: 48 additions & 0 deletions wiki/Module-Registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
![Up to date as of 4.0.0](https://img.shields.io/static/v1?label=dnd5e&message=4.0.0&color=informational)

The system includes a number of features allowing modules and worlds to register information for the system directly in their manifests, rather than requiring separate scripts.

## Compendium Types

Compendiums can contain flags indicating what types of items or actors they contain. This is used to aid the Compendium Browser in quickly searching for content. More information about how this is set up can be found on the [Compendium Browser guide](Compendium-Browser.md#module-support).

## Source Books

Source books can be registered in a manifest and the system will automatically merge that data into `CONFIG.DND5E.sourceBooks` to be used in the source system:

```json
{
"flags": {
"dnd5e": {
"sourceBooks": {
"TCoE": "TCOE.Title"
}
}
}
}
```

Registering source books in the manifest versus in code has an advantage. If only a single source book is registered in a manifest, then the system can infer that source book for any content in that module's compendium, removing the need to specify the source book on each individual document.

## Spell Lists

Spell list journal entry pages can be registered in the manifest flags allowing the system to load these automatically and populate the shared spell lists available in the Compendium Browser and powering other features:

```json
{
"flags": {
"dnd5e": {
"spellLists": [
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.ziBzRlrpBm1KVV0j",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.cuG9d7J9fQH9InYT",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.MWiN7ILEO0Vd3zAZ",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.FhucONA0yRZQjMmb",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.sANq9JMycfSq3A5d",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.PVgly1xB2S2I8GLQ",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.mx4TsSbBIAaAkhQ7",
"Compendium.dnd5e.rules.JournalEntry.QvPDSUsAiEn3hD8s.JournalEntryPage.k7Rs5EyXeA0SFTXD"
]
}
}
}
```
8 changes: 6 additions & 2 deletions wiki/Roll-Formulas.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,9 +308,13 @@

## Item Properties

Items have roll data same as actors, but only while said item is owned by an actor (i.e., is placed on their sheet). The roll data of item is an extension of the actor's roll data, adding `@item` as an additional property.
Items have roll data same as actors, but only while said item is owned by an actor (i.e., is placed on their sheet). The roll data of item is an extension of the actor's roll data, adding `@scaling` & `@item` as additional properties.

The most common properties are:
`@scaling` - Current scaling of an activity when used (so a 3rd level spell cast at 3rd level would be `1`).

`@scaling.increase` - Scaling steps above the baseline (so a 3rd level spell cast at 3rd level would be `0`).

The most common `@item` properties are:

`@item.uses.value` - The current Limited Uses available on the item.

Expand Down

0 comments on commit db6560b

Please sign in to comment.