dungeonslayers/ds4
dungeonslayers/ds4
3
0
Fork 0
Code Issues 9 Pull requests 7 Projects Releases 10 Packages 1 Activity
An implementation of the Dungeonslayers 4 game system for Foundry Virtual Tabletop.
205 commits 12 branches 79 tags 59 MiB
JavaScript 39.1%
TypeScript 29.3%
Handlebars 26%
SCSS 5.4%
Shell 0.2%
Find a file
Johannes Loher 2ce3d7090d Merge branch '027-add-service-desk-mail' into 'master' 
add mail to readme

Closes #27

See merge request dungeonslayers/ds4!30
2021-01-06 23:19:52 +01:00
.gitlab/issue_templates add bug report template 2021-01-06 14:56:50 +01:00
.vscode Make tests and implementation interact. 2020-12-30 21:28:22 +01:00
spec/support Add docs, type clarifications. 2021-01-04 21:21:06 +01:00
src reference a version tag in the download url 2021-01-06 01:30:21 +01:00
.editorconfig switch to using TypeScript 2020-12-23 16:52:20 +01:00
.eslintrc.js add prettier and eslint 2020-12-23 17:26:53 +01:00
.gitignore Create explicit ci test task. 2020-12-30 22:41:55 +01:00
.gitlab-ci.yml put release artifacts in ds4 directory 2021-01-06 00:59:22 +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
.prettierrc.js add eslint and prettier 2020-12-23 18:23:26 +01:00
gulpfile.js format gulpfile 2021-01-06 01:33:30 +01:00
LICENSE adjust licensing 2020-12-31 05:02:38 +01:00
package-lock.json update dependencies and add .nvmrc 2021-01-03 21:15:25 +01:00
package.json update dependencies and add .nvmrc 2021-01-03 21:15:25 +01:00
README.md add mail to readme 2021-01-06 21:38:26 +01:00
tsconfig.json Fix jasmine imports/symbol visibility. 2020-12-31 02:29:27 +01:00

README.md

DS4

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

This system provides character sheet support for Actors and Items and mechanical support for dice and rules necessary to play games of Dungeponslayers 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/master/src/system.json?inline=false

Development

Prerequisits

In order to build this system, recent versions of node and npm are required. We recommend using the latest lts version of node, which is v14.15.4 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

npm install

Building

You can build the project by running

npm run build

Alternatively, you can run

npm run 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

npm run link

Running the tests

You can run the tests with the following command:

npm 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/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 software component of this project is licensed under the MIT License, a copy of which can be found under LICENSE.