ds4/README.md

126 lines
3.7 KiB
Markdown
Raw Normal View History

2020-12-23 18:48:32 +01:00
# DS4
2020-12-23 19:48:57 +01:00
An implementation of the Dungeonslayers 4 game system for [Foundry Virtual
Tabletop].
2020-12-23 18:48:32 +01:00
2021-01-25 14:16:14 +01:00
This system provides sheet support for Actors and Items and mechanical support
for dice and rules necessary to play games of Dungeonslayers 4.
2020-12-23 18:48:32 +01:00
2021-01-06 03:22:25 +01:00
## Installation
2020-12-23 18:48:32 +01:00
2021-01-06 03:22:25 +01:00
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.
2020-12-23 18:48:32 +01:00
2021-01-18 20:02:41 +01:00
https://git.f3l.de/dungeonslayers/ds4/-/raw/latest/src/system.json?inline=false
2021-01-06 03:22:25 +01:00
## Development
2021-01-25 14:16:14 +01:00
### Prerequisites
2021-01-06 03:22:25 +01:00
2021-02-11 13:57:14 +01:00
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
2021-01-06 03:22:25 +01:00
```
nvm install
```
in the project's root directory.
You also need to install the the project's dependencies. To do so, run
2020-12-23 18:48:32 +01:00
```
2021-02-11 13:57:14 +01:00
yarn install
2020-12-23 18:48:32 +01:00
```
2021-01-06 03:22:25 +01:00
### Building
You can build the project by running
2020-12-23 18:48:32 +01:00
```
2021-02-11 13:57:14 +01:00
yarn build
2020-12-23 18:48:32 +01:00
```
2021-01-06 03:22:25 +01:00
Alternatively, you can run
```
2021-02-11 13:57:14 +01:00
yarn build:watch
2021-01-06 03:22:25 +01:00
```
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:
2020-12-23 18:48:32 +01:00
```
{
2021-01-06 03:22:25 +01:00
"dataPath": "<path to your home directory>/.local/share/FoundryVTT"
2020-12-23 18:48:32 +01:00
}
```
2021-01-06 03:22:25 +01:00
On platforms other than Linux you need to adjust the path accordingly.
2020-12-23 20:33:19 +01:00
Then run
```
2021-02-11 13:57:14 +01:00
yarn link-project
2020-12-23 20:33:19 +01:00
```
2021-01-06 03:22:25 +01:00
### Running the tests
You can run the tests with the following command:
2020-12-23 18:48:32 +01:00
```
2021-02-11 13:57:14 +01:00
yarn test
2020-12-23 18:48:32 +01:00
```
2020-12-31 05:02:38 +01:00
2021-01-06 03:22:25 +01:00
## Contributing
Code and content contributions are accepted. Please feel free to submit issues
2021-01-25 14:16:14 +01:00
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].
2021-01-06 03:22:25 +01:00
## Licensing
2020-12-31 05:02:38 +01:00
[Dungeonslayers] (© Christian Kennig) is licensed
under [CC BY-NC-SA 3.0].
2020-12-31 05:02:38 +01:00
The icons in [src/assets/icons/official] are slightly
2021-01-25 14:16:14 +01:00
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].
2020-12-31 05:02:38 +01:00
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].
2021-06-14 17:41:44 +02:00
The images in [src/assets/tokens/devins-token-packs] have been published on
https://immortalnights.com/product/all-free-tokens-in-one-file/. You can find
the "Token Usage Rights" under https://immortalnights.com/tokens/token-usage-rights/
2021-01-06 03:22:25 +01:00
The software component of this project is licensed under the MIT License, a copy
of which can be found under [LICENSE](LICENSE).
[Foundry Virtual Tabletop]: http://foundryvtt.com
[git+dungeonslayers-ds4-155-issue-@git.f3l.de]: mailto:git+dungeonslayers-ds4-155-issue-@git.f3l.de
[CC BY-NC-SA 3.0]: https://creativecommons.org/licenses/by-nc-sa/3.0/de/deed.en
[Dungeonslayers]: http://dungeonslayers.de/
[src/assets/icons/official]: src/assets/icons/official
[src/assets/icons/official/LICENSE]: src/assets/icons/official/LICENSE
[src/packs]: src/packs
[src/assets/icons/game-icons]: src/assets/icons/game-icons
[src/assets/icons/game-icons/authors.md]: src/assets/icons/game-icons/authors.md
2021-06-14 17:41:44 +02:00
[src/assets/tokens/devins-token-packs]: src/assets/tokens/devins-token-pack