https://github.com/twisterghost/5e-obsidian

https://github.com/twisterghost/5e-obsidian

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/twisterghost/5e-obsidian
• Owner: twisterghost
• Created: 2020-10-24T14:32:03.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-19T17:10:30.000Z (over 3 years ago)
• Last Synced: 2024-08-02T05:10:28.065Z (5 months ago)
• Language: JavaScript
• Size: 719 KB
• Stars: 43
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# D&D Obsidian Reference

**>> [Download the files on releases page](https://github.com/twisterghost/5e-obsidian/releases) <<**

A script to break down the excellent compiled

[D&D SRD Remastered](https://github.com/Umbyology/OGL-SRD5) into a workable

reference directory for use in [Obsidian](https://obsidian.md).

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](https://github.com/twisterghost/5e-obsidian/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:

```shell

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

```

Then, install dependencies and run:

```shell

$ 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](https://twitter.com/twisterghost) or by email at

[[email protected]](mailto:[email protected]).