mxcory/5e_homebrew
1
0
Fork 0
mirror of https://github.com/TheGiddyLimit/homebrew.git synced 2026-08-02 15:35:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update Readme (#2707)

Browse Source
This commit is contained in:
Lyra [he/him]
2026-03-23 20:41:37 +00:00
committed by GitHub
parent ca1839fd8e
commit 4d08e9ef23
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -2
View File
@@ -22,7 +22,7 @@ Join the [5etools Discord Server](https://discord.gg/nGvRCDs), and see the pinne
_**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](https://github.com/5etools-mirror-1/5etools-mirror-1.github.io/tree/master/data) as a reference.
- The easiest way to make your own is to copy one of the existing 'brews as a template and use the main [5etools data](https://github.com/5etools-mirror-3/5etools-src/tree/main/data) as a reference.
- The schemas for homebrew data can be found [here](https://github.com/TheGiddyLimit/5etools-utils/tree/master/schema/brew)
- 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.
@@ -36,7 +36,7 @@ There are a few conventions used which should be followed when creating homebrew
- 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.
- 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/).
- 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#L36) 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/).
- Images (and similar assets, e.g. character sheet PDFs) should be added to the [homebrew image repository](https://github.com/TheGiddyLimit/homebrew-img)
#### Useful links
@@ -45,3 +45,4 @@ There are a few conventions used which should be followed when creating homebrew
- https://5e.tools/converter.html (a tool to convert text to stat blocks)
- https://jsonlint.com/ (error-check your JSON)
- https://code.visualstudio.com (top-notch editor)
- https://marketplace.visualstudio.com/items?itemName=revilowaldow.5etools-language-server (live data validation and suggestions)