The compendium schema

Each compendium is represented by a single JSON document that can be loaded into the OBR Compendium Browser. It contains several pieces of metadata, like the compendium name and version, and includes an array of documents that each align to a valid document schema.

Note that the documents included in a compendium need not all user the same document schema. It is perfectly possible to create a compendium that includes spells, monsters, magic items, and so on.

Base Schema

Property	Required	Type	Description
documents	true	document[]	A list of documents included in the pack, each of which must match a valid document schema.
id	true	string	A unique identifier for the pack.
name	true	string	A human readable name for the pack.
version	false	string	An optional SemVer version number.

Example Usage

{
    "name": "My Compendium Pack",
    "id": "my-compendium-pack",
    "version": "1.0.0",
    "documents": []
}