My Shared Compendia
A Foundry VTT module to share Data between worlds via compendia.
Installation
-
- Go to the Add-on Modules tab within the Foundry VTT Configuration and Setup page.
- Click the
Install Modulebutton. - Paste the Module's Manifest URL into the
Manifest URLfield. - Click the
Installbutton.
WARNING: If you update this module, Foundry VTT will erase your compendia.
Preventing Module Update
- Option 1 (easier): Locking your module:
- Go to the Add-on Modules tab within the Foundry VTT Configuration and Setup page.
- Find this module (My Shared Compendia) in the list, and click the padlock icon.
- Unlocked:
- Locked:
- Unlocked:
- Option 2: Updating your
module.jsonfile:- Go to the Module's installation folder within foundry (
~/Data/modules/My Shared Compendia) and update themodule.jsonfile. - Remove lines 68-69 (
downloadandmanifest) and save the file. - Restart Foundry to reload the module.
- Go to the Module's installation folder within foundry (
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 12 Default compendia:
Actors (shared)(Actor)Classes (shared)(Item)Feats (shared)(Item)Items (shared)(Item)Journal Entries (shared)(JournalEntry)Macros (shared)(Macro)Monsters (shared)(Actor)Playlists (shared)(Playlist)Roll Tables (shared)(RollTable)Scenes (shared)(Scene)Spells (shared)(Item)Subclasses (shared)(Item)
Customize
To change the default setup, edit the module.json file. All compendia are defined within the "packs" attribute beginning with line 10.
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
DnD5e Game System is required: The Game System adds some SRD Compendia. Using Compendium Folders is highly recommended.
Credits
Credit for the cleaner version goes to npiani. Process explained by /u/solfolango on /r/Foundry VTT.