Interface PackageCompendiumData

A file path to a banner image that will be used in the Compendium sidebar. This should be hosted within your package, e.g. modules/my-module/assets/banners/bestiary.webp. The dimensions are 290 x 70; you can either have each be an individual landscape or slice them up to form a composite with your other compendiums, but keep in mind that users can reorder compendium packs as well as filter them to break up the composite.

The human-readable compendium name

The canonical compendium name. This should contain no spaces or special characters

The local relative path to the compendium source directory. The filename should match the name attribute

Denote that this compendium pack requires a specific game system to function properly. Required for "Actor" and "Item" packs, but even others should keep in mind that system specific features and subtypes (e.g. JournalEntryPage) may present limitations.

The specific document type that is contained within this compendium pack