ds4/README.md
2021-01-03 16:40:29 +01:00

1.4 KiB

DS4

An implementation of the Dungeonslayers 4 game system for Foundry Virtual Tabletop.

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.

The icons in src/assets/official are slightly modifed versions of 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.

The rest of this project is licensed under the MIT License, a copy of which can be found under LICENSE.