Homebrew
Contents
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 Official content available here.
- Homebrew content is either on the Homebrew Repo, stored locally, or could even be in a separate server / filestore that only you and your friends have access to for your personal usage.
- 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.
- 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: Homebrewery, 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 Homebrewery 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.
How to add Existing Homebrew
- The community has created a number of files that work with the system, adding custom (homebrew) content to the site's data.
- From the Website
- Go to the website and choose Utilities,
- choose Manage Homebrew,
- select Get Homebrew and choose what sources you'd like to add.
- (for more information check the feature information for Manage Homebrew)
- From Feature: Import Roll20
- As a player - go to journal and choose Feature: Import Players Temp Import
- As a GM - go to Settings, and choose Feature: Import by Category Import by Category
- From Foundry
- Choose Import from either the Actor Navbar, the Import at the bottom of sidebar, or via Rivet.
- From the Website
The Process To Create Homebrew
- To convert homebrew into 5eTools you will:
- Find content you wish to migrate into 5eTools
- Decide how to organize/break down the content for 5eTools
- Determine Tools
- Review related example(s) & Related work.
- Reminder: please register/List your homebrew on the Tracking Worksheet
- Open what you're going to be using for the Editor / Construction Tool
- Develop META header
- Begin Conversion
- Test code in JSONlint
- fix any errors that occur until it passes successfully
- Attempt a upload through Manage Homebrew
- Test each section that was added
- fix any errors that occur until it passes successfully
- Have your conversion peer-reviewed
- Submit to the Repo.
- Through a Pull Request (preferred)
- Or posting the file in the Discord Community's #Brew Conversion Channel and tagging an admin/Arch-Magos
Homebrew: How to
Homebrew: Overview
Homebrew Repository
How to create a Homebrew JSON for 5eTools
5eTools uses JSON files/data structure to load Homebrew content. If you're not familiar with them here is an overview of JSON, which explains briefly how it works. Depending on what kind of Homebrew content you want to create, you will need to follow it's schema. Below you will find a list of all the different content types, with the necessary links.
Before you start converting homebrew, however, you will want to take a look at the Meta Tag. It is necessary in every homebrew file, otherwise it will fail to load.
Some things you will need to start converting:
- A text editor. Basic Notepad can work, but working with it can be complicated. Some options are: Notepad++, Visual Studio Code, Sublime Text.
- If the editor of your choice has no on-the-go validation, a website to do so such as JSONLint.
- NOTE: a validated file only means that there are no JSON formatting errors. This does not necessarily mean the file will work with the website's structure.
- Plenty of patience.
Section Name | ![]() |
Example File(s) | Template | Schema π |
Tool(s) | Description |
---|---|---|---|---|---|---|
Action | ![]() |
π |
[π] |
Reference for the mechanical economy of a creature's combat turn. | ||
Adventure | ![]() |
π |
[π] |
A playable adventure. Should include maps, event descriptions, etc. | ||
Background | ![]() |
π |
[π] |
A background which provides rich content for developing a Character's history, beliefs, and motivations. | ||
Book | ![]() |
πΎ |
π |
[π] |
Books are like Compendiums but include more information, 'fluff' and the like. | |
Bestiary | ![]() |
π |
[π] |
Bestiary - Monsters, NPCs and the like | ||
Boon | ![]() |
πΎ |
π |
[π] |
Special rewards from Extraordinarily powerful creatures for a character's service. | |
Class | ![]() |
πΎ |
π |
[π] |
Character class information | |
Class Features | ![]() |
π |
[π] |
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 | ![]() |
π |
[π] |
Conditions and their effects | ||
Creature | ![]() |
π |
[π] |
Bestiary - Monsters, NPCs and the like | ||
Cult | ![]() |
π |
[π] |
A shadowy organization or guild, usually with a religious cohessive element | ||
Deity | ![]() |
π |
[π] |
The gods of the worlds of D&D through various campaigns. | ||
Disease | ![]() |
π |
[π] |
Diseases and illnesses. | ||
Feats | ![]() |
π |
[π] |
Custom Feats | ||
Hazard | ![]() |
π |
[π] |
These are most often enviromental hazards and climate issues, not as simple as traps but still worthwhile. | ||
Item | ![]() |
π |
[π] |
Items are the most complicated. Magical and Mundane, Trade goods, Kits, Mounts etc etc etc. | ||
Language | ![]() |
π |
[π] |
Sets of written and spoken languages, who speaks them, what font they use, etc. | ||
Magic Variant | ![]() |
π |
[π] |
?? | ||
Make Homebrew's Monster Traits | ![]() |
π |
[π] |
Extensible Sets of Monster trains and feature usable by the Homebrew builder. | ||
Meta tag | ![]() |
[ πΎ] |
π |
This is required for each JSON | ||
Monster | ![]() |
π |
[π] |
Bestiary - Monsters, NPCs and the like | ||
Object | ![]() |
π |
[π] |
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 | ![]() |
π |
[π] |
Bestiary - Monsters, NPCs and the like | ||
Optional Features | ![]() |
π |
[π] |
Optional features are things like Eldritch Innvocations, Powers, etc | ||
Psionics | ![]() |
π |
[π] |
Psionics are currently unique to Mystics and are similar to spells. | ||
Races | ![]() |
π |
[π] |
Playable races. | ||
Recipe | ![]() |
π |
[π] |
These are recipes for cooking/drinking | ||
Reward | ![]() |
π |
[π] |
Rewards and Boons, these are extraordinary results. | ||
Ships | ![]() |
πΎ |
π |
[π] |
Ships are part of a UA expansion to better identify how naval (space) combat would work. | |
Spells | ![]() |
π |
[π] |
Spells are the magical powers for spellcasters, being divided into 10 tiers of power (cantrips + 1..9 level spells) | ||
Subclass/Archetype | ![]() |
π |
[π] |
Subclasses for an existing class | ||
Table | ![]() |
π |
[π] |
Tables can be random result tables or just a means to store data in a more helpful way. | ||
Trap | ![]() |
π |
[π] |
Traps and Lair like features that threaten characters - most often without combat resolutions. | ||
Variant Rules | ![]() |
π |
[π] |
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 | ![]() |
πΎ |
π |
[π] |
Ships are part of a UA expansion to better identify how naval (space) combat would work. |
- entry templates are not linked yet, still testing.