ds4/README.md
2020-12-27 13:22:14 +01:00

47 lines
830 B
Markdown

# 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:
```
{
"dataPath": "/<absolute path to your home>/.local/share/FoundryVTT",
"repository": "",
"rawURL": ""
}
```
Then run
```
npm run link
```
If you want the system to be continuously build upon every saved change, just
run
```
npm run build:watch
```