Skip to content

Jtrinh3/grimoire

 
 

Repository files navigation

Grimoire

Grimoire is a mobile-friendly 5e spellbook that organizes spell lists by class and level.

See the latest compiled build here: https://thebombzen.com/grimoire/

Grimoire is forked from ephe/grimoire, which has since been taken down (à la DMCA).

Contributing

Feel free to open pull requests or issues on Github for any defects or suggested enhancements you may find. Alternatively, join my public discord at https://discord.gg/gbykrG2 and chat with me in #software-dev-stuff.

If you'd like to submit a Pull Request or somehow contribute code, I recommend you read the Style Guidelines. If your submissions do not match this style I'll probably request changes rather than merge it.

Changelog

  • See the commit history. The Grimoire is "done" at this point in that all the spells have been added (as of mid-to-late 2016).

To Do

  • Find a real home for class specializations (e.g. cleric's domains). Currently, to view spells available to a tempest cleric, one must do a tag search for: cleric | cleric (tempest). This is ulgy and needs fixing.

Structure

Spells can be found inside _posts/. Each spell gets its own post, written and stored as a Markdown file. The date is arbitrary and never displayed, but still necessary for Jekyll to process the posts properly.

If you'd like to help fill out the rest of the spells from the PHB, for each new spell you make:

  1. Make a new post inside _posts/ for each new spell, and copy the formatting from another spell.
  2. Submit a pull request for the spell(s) when you're finished, and that's it! Thank you so much. :)

Build Instructions

I've edited _config.yml for my own build purposes, but if you've got Jekyll set up locally, the following should create the build from your friendly command line terminal: jekyll serve -Vw --no-watch --baseurl ""

Thanks

Cleric and wizard spells from the Starter Kit were seeded from this Reddit post.

Thanks to @sethxd for suggesting Jets.js, a CSS search engine that plays nicely with Jekyll.

Thanks to @ephe for writing the original version of this thing in the first place.

Thanks to @Eikrem63 and @duatharben for adding the spells from Xanathar's Guide to Everything.

About

Functional 5e spell list by class and level

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 39.9%
  • HTML 26.2%
  • Python 15.7%
  • JavaScript 13.0%
  • Ruby 5.2%