ds4/README.md

102 lines
2.8 KiB
Markdown

# DS4
An implementation of the Dungeonslayers 4 game system for [Foundry Virtual
Tabletop](http://foundryvtt.com).
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/latest/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](mailto:git+dungeonslayers-ds4-155-issue-@git.f3l.de).
## 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 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](src/assets/official/LICENSE).
Similarly, the compendium packs found in [src/packs](src/packs) are based on
Dungeonslayers and thus are also released under CC BY-NC-SA 3.0.
The software component of this project is licensed under the MIT License, a copy
of which can be found under [LICENSE](LICENSE).