Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 3.01 KB

README.md

File metadata and controls

43 lines (30 loc) · 3.01 KB
Raw

Homebrew JSONs compatible with 5etools. An editor will be created Eventually:tm:.

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

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

* See the article here for a how-to.

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"
  • Use a unique "json" source name; they should be uniquely identifiable across all homebrew. For example, for the hypothetical book "A History Of Dragons" by "A. N. Other," a sensible source name would be "ANOtherHistoryOfDragons". Note that this text is never displayed, so can be as long and as ugly as required. While this is not enforced, we reserve the right to change data as required to avoid naming conflicts.
  • 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).
  • Metadata should include a "dateAdded" property, which is a Unix timestamp (in seconds) at which the file was added. See here for an example of the structure; an example timestamp would be 1537874753. You can view and copy the current Unix time here.

Useful links