Skip to content

bgior/weavelore

Repository files navigation

WeaveLore

WeaveLore is a web application to browse D&D 5e spells.

You can currently find it hosted here: https://weavelore.bgior.com

Development

The application is a Vue project, you can run it from source by following the steps below:

  • Install Vue CLI: npm install -g @vue/cli
  • Install dependencies: npm install
  • Run the development server: npm run serve

More useful commands:

  • Generate the production build: npm run build
  • Run the unit tests: npm run test:unit
  • Run the E2E tests: npm run test:e2e
  • Run the linter: npm run lint
  • Inspect the autogenerated webpack config: npm run inspect

Documentation

You can find more information about the project in the wiki, including how to start using custom content.

License

Game content

The SRD data is based on the SRD Spells repository, which in turn comes from the SRD 5.1, released under the terms of the OGL (Open Game License). I strove to make the application comply with these terms, if you notice any deviation please let me know.

Software

The rest of the project is released under GNU AGPL v3 (see LICENSE.md).

Copyright (C) 2019 Bruno Giorello

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

This project is not affiliated in any way to Wizards of the Coast.

Aknowledgments

  • Original spell data in JSON format taken from SRD Spells, modified and extended.
  • Inspiration for a few of the school "runes" was taken from Obsidian Dawn's Arcane Runes.
  • This project was made entirely using open-source software, including Atom, Inkscape, GIMP and Ubuntu, as well as the great libraries included.

Contributing

Pull requests containing fixes and adjustments to the SRD data are welcome. For anything else please ask beforehand. Pull requests should target the develop branch.

Contact