Module Registration - foundryvtt/dnd5e GitHub Wiki

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.

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:

{
  "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:

{
  "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"
      ]
    }
  }
}