ds4/README.md

61 lines
1.4 KiB
Markdown
Raw Normal View History

2020-12-23 18:48:32 +01:00
# DS4
2020-12-23 19:48:57 +01:00
An implementation of the Dungeonslayers 4 game system for [Foundry Virtual
Tabletop](http://foundryvtt.com).
2020-12-23 18:48:32 +01:00
## 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
2020-12-23 20:33:19 +01:00
project root with the following contents:
2020-12-23 18:48:32 +01:00
```
{
2020-12-27 13:22:14 +01:00
"dataPath": "/<absolute path to your home>/.local/share/FoundryVTT",
2020-12-23 18:48:32 +01:00
"repository": "",
"rawURL": ""
}
```
2020-12-23 20:33:19 +01:00
Then run
```
npm run link
```
2020-12-23 18:48:32 +01:00
If you want the system to be continuously build upon every saved change, just
run
```
npm run build:watch
```
2020-12-31 05:02:38 +01:00
# Licensing
Dungeonslayers (© Christian Kennig) is licensed under [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/de/deed.en).
The icons in [src/assets/official](src/assets/official) are slightly modifed
versions some of the original Dungeonslayers icons, which have also been
published under CC BY-NC-SA 3.0. Hence the modified icons are also published
under this license. A copy of this license can be found under
[src/assets/official/LICENSE](src/assets/official/LICENSE).
The rest of this project is licensed under the MIT License, a copy of which can
be found under [LICENSE](LICENSE).