Difference between revisions of "Homebrew"

From 5etools Community Wiki
Jump to: navigation, search
m (Section Tags)
m (Section Tags)
Line 132: Line 132:
|[[https://raw.githubusercontent.com/TheGiddyLimit/TheGiddyLimit.github.io/master/test/schema/deities.json 📑]]
|[[https://raw.githubusercontent.com/TheGiddyLimit/TheGiddyLimit.github.io/master/test/schema/deities.json 📑]]
| The gods of the worlds of D&D through various campaigns.
| The gods of the worlds of D&D through various campaigns.

Revision as of 19:53, 23 August 2019

This is a work in progress, 

How to create a Homebrew JSON for 5eTools

This is being developed so it will be a bit rough as we develop better content and get feedback.

There are some specific Tools to make Homebrew for the 5eTools.

Site Tools

Homebrew Builder
Great for Monsters & Spells
Text Converter
Helpful for converting Tables and statblock from Markdown or simple text
Renderer Demo
A style guide / practical reference of the various tags with side by side comparison of code to render, which means it provides a place to test out snippets of entries.
It will not render a fully developed homebrew for JSON

Which we'll go into a bit under the sections or types of homebrew they are best to work with within the 5eTools schema... Which reminds me.

The site utilizes JSON files for its data container(s); and so the homebrew'd additions are also JSON and must be converted into

If you're not familiar with it here is an overview of JSON -- the type of file/data structure content is stored within for 5eTools. Each main data type will have its own schema, and most will have a sample file associated with it to review and see how the schema is built with a practical example. (see below for that list).

Beyond that, there are some additional tools you will likely want to have in your virtual belt, loaded or bookmarked on your local PC.

External Tools

This site validates basic JSON structure (syntax) and points out what you're missing.
5eTools' Community Discord
specifically the #Brew-Coversion channel (its where you can ask directly for support and guidance)
Homebrew Repo
this serves as the offical Repository for Homebrew (the location from which the Manage Homebrew tool pulls.)

Section Tags

entry templates are not linked yet, still testing.

Section Name noframes Example File(s) Template Schema
Tool(s) Description
Adventure noframes 💾 📑 [📑] A playable adventure. Should include maps, event descriptions, etc.
Book noframes 💾 📑 [📑] Books are like Compendiums but include more information, 'fluff' and the like.
Background noframes 💾 📑 [📑] A custom character background which provides rich content.
Bestiary noframes 💾 📑 [📑] Bestiary - Monsters, NPCs and the like
Boon noframes 💾 📑 [📑] Special rewards from Extraordinarily powerful creatures for a character's service.
Class noframes 💾 📑 [📑] Character class information
Class Features noframes 💾 📑 [📑] Features such as Invocations, Fightstyles, or the like.
Collection A Brew with multiple section types defined within it, which doesn't lean more towards any one type.
Conditions noframes 💾 📑 [📑] Conditions and their effects
Deity noframes 💾 📑 [📑] The gods of the worlds of D&D through various campaigns.
Creature noframes 💾 📑 [📑] Bestiary - Monsters, NPCs and the like
Disease noframes 💾 📑 [📑] Diseases and illnesses.
Feats noframes 💾 📑 [📑] Custom Feats
Hazard noframes 💾 📑 [📑]
Item noframes 💾 📑 [📑] Items are the most complicated. Magical and Mundane, Trade goods, Kits, Mounts etc etc etc.
Monster noframes 💾 📑 [📑] Bestiary - Monsters, NPCs and the like
Object noframes 💾 📑 [📑] Objects are special items, being seige weaponry, explosives etc - usually mundane items that have specific features that exceed simple items but don't really have traditional combat aspects and need special descriptions.
NPC noframes 💾 📑 [📑] Bestiary - Monsters, NPCs and the like
Optional Features noframes 💾 📑 [📑] Optional features are things like Eldritch Innvocations, Powers, etc
Psionics noframes 💾 📑 [📑] Psionics are currently unique to Mystics and are similar to spells.
Races noframes 💾 📑 [📑] Playable races.
Reward noframes 💾 📑 [📑] Rewards and Boons, these are extraordinary results.
Ships noframes 💾 📑 [📑] Ships are part of a UA expansion to better identify how naval (space) combat would work.
Spells noframes 💾 📑 [📑] Spells are the magical powers for spellcasters, being divided into 10 tiers of power (cantrips + 1..9 level spells)
Table noframes 💾 📑 [📑] Tables can be random result tables or just a means to store data in a more helpful way.
Trap noframes 💾 📑 [📑] Traps and Lair like features that threaten characters - most often without combat resolutions.
Variant Rules noframes 💾 📑 [📑] These are sets of Rules for 5e that are House Rules, or expansions of existing rules - like crafting, mass combat/warfare, Strongholds and Travelling
Vehicles noframes 💾 📑 [📑] Ships are part of a UA expansion to better identify how naval (space) combat would work.