Export to compendium
export-to-compendiumCopy Foundry VTT world documents into a compendium to archive finished material. Select by name, id, or folder; existing entries are overwritten, locked compendiums can be temporarily unlocked.
Instructions
Copy documents from the world into a compendium, to archive finished material. Select by name or id, or by the world folder they sit in; without either, everything of that type is copied. Ids are kept, so a document already in the compendium is overwritten instead of duplicated. A locked compendium is refused unless unlockIfNeeded is set; then the lock is lifted for this operation only and set again afterwards. The answer lists new, overwritten, skipped and, marked CAUTION, lost entries.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"packId": "<packId>",
"documentType": "<documentType>"
},
"name": "export-to-compendium"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| names | No | World documents to save, by whole name (case does not matter) or by id. Leave out to save every document of the type. | |
| packId | Yes | Id of the compendium to save into | |
| folderName | No | Save only documents lying directly in the world folder with exactly this name | |
| documentType | Yes | Type of the world documents: JournalEntry, Scene, Actor, RollTable, Playlist, Item or Macro | |
| unlockIfNeeded | No | Lift a lock for this one operation; it is set again afterwards |