Skip to content
This repository has been archived by the owner on Jul 21, 2023. It is now read-only.

Latest commit

 

History

History
91 lines (71 loc) · 3.56 KB

README.md

File metadata and controls

91 lines (71 loc) · 3.56 KB

My Shared Compendia

A Foundry VTT module to share Data between worlds via compendia.

Installation

  1. Go to the Add-on Modules tab within the FoundryVTT Configuration and Setup page.
  2. Click the Install Module button.
  3. Paste the Module's Manifest URL into the Manifest URL field.
  4. Click the Install button.
WARNING: If you update this module, FoundryVTT will erase your compendia.

Preventing Module Update

  • Option 1 (easier): Locking your module:
    1. Go to the Add-on Modules tab within the FoundryVTT Configuration and Setup page.
    2. Find this module (My Shared Compendia) in the list, and click the padlock icon.
      • Unlocked:
        unlocked-module
      • Locked:
        locked-module
  • Option 2: Updating your module.json file:
    1. Go to the Module's installation folder within foundry (~/Data/modules/My Shared Compendia) and update the module.json file.
    2. Remove lines 68-69 (download and manifest) and save the file.
    3. Restart Foundry to reload the module.

Unlock your Compendia!

Remember that you need to unlock your compendia to be able to add things to them.

Default Setup

This module comes with 13 Default compendia:

Customize

To change the default setup, edit the module.json file. All compendia are defined within the "packs" attribute beginning with line 18.

For example:

{
  "packs": [
    {
      "name": "monsters",
      "system": "dnd5e",
      "label": "Monsters",
      "path": "./packs/monsters.db",
      "module": "my-shared-compendia",
      "type": "Actor"
    },
    {
      "name": "my-custom-items",
      "system": "dnd5e",
      "label": "My Custom Items",
      "path": "./packs/items.db",
      "module": "my-shared-compendia",
      "type": "Item"
    }
  ]
}

Note: There are no compendium Types for Classes, Feats, and Features in Foundry, so the Item type is generally used for these.

Dependencies

Credits

Credit for the cleaner version goes to npiani. Process explained by /u/solfolango on /r/FoundryVTT.