📜
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
  • Base Schema
  • sourceLink
  • Example Usage
  1. Document Schema

The document source schema

All documents in a compendium can include an optional source property. This is used to indicate where the content originally comes from. Only the title key is required, but you can optionally provide links and publisher information.

Base Schema

Property
Required
Type
Description

title

true

string

The name of the document source, such as a book, document, or webpage.

link

false

sourceLink

A link to the original content. This could either be a direct source or a sales page.

publisher

false

string

The name of the content's publisher.

sourceLink

Property
Required
Type
Description

url

true

string

A URL for the content source.

affiliate

false

boolean

Indicates whether the link is an affiliate link.

Example Usage

"source": {
    "title": "MoAR: Complete",
    "link": {
        "url": "https://bit.ly/4b7Fsyi",
        "affiliate": true
    },
    "publisher": "Purple Martin Games"
}
PreviousThe base document schemaNextNimble v2 schemas

Last updated 5 months ago