twisterghost / 5e-obsidian

44 stars 3 forks source link

D&D Obsidian Reference

>> Download the files on releases page <<

A script to break down the excellent compiled D&D SRD Remastered into a workable reference directory for use in Obsidian.

There's still a lot of improvements that could be made to make this more accurate and complete, but in practice, it has been enough to get moving with D&D in Obsidian.

Get the files

You probably just want the end result! Head to the releases page of this repo and download the latest .zip. Unzip it and add it to your Obsidian vault and you're ready to roll.

Build it yourself

If you'd rather play with the code or build the output resources yourself, you can start by cloning this repository:

$ git clone https://github.com/twisterghost/5e-obsidian.git

Then, install dependencies and run:

$ cd 5e-obsidian
$ npm install
$ npm start

By default, the resources will compile to a directory called resource.

Contributing

Feel free to contribute! If there's missing data, a broken file or whatever, please consider opening a pull request.

Contact

If you have questions/suggestions/pull requests/comments and you don't have a github account, you can reach me on twitter @twisterghost or by email at michaelbarrett@hey.com.