diff --git a/wiki/Compendium-Browser.md b/wiki/Compendium-Browser.md new file mode 100644 index 0000000000..a26168e241 --- /dev/null +++ b/wiki/Compendium-Browser.md @@ -0,0 +1,43 @@ +![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. + +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. + +![Compendium Browser - Standard Mode](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/compendium-browser/standard-mode.jpg) + +## Modes + +The compendium browser has two modes: standard and advanced. These modes can be changed using a toggle at the top of the window. In standard mode (visible above), the tabs represent specific useful categories for searching, such as classes, subclasses, spells, feats, and monsters. + +In advanced mode (seen below), the tabs are split into actor and item lists and by default the browser will display all actors or items. On each tab additional filtering can be used to narrow in on a specific set of types. + +![Compendium Browser - Advanced Mode](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/compendium-browser/advanced-mode.jpg) + +The browser can also be activated from elsewhere in the system in locked mode. In this case the browser will be locked to a specific item type and potentially additional filters could be automatically applied. This mode is used for places where a specific choice must be made, such as choosing a class for your character or selecting a creature to summon. + +![Compendium Browser - Class Selection](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/compendium-browser/class-selection.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. + +When searching for content the compendium browser will use type hints on compendium pack definitions in the module manifest if provided to determine what kind of content is included in the compendium. If no hints are provided, the compendium will always be scanned, but if specific types are specified then it might be skipped if the user isn't searching for those types, potentially improving performance. + +```json +{ + "name": "spells", + "label": "Spells (SRD)", + "system": "dnd5e", + "path": "packs/spells", + "type": "Item", + "flags": { + "dnd5e": { + "types": ["spell"] + } + } +} +``` + +The flag `flags.dnd5e.types` on a compendium pack in `module.json` should contain an array with the specific item or actor types in that compendium. Providing an empty array here will prevent the browser from searching that pack. diff --git a/wiki/Home.md b/wiki/Home.md index 1d84b0cdd5..34ec5af746 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -3,7 +3,6 @@ - [Active Effects Guide](Active-Effect-Guide.md) - [Advancement Overview](Advancement.md) - [Advancement User Guide](Advancement-User-Guide.md) - - [Custom Class Example](Custom-Class-Advancement.md) - Advancement Types - [Advancement Type: Ability Score Improvement](Advancement-Type-Ability-Score-Improvement.md) - [Advancement Type: Hit Points](Advancement-Type-Hit-Points.md) @@ -12,15 +11,18 @@ - [Advancement Type: Scale Value](Advancement-Type-Scale-Value.md) - [Advancement Type: Size](Advancement-Type-Size.md) - [Advancement Type: Trait](Advancement-Type-Trait.md) -- Tutorials - - [Custom Races](Custom-Race-Tutorial.md) - [Awards](Awards.md) +- [Compendium Browser](Compendium-Browser.md) - [Dynamic Module Art](Dynamic-Module-Art.md) - [Enchantment](Enchantment.md) - [Enrichers](Enrichers.md) - [Frequently Asked Questions](FAQ.md) - [Hooks](Hooks.md) - [Roll Formulas](Roll-Formulas.md) -- [Modifying Your Game with World Scripts](Modifying-Your-Game-with-Scripts.md) - [Summoning](Summoning.md) -- [Contributing to the Wiki](Contributing-to-the-Wiki.md) +- Tutorials + - [Custom Classes](Custom-Class-Advancement.md) + - [Custom Races](Custom-Race-Tutorial.md) + - [Modifying Your Game with World Scripts](Modifying-Your-Game-with-Scripts.md) + +This wiki accepts community updates. Check out the [Contributing to the Wiki](Contributing-to-the-Wiki.md) guide for information on how to make a change. diff --git a/wiki/images/compendium-browser/advanced-mode.jpg b/wiki/images/compendium-browser/advanced-mode.jpg new file mode 100644 index 0000000000..c9b05b631e Binary files /dev/null and b/wiki/images/compendium-browser/advanced-mode.jpg differ diff --git a/wiki/images/compendium-browser/class-selection.jpg b/wiki/images/compendium-browser/class-selection.jpg new file mode 100644 index 0000000000..f3721ca09e Binary files /dev/null and b/wiki/images/compendium-browser/class-selection.jpg differ diff --git a/wiki/images/compendium-browser/standard-mode.jpg b/wiki/images/compendium-browser/standard-mode.jpg new file mode 100644 index 0000000000..51db98cb1b Binary files /dev/null and b/wiki/images/compendium-browser/standard-mode.jpg differ