Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGiddyLimit committed Aug 13, 2020
1 parent 7248979 commit 8a4baf8
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
Homebrew JSONs compatible with 5etools. An editor will be created Eventually:tm:.
Homebrew JSONs compatible with 5etools. The [editor](https://5e.tools/makebrew.html) will be expanded to support more content types Eventually:tm:.

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

#### Getting brew (manually)
#### 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
#### Getting Help

- Join the [5etools Discord Server](https://discord.gg/nGvRCDs) and ask in the #brew-conversion channel.
Join the [5etools Discord Server](https://discord.gg/nGvRCDs), and ask in the `#brew conversion` channel.

##### Creating and Contributing
#### Requesting Additions/Updates

Join the [5etools Discord Server](https://discord.gg/nGvRCDs), and see the pinned message format in the `#brew conversion` channel. You can vote for your conversion request, or those of others, in the `#brew-tracker` 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._

Expand All @@ -26,18 +30,19 @@ _**Note:** one large advantage of contributing to this repo, is that your files

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
##### 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 tabs over spaces, "LF" as end-of-line, and UTF-8 (without BOM) encoding.
- Format filenames as "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](https://github.com/TheGiddyLimit/homebrew/blob/master/spell/Sample%20-%20Giddy%3B%20Assorted%20Marginalia.json#L29) for an example of the structure; an example timestamp would be `1537874753`. You can view and copy the current Unix time [here](https://www.epochconverter.com/).
- Use `https://github.com/TheGiddyLimit/homebrew` as the source URL for sources without one.
- Only include content authors in the source `"author"` field; conversion credit should be given in a `"convertedBy"` field (with the same format).
- Include a `"dateAdded"` property in file metadata, which is a Unix timestamp (in seconds) at which the file was added. See [here](https://github.com/TheGiddyLimit/homebrew/blob/master/spell/Sample%20-%20Giddy%3B%20Assorted%20Marginalia.json#L29) for an example of the structure; an example timestamp would be `1537874753`. You can view and copy the current Unix time [here](https://www.epochconverter.com/).

#### Useful links

- https://5e.tools/demo.html (a demo of the renderer and JSON format)
- https://5e.tools/renderdemo.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)

0 comments on commit 8a4baf8

Please sign in to comment.