Difference between revisions of "Homebrew"

From 5etools Community Wiki
Jump to: navigation, search
m (The Process To Create Homebrew)
m (The Process To Create Homebrew)
Line 19: Line 19:
  
 
:To convert homebrew into 5eTools you will:
 
:To convert homebrew into 5eTools you will:
::* [[Homebrew: Sources|Find content]] you wish to migrate into 5eTools
+
::* [[Homebrew: Sources|'''Find content''']] you wish to migrate into 5eTools
 
::* Decide how to [[Homebrew: Organizing|'''organize/break down the content''']] for 5eTools
 
::* Decide how to [[Homebrew: Organizing|'''organize/break down the content''']] for 5eTools
::* [[Homebrew: Tools|Determine Tools]]
+
::* [[Homebrew: Tools|'''Determine Tools''']]
::* [[Template:Homebrew: ReferenceTable|Review Sample(s) & Related works]]
+
::* Review related [[Template:Homebrew: ReferenceTable|'''example(s) & Related work''']].
::* Register/List your homebrew on the Tracking Worksheet
+
:::: Reminder: please register/List your homebrew on the Tracking Worksheet
 
::* [[Template:Homebrew: ReferenceTable|Open Editor / Tool]]
 
::* [[Template:Homebrew: ReferenceTable|Open Editor / Tool]]
 
::* Develop META header
 
::* Develop META header

Revision as of 21:27, 3 September 2019

framless
v1.125.1

Homebrew

This is currently being developed so it will be a bit rough as we develop better content and as we get feedback on what helps, and what doesn't.


FIRST things first.
When we say homebrew in the sense of 5eTools, it's more than what you might be normally be used to, homebrew content effectively means any content that is not WoTC and is also available for use within 5eTools. This will include licensed 3rd party content such as Green Ronin; Kobold Press; Paizo; etc. You can see the list of Offical content here.
When it's used within 5eTools, Homebrew also includes the means to take your ideas and use them as part of the site. (ie Homebrew Manager is how you include non SRD/RAW content)
That requires some additional work from what you may be familiar with RE: Homebrewry, GMBinder, or just drafting up a thought in a word processor. It helps to have a minor understanding of a data structure called JSON. If you've used Homebrewry or GMBinder, CritterDB or the like, it's not that different.
We'll do our best to give you the support to build your own homebrew for 5eTools.
This process is outlined below and links will be provided to greater detail around each step.



The Process To Create Homebrew

To convert homebrew into 5eTools you will:
Reminder: please register/List your homebrew on the Tracking Worksheet
  • Open Editor / Tool
  • Develop META header
  • Begin Conversion
  • Test code in JSONlint
  • Attempt to upload through Manage Homebrew
  • Test each section that was added

Homebrew: How to

Homebrew: JSON Overview

Homebrew: Overview

Homebrew Repository

How to create a Homebrew JSON for 5eTools

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




This wiki will, under the sections or types of homebrew, which tools 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 from their current format (Markdown, PDF, .Doc etc into JSON formatted content.

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.



Section Name noframes Example File(s) Template Schema
📑
Tool(s) Description
Action noframes

💾

📑

[📑]

Reference for the mechanical economy of a creature's combat turn.
Adventure noframes

💾

📑

[📑]

A playable adventure. Should include maps, event descriptions, etc.
Background noframes

💾

📑

[📑]

A background which provides rich content for developing a Character's history, beliefs, and motivations.
Book noframes

💾

📑

[📑]

Books are like Compendiums but include more information, 'fluff' and the like.
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
Creature noframes

💾

📑

[📑]

Bestiary - Monsters, NPCs and the like
Cult noframes

💾

📑

[📑]

A shadowy organization or guild, usually with a religious cohessive element
Deity noframes

💾

📑

[📑]

The gods of the worlds of D&D through various campaigns.
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.
Language noframes

💾

📑

[📑]

Sets of written and spoken languages, who speaks them, what font they use, etc.
Magic Variant noframes

💾

📑

[📑]

??
Make Homebrew's Monster Traits noframes

💾

📑

[📑]

Extensible Sets of Monster trains and feature usable by the Homebrew builder.
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.
Recipe noframes

💾

📑

[📑]

These are recipes for cooking/drinking
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)
Subclass/Archetype noframes

💾

📑

[📑]

Subclasses for an existing class
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.
entry templates are not linked yet, still testing.

Formatting