/polymorph

Transform the D&D 5e System Reference Document into a new form

Primary LanguageTypeScriptMIT LicenseMIT

polymorph Build Status

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 (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 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. 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 and probably have some basic understanding of Typescript. 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. All content generated by this project is licensed under the Open Gaming License under which the original SRD is released.