data-sdk-npm

This repo is a suite of utilities for working with structured Draw Steel data.

• The repo itself is an npm package: npmjs.com - steel-compendium-sdk
  • Typescript Models
  • Readers and Writers (Serialization)
    • JSON
    • YAML
    • Markdown (Steel Compendium format)
• Schemas
  • Ability JSON Schema (Documentation)
  • Statblock JSON Schema (Documentation)

This code is also the backbone of the Draw Steel Web Adapter (sourcecode)

Please use this form to report bugs if you find them!

Development

Quick Start

• Test: npm run test
• Publish version
  • Update CHANGELOG.md with release notes
  • run just release <version> Or...
    • Update package.json with new version
    • npm publish

Run the sc-convert cli tool with:

npm run build && npm link && sc-convert --from json --to xml ./src/__tests__/data/ability/dto-json/blessing_of_the_blade.json --output ./tmp

Future work

• Update Markdown standard to be compliant with changes from the final DS PDF
• Add XML support (reader, writer, schema, validator)
• Validator support for yaml
• Support more models? (Let me know what you need)