https://github.com/dhleong/polymorph
Transform the D&D 5e System Reference Document into a new form
https://github.com/dhleong/polymorph
dnd dnd5e json
Last synced: 5 months ago
JSON representation
Transform the D&D 5e System Reference Document into a new form
- Host: GitHub
- URL: https://github.com/dhleong/polymorph
- Owner: dhleong
- License: mit
- Created: 2018-06-03T18:04:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-25T04:38:23.000Z (about 3 years ago)
- Last Synced: 2025-07-27T09:33:02.521Z (12 months ago)
- Topics: dnd, dnd5e, json
- Language: TypeScript
- Size: 253 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
polymorph [](https://travis-ci.org/dhleong/polymorph)
=========
*Transform the D&D 5e System Reference Document into a new form*
## What?
Polymorph is a CLI tool to convert the [D&D 5e Systems Reference Document][1] (SRD)
into other, non-PDF formats. Our initial focus will be on JSON.
## Why?
The SRD is a great resource, but it is not straightforward to parse meaningful
data out of a PDF—especially one with as much rich, varied content as the SRD—making
it difficult to embed or rearrange into other projects. The goal of this project
is to tackle this tricky problem and provide [pre-processed versions of the SRD][2]
available to anyone, for any purpose supported under the Open Gaming License.
## How?
The easiest way to make use of this project is to explore [latest release][2].
Output from this program will be uploaded alongside each release, so you can
download it directly and explore the formats. Each release will also have information
on what has changed in the formats.
If you need to run this project yourself for whatever reason, you'll need to know
how to use [NodeJS][3] and probably have some basic understanding of [Typescript][4].
This project is not (yet?) published on NPM, but you should be able to just clone it
and run:
npm install
in the project root directory. That should get all the dependencies set up, though
you may also want to install `ts-node` globally (`npm i -g ts-node`) for running it.
## License
This project and its code are released under the [MIT License][5]. All content *generated by*
this project is licensed under the [Open Gaming License][6] under which
the original [SRD][1] is released.
[1]: http://dnd.wizards.com/articles/features/systems-reference-document-srd
[2]: https://github.com/dhleong/polymorph/releases/latest
[3]: https://nodejs.org/en/
[4]: https://www.typescriptlang.org/
[5]: https://github.com/dhleong/polymorph/blob/master/LICENSE
[6]: https://roll20.net/compendium/dnd5e/OGL%20License