Git Product home page Git Product logo

bestiary's Introduction

Bestiary

Bestiary is a mobile-friendly 5e compendium of creatures that organizes them in various classifications and strengths.

See the latest compiled build here: http://sukritsingh.github.io/bestiary/

Unfortunately, Github pages only allows flat pages, so at the moment my website only hosts the bestiary sorted by alphabetical list. Once it's hosted somewhere else it'll be usable in it's full form.

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.

Once you're running the server from a terminal, just go to 'localhost:4000' and it should be running from in there.

To Do

  • Sort by location
  • More Monsters from more sources!
  • Add Mordekainen's tome of foes
  • Add more custom variants

Structure

Creatures can be found inside _posts/. Each creature 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.

Contributing to the bestiary

If you'd like to help fill out the rest of the creatures from the MM, for each new creature you make:

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

Thanks

Thanks to github user chisaipete for the original repository that I forked from, shamelessly!

Shoutout to Saph of http://ephe.github.io/grimoire from whom I've shamelessly borrowed the majority of the codebase

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.