diff --git a/README.md b/README.md new file mode 100644 index 00000000..cde25c7b --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# DS4 + +An implementation of the Dungeonslayers 4 game system for Foundry Virtual +Tabletop (http://foundryvtt.com). + +## Prerequisites + +In order to build this system, a recent version of `npm` is required. + +## Building + +To build the system, first install all required dependencies: + +``` +npm install +``` + +Then build the project by running + +``` +npm run build +``` + +If you'd like the built system to be automatically linked to your local Foundry +VTT installation's data folder, add a file called `foundryconfig.json` to the +project root with the following contents befor building: + +``` +{ + "dataPath": "/home/johannesloher/.local/share/FoundryVTT", + "repository": "", + "rawURL": "" +} +``` + +If you want the system to be continuously build upon every saved change, just +run + +``` +npm run build:watch +```