An implementation of the Dungeonslayers 4 game system for Foundry Virtual Tabletop.
Find a file
Sascha Martens 4f2b3fbd20 Changed magic-spells.db to spells.db
Also changed the code in system.json to match the new filename
2021-06-01 21:08:29 +02:00
.gitlab/issue_templates add bug report template 2021-01-06 14:56:50 +01:00
.husky Update dependencies 2021-03-03 04:26:26 +01:00
.vscode Properly generate sourceMap and add launch config for chrome debugging 2021-03-17 17:28:35 +01:00
.yarn Update dependencies 2021-03-03 04:26:26 +01:00
spec Small fix in tsconfig.spec.json 2021-03-17 17:32:29 +01:00
src Changed magic-spells.db to spells.db 2021-06-01 21:08:29 +02:00
.editorconfig switch to using TypeScript 2020-12-23 16:52:20 +01:00
.eslintignore Use rollup to build typescript 2021-03-17 17:28:35 +01:00
.eslintrc.js Somemore small fixes 2021-03-17 17:35:26 +01:00
.gitignore Switch to jest 2021-02-11 13:42:38 +01:00
.gitlab-ci.yml Use rollup to build typescript 2021-03-17 17:28:35 +01:00
.npmignore initial commit 2020-10-29 16:18:38 +01:00
.nvmrc update dependencies and add .nvmrc 2021-01-03 21:15:25 +01:00
.prettierignore Use rollup to build typescript 2021-03-17 17:28:35 +01:00
.prettierrc.js add eslint and prettier 2020-12-23 18:23:26 +01:00
.yarnrc.yml Update dependencies 2021-03-03 04:26:26 +01:00
gulpfile.js Somemore small fixes 2021-03-17 17:35:26 +01:00
jest.config.js Update dependencies 2021-05-29 21:51:23 +02:00
LICENSE add author siggi 2021-01-10 21:51:47 +01:00
package.json release version 0.7.1 2021-05-29 19:58:48 +00:00
README.md Add list of game icons with their authors and licenses 2021-05-23 14:43:52 +02:00
rollup.config.js Use rollup to build typescript 2021-03-17 17:28:35 +01:00
tsconfig.eslint.json Use rollup to build typescript 2021-03-17 17:28:35 +01:00
tsconfig.json Properly generate sourceMap and add launch config for chrome debugging 2021-03-17 17:28:35 +01:00
yarn.lock Update dependencies 2021-05-29 21:51:23 +02:00

DS4

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

This system provides sheet support for Actors and Items and mechanical support for dice and rules necessary to play games of Dungeonslayers 4.

Installation

To install and use the Dungeonslayers 4 system for Foundry Virtual Tabletop, simply paste the following URL into the Install System dialog on the Setup menu of the application.

https://git.f3l.de/dungeonslayers/ds4/-/raw/latest/src/system.json?inline=false

Development

Prerequisites

In order to build this system, recent versions of node and yarn are required. Most likely using npm also works but only yarn is officially supported. We recommend using the latest lts version of node, which is v14.15.5 at the time of writing. If you use nvm to manage your node versions, you can simply run

nvm install

in the project's root directory.

You also need to install the the project's dependencies. To do so, run

yarn install

Building

You can build the project by running

yarn build

Alternatively, you can run

yarn build:watch

to watch for changes and automatically build as necessary.

Linking the built system to Foundry VTT

In order to provide a fluent development experience, it is recommended to link the built system to your local Foundry VTT installation's data folder. In order to do so, first add a file called foundryconfig.json to the project root with the following content:

{
    "dataPath": "<path to your home directory>/.local/share/FoundryVTT"
}

On platforms other than Linux you need to adjust the path accordingly.

Then run

yarn link-project

Running the tests

You can run the tests with the following command:

yarn test

Contributing

Code and content contributions are accepted. Please feel free to submit issues to the issue tracker or submit merge requests for code changes. To create an issue, send a mail to git+dungeonslayers-ds4-155-issue-@git.f3l.de.

Licensing

Dungeonslayers (© Christian Kennig) is licensed under CC BY-NC-SA 3.0.

The icons in src/assets/icons/official are slightly modified 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/icons/official/LICENSE.

Similarly, the compendium packs found in src/packs are based on Dungeonslayers and thus are also released under CC BY-NC-SA 3.0.

The icons in src/assets/icons/game-icons have been published on https://game-icons.net/. You can find a list of the icons with their corresponding authors and licenses at src/assets/icons/game-icons/authors.md.

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