Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.92 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.92 KB
Raw

Homebrew JSONs compatible with 5etools. An editor will be created eventually.

Getting brew (automatically)

  1. Hit the "Manage Homebrew" button (if available) on a 5etools page.
  2. "Get Homebrew 2.0"
  3. Click to add. Currently, the list only displays items from this repository.

Getting brew (manually)

  1. Browse for the file you want
  2. Click "Raw" (top-right) and save it as .json
  3. Load into 5etools via the Brew Manager
Getting help
Creating and Contributing
  • 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/homebrew as the URL
  • Source "author" should only include content authors; conversion credit should be included in a "convertedBy" property (with the same format).

Useful links