Code Monkey home page Code Monkey logo

homebrew's Introduction

Homebrew JSONs compatible with 5etools. The editor will be expanded to support more content types Eventually:tm:.

Getting Brew (automatically)

  1. Hit the "Manage Homebrew" button (if available) on a 5etools page.
  2. "Get Homebrew"
  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

Join the 5etools Discord Server, and ask in the #brew conversion channel.

Requesting Additions/Updates

Join the 5etools Discord Server, 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.

  • 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:

  • 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.
  • 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 for an example of the structure; an example timestamp would be 1537874753. You can view and copy the current Unix time here.

Useful links

homebrew's People

Contributors

aarowaim avatar actualsailorcat avatar azzurite avatar bowsori avatar bucketlistmod avatar desorda avatar dwhyte11 avatar eberron94 avatar emberheartshine avatar frost2779 avatar git-gor avatar hafdon avatar ineedanamepls avatar jimmypringles avatar lorddusk avatar lxran avatar maalunar avatar mrvauxs avatar nova-katt avatar octahedralc avatar p4535992 avatar raguoragula avatar raulrozza avatar seuronao avatar spappz avatar surged20 avatar thegiddylimit avatar trunzoc avatar tylermac avatar vasqu3z avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.