Homebrew

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

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 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 to the site


The community has created a number of files that work with the system, adding custom (homebrew) content to the site's data.
  • 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)



The Process To Create Homebrew


To convert homebrew into 5eTools you will:
The 5eTools Website (for Monsters and Spells only)
πŸ’Ύ / πŸ“ Notepad++
πŸ’Ύ / πŸ“ Sublime
πŸ’Ύ / πŸ“ Microsoft Visual Studio Code
Reminder: please register/List your homebrew on the Tracking Worksheet
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.



Master Schemata


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.
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