Compendium Packs exist to reduce the strain on worlds that have been running for a long period of time. This includes situations where a world has accrued a large number of actors, items or scenes that, while not active, should not be deleted. Compendium Packs should be used to help you keep your world organized and reduce clutter.
Compendium packs are also used by modules to store large amounts of content to be unpacked and added to an existing game world, such as part of a premium or exclusive content pack.
Each Compendium can only contain one type of document: Actors, Items, Journal Entries, Macro Commands, Playlists, Rollable Tables or Scenes. Data contained in compendium packs are not loaded until needed, reducing the amount of data that a particular user must load when first joining a game.
Creating and Using Compendium Packs
A Compendium can be easily created in any World. First, navigate to the Compendiums Sidebar Tab, and then click the "Create Compendium" button. Enter the name of the Compendium (for example "Player Characters") and choose the type of document that will be contained in from the Document Type dropdown. After your Compendium has been created, clicking upon the Compendium name in the Sidebar will open a new window that will allow you to drag and drop from a Sidebar Tab into the Compendium.
Compendium Packs and their contents are automatically sorted alphabetically.
You can also export whole folders to compendiums by right clicking the folder and clicking the "Export to Compendium" option. This then gives you the ability to choose the destination pack (the compendium you want to export the folder's entities to), and if you want to overwrite existing entries with the same names. If the "Merge by name?" option is toggled off, then new copies of similar entities will be added. This is useful for storing multiple versions of the same document in a compendium.
You can only export folders to compendium packs which are unlocked. To lock and unlock a compendium, go to the Compendium Packs tab, right click a compendium, and choose the "Toggle Edit Lock" option. This will lock or unlock the chosen compendium. Note that you will receive a warning and be asked to confirm your choice to unlock packages that are included in game systems and modules, but not within your own worlds.
- Do I need a Compendium?
- Storing unused Entities in a Compendium greatly reduces the time it takes to load your world. Even though each Actor, Item, or other document may be small, as their numbers start to rise into the hundreds the amount of data that gets transferred to each of your players when they join can cause your world to slow down over time. It is a best to practice good organization.
- Can I edit a Compendium?
- Once content has been added to a compendium it cannot be directly edited. However, in the forthcoming 0.8.x series of updates it will become possible to directly edit documents contained in an unlocked compendium. Until the 0.8.x series is officially released you must import content, edit it locally, and re-export it to the compendium to make changes.
Importing Compendium Content
If you would like to import all of the content in a compendium pack you can do so by right-clicking the pack in the Compendium sidebar then selecting the "Import All Content" option. This will open a dialog allowing you to change the name of the folder which the compendium pack's content should be imported into. It will use the compendium's name if you choose not to edit the name, or if you leave the field blank.
Once content has been imported into a game world it becomes a localized part of that world, and any changes made to the documents will not be reflected in the compendium unless you also export the content back to the compendium, or create a new compendium with the changed documents.
Exporting Compendium Packs
Compendiums are limited to specific game worlds by default, but it is possible to move them to new worlds or create modules which contain compendiums for use in other worlds. To learn how to do this, refer to the Module Packaging Guide.