📜
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
  • nimblev2SpellDescription
  • nimblev2SpellSchool
  • Example Usage
  1. Document Schema
  2. Nimble v2 schemas

nimblev2-spell

Base Schema

Property
Required
Type
Description

description

true

An object containing three description keys. Only the baseEffect key is required. The upcastEffect key is only used for spells of tier 1 or greater.

castingTime

false

string

How long it takes to cast the spell.

classes

false

string[]

If a spell is limited to certain classes, provide a list here.

duration

false

string

A string indicating how long a spell's effects last. For instantaneous effects, this key can be ignored.

requiresConcentration

false

boolean

Indicated whether the spell requires concentration to maintain.

school

false

Which of the 6 spell schools the spell belongs to.

tier

false

number

A number from 0-9 representing the tier of the spell. A tier of 0 indicates a cantrip.

utility

false

boolean

Indicates whether the spell is a utility spell.

nimblev2SpellDescription

Each of the description sub-keys accept HTML in string format.

Property
Required
Type
Description

baseEffect

true

string

The basic effect of the spell cast at its lowest level.

higherLevelEffect

false

string

A description of how to modify the spell's effects for higher level characters.

upcastEffect

false

string

A description of how to modify the spell's effects when it cast with additional mana.

nimblev2SpellSchool

Type

"fire" | "ice" | "lightning" | "necrotic" | "radiant" | "wind"

Example Usage

{
    "name": "Dread Visage",
    "type": "nimblev2-spell",
    "castingTime": "2 Actions",
    "school": "necrotic",
    "tier": 4,
    "description": {
        "baseEffect": "Summon a 5d12 Greater Shadow minion (max 1) adjacent to you. When it dies, it explodes into 5 shadow minions (see Summon Shadow). Place them anywhere within 8 spaces.",
        "upcastEffect": "+1d12 damage, +1 shadow minion on explosion."
    }
}

Previousnimblev2-solo-monsterNextFunding Links

Last updated 2 months ago

nimblev2SpellDescription
nimblev2SpellSchool