Homebrew JSONs compatible with 5etools. An editor will be created eventually.
Getting brew (automatically)
- Hit the "Manage Homebrew" button (if available) on a 5etools page.
- "Get Homebrew 2.0"
- Click to add. Currently, the list only displays items from this repository.
Getting brew (manually)
- Browse for the file you want
- Click "Raw" (top-right) and save it as .json
- Load into 5etools via the Brew Manager
Getting help
- Join the 5etools Discord Server and ask in the #homebrew channel.
Creating and Contributing
Note: one large advantage of contributing to this repo, is that your files will be kept up-to-date as changes are made to the main site.
- The easiest way to make your own is to copy one of the existing 'brews as a template and use the main 5etools data as a reference.
- The schemata for the main site data can be found here
- Contributions are welcome. For the Git-literate, make a pull request. For everyone else, create an Issue and post a link to your file (PasteBin is fine), and I (or other maintainers, in future) can add it for you.
A schema is available (json.schema) describing the layout of the and usage of the _meta property found in the various data files.
Conventions to Follow
There are a few conventions used which should be followed when creating homebrew:
- Filename format is "Author Name; Homebrew Name.json"
- Sources with no URL should use
https://github.com/TheGiddyLimit/homebrewas the URL - Source
"author"should only include content authors; conversion credit should be included in a"convertedBy"property (with the same format).
Useful links
- https://5e.tools/demo.html (a demo of the renderer and JSON format)
- https://5e.tools/converter.html (a tool to convert text to stat blocks)
- https://jsonlint.com/ (error-check your JSON)
- https://www.sublimetext.com/ (top-notch text editor)