Difference between revisions of "Homebrew"

From 5etools Community Wiki
Jump to: navigation, search
m
m
Line 181: Line 181:
 
|[[https://github.com/TheGiddyLimit/TheGiddyLimit.github.io/blob/master/test/schema/bestiary/bestiary.json πŸ“‘]]
 
|[[https://github.com/TheGiddyLimit/TheGiddyLimit.github.io/blob/master/test/schema/bestiary/bestiary.json πŸ“‘]]
 
|
 
|
βˆ’
|Bestiary - Monsters, NPCs and the like
+
|This is required for each JSON
 
|-
 
|-
 
|[[Homebrew: Monster| Monster]]
 
|[[Homebrew: Monster| Monster]]

Revision as of 20:27, 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

JSONlint.com
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.)




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 πŸ’Ύ πŸ“‘ [πŸ“‘] These are most often enviromental hazards and climate issues, not as simple as traps but still worthwhile.
Item noframes πŸ’Ύ πŸ“‘ [πŸ“‘] Items are the most complicated. Magical and Mundane, Trade goods, Kits, Mounts etc etc etc.
Meta tag noframes πŸ’Ύ πŸ“‘ [πŸ“‘] This is required for each JSON
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.

Formatting