As of Nov 18, 2021, World of Darkness and Paradox Interactive announced that they have been working on official tools that will cover the same topics I've attempted to address with this application, to be released in beta in 2022. As such, my motivation to complete this application is very low.
It's not a loss - I learned a lot about Google Lit and the VtM system. Such is the way of independent coding and modding. In the future, if the official WoD tools have a modding system or lack features that I can fill in, I'll look at updating this project then. I had begun the work on converting this to React as it better suited the full application needs better than Lit, in the long run (remember this started as a basic dice roller, which Lit was very suitable for).
In the meantime, I'll also leave this up as a reference project. Thank you.
The concept behind this code repo is to give Vampire the Masquerade (VtM) 5e players a set of tools to simplify their ability to play. It is a work in progress.
I'll be hosting the application on my server once it is in a more useable state. I estimate the Character Creation tool is over 80% complete, there are a few items still TODO, as well as future upgrades planned.
This started as a basic VtM dice roller (which will be included as a separate view for any who just want a digital die roller w/o importing or creating a character sheet), but I wanted users to have the ease of using their actual character stats for quick selection when rolling die. The die roller calculates successes, messy successes, and failures.
I expanded to the full character sheet. Currently all data is saved to the user's local PC, but I wired up the code to easily convert to save to a Mongo server. Since licensing (see below) from Paradox Interactive AB stipulates that I can't charge users, I would need some funds to set up a NodeJS/Express/MongoDB server. In the meantime I'll be putting this up on my server as an application. If the user installs it, they'll be able to use it offline as well.
Future plans / updates:
- Full ARIA compatibility. It would be amazing to have a tool for visually impaired players so they can play VtM.
- NodeJS / Mongo support: Allow a Coterie to be in a linked session and save characters remotely.
- Storyteller view: Give Storytellers the ability to have Character information in front of them with a real-time view of stats (hunger, humanity, damage) and die rolls, hence the need for NodeJS.
License is provided under Apache 2 license. Feel free to clone your own repository and edit as you see fit for personal use, but under the Dark Pack License Agreement provided by Paradox Interactive AB, you may not sell the application, use advertisements, or otherwise monetize beyond a link for users to donate to support development. Portions of the materials are the copyrights and trademarks of Paradox Interactive AB, and are used with permission. All rights reserved Paradox Interactive AB. For more information please visit worldofdarkness.com.
You may not include information that would supplant the need for users to purchase official Vampire the Masquerade source materials. I have used basic descriptions / summaries for quick reference, with expanded reference back to source material. Example from the Predator types data object:
{ id: PredatorIds.Farmer, description: "You only feed from animals", name: "Farmer", page: 177, source: SourceBookIds.Corebook }
This includes an internal data ID, a description I summarized from the 5e Sourcebook, the name which appears in a dropdown select during character creation, as well as which sourcebook ID the user can find it in and the page number which is converted into a user-friendly display, e.g. "5e Sourcebook page 177." I did not copy/paste the full text description directly from the book. Again, users will need the source material to fully utilize these tools.
- NodeJS 10 or higher (built using 14.16.x)
- npm 6 or higher (built using 6.14.x)
- All other dependencies are installable npm
To get started:
- Checkout repository
npm installstartruns your app for development, reloading on file changesstart:buildruns your app after it has been built using the build commandbuildbuilds your app and outputs it in yourdistdirectorytestruns your test suite with Web Test Runnerlintruns the linter for your project
For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
- Lit - https://lit.dev/
- Typescript - https://www.typescriptlang.org/
- Open Web Components - https://open-wc.org/
- ESLint - https://eslint.org/