Homebrew lexicon

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

LEXICON


A

[abbreviation]] - An Key type field for homebrew
Abbreviated form of the source, to display on the site.

AUN in the example is short for A unique Name; you'll want to use a one that matches your Sources name

Action - An Object type for homebrew
Reference for the mechanical economy of a creature's combat turn.
{@action <name_of_action> | <json_source> | <optional_text_information>}

Example:
  {@action Tumble|DMG}
  {@action Tumble|DMG| acrobatically avoid }


Adventure - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.
alAveragePlayerLevel - The Adventurers League suggested level of the Adventure
alLength - The rated length of the Adventure
alId - The Adventures League's ID of the Adventure
authors - A list of authors who created the homebrew source.


B

Background - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.
Book - An Object type for homebrew
Books are like Compendiums but include more information, 'fluff' and the like.
Bestiary - See Creature


[Homebrew:_Boon |Boon] - An Object type for homebrew
Special rewards from Extraordinarily powerful creatures for a character's service.


C

Class - An Object type for homebrew
Character class information.


Class Features - An Object type for homebrew
Features such as Invocations, Fightstyles, or the like.


Collection - An Organization Category
The organizational name for a homebrew that contains varied types of Objects. Such as Book with and adventure; Creatures; items; Variant Rules and Hazards.
color - HTML hex color code this source should use when displayed in lists, e.g. 'ff00ff'. It defaults to white if not given.
Conditions - An Object type for homebrew
Conditions and their effects
convertedBy - An optional list of people who contributed to converting the source to 5etools format.
authors - A list of authors who created the homebrew source.


Creature - An Object type for homebrew
Bestiary - Monsters, NPCs and the like.


Cult - An Object type for homebrew
A shadowy organization or guild, usually with a religious cohessive element
D

dependencies - [array] which defines the other homebrew jsons the homebrew relies upon.
Deity - An Object type for homebrew
The gods of the worlds of D&D through various campaigns.


Disease - An Object type for homebrew
Diseases and illnesses.


E

"entries" — the text of the action. Note that you can write several strings ("") separated with a comma.
F

Feats - An Object type for homebrew
Custom Feats


@filter - Tag for Entries to pull
{@filter your text here|spells|duration=[&10 minutes;&24+ hours]}
fromVariant -
full - Full title of the source, to display on the site.
G


H

Hazard - An Object type for homebrew
These are most often enviromental hazards and climate issues, not as simple as traps but still worthwhile.


I

Item - An Object type for homebrew
Items are the most complicated. Magical and Mundane, Trade goods, Kits, Mounts etc etc etc.


J

json - A key type for homebrew (string)
An identifying string, as seen in the JSON in "source" fields.
FOUND IN: _Meta Object


K


L

Language - An Object type for homebrew
Sets of written and spoken languages, who speaks them, what font they use, etc.


M


Magic Variant - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


Make Homebrew's Monster Traits - An Object type for homebrew
Extensible Sets of Monster trains and feature usable by the Homebrew builder.


Meta tag - An REQUIRED Object type that starts EVERY homebrew
This is required for each JSON


Monster - An Object type for homebrew
Bestiary - Monsters, NPCs and the like
N

Homebrew:_Adventure '''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


O

Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


P

"page" — the page number of the document the information appears. If there's no page, leave it at 0.
(Its a required field)
Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


Q


R

Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


S

Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.
"sense" — Object keys are Sense names, which can referenced using {@sense <key>} (case insensitive).
"skill" — Object keys are Skill names, which can referenced using {@skill <key>} (case sensitive).
"source" — make sure it is the same as the "json" key in the _meta.
"source" — make sure it is the same as the "json" key in the _meta.
"spellDistanceUnits" — values should be objects with optional "singular" (singular form of the unit, e.g. "foot" for the singular of "feet"--if unspecified, a trailing "s" is removed from the plural version, if it exists, and the result is used as the singular form) and "feetPerUnit" (e.g. for a "yards" custom unit, this would be `3`, as there are three feet in a yard) key/values.
"spellSchool" — Object names are spell school abbreviations; values should be objects with "full" (used in the main entry, e.g. "Evocation") and "short" (used in the list view, e.g. "Evoc") key/values.
Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.
T

targetSchema - The target schema version in 5etools, e.g. current schema version is v1.1.0.
Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.
"time" — here you can describe how long the action takes. "unit" can be "action", "bonus" or "reaction". "number" is the amount of units it takes. If it does not apply to the action, you can delete this block.


U

url - A direct link to the source, if available in web form or on a store.


V

version - The source version.


Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


Homebrew:_Adventure'''Adventure''' - An Object type for homebrew
A playable adventure. Should include maps, event descriptions, Monsters, Items etc.


W


X


Y


Z