📜
OBR Compendium Browser Documentation
  • OBR Compendium Browser
  • Getting Started
    • Quickstart
  • Content
    • Preconfigured content
      • Free packs
      • Purchasable packs
    • Custom content
  • Document Schema
    • The compendium schema
    • The base document schema
    • The document source schema
    • Nimble v2 schemas
      • nimblev2-boon
      • nimblev2-condition
      • nimblev2-feature
      • nimblev2-minion
      • nimblev2-monster
      • nimblev2-object
      • nimblev2-solo-monster
      • nimblev2-spell
  • Support
    • Funding Links
Powered by GitBook
On this page
  1. Document Schema

The base document schema

PreviousThe compendium schemaNextThe document source schema

Last updated 5 months ago

All documents share a base set of properties, some of which are optional. Together, these make up the baseDocumentSchema.

Base Schema

Property
Required
Type
Description

name

true

string

The name to present in the browser for this document.

type

true

string

The name of the schema used for this document.

id

false

string

See notes on .

source

false

Source information for the document.

documentSource
Document IDs