ds4/README.md

# 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
```

# 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).