ds4/README.md

143 lines
4.1 KiB
Markdown
Raw Normal View History

2021-06-26 22:02:00 +02:00
<!--
SPDX-FileCopyrightText: 2021 Johannes Loher
SPDX-FileCopyrightText: 2021 Siegfried Krug
SPDX-License-Identifier: MIT
-->
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
2021-06-26 22:02:00 +02:00
`v14.17.1` at the time of writing. If you use `nvm` to manage your `node`
2021-02-11 13:57:14 +01:00
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
2021-06-26 22:02:00 +02:00
This project is being developed under the terms of the
[LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT] for Foundry Virtual Tabletop.
The project itself is licensed under multiple licenses. It is difficult to keep
this section up to date, so here is a brief summary as of June 2021:
* [Dungeonslayers] by Christian Kennig is licensed under [CC BY-NC-SA 3.0].
* The icons in [src/assets/icons/official] by Christian Kennig are licensed
under [CC BY-NC-SA 3.0].
* The compendium packs in [src/packs] are derivative work of [Dungeonslayers]
by Christian Kennig. They are licensed under [CC BY-NC-SA 3.0].
2021-06-27 00:21:23 +02:00
* The icons in [src/assets/icons/game-icons] by the authors of [Game-icons.net]
are licensed under [CC BY 3.0].
2021-06-26 22:02:00 +02:00
* The [Lora] font in [src/fonts/Lora] by The Lora Project Authors is licensed
under [OFL 1.1].
* The Woodstamp font in [src/fonts/Woodstamp] by [Ryoichi Tsunekawa] is licensed
under a custom [EULA](LICENSES/LicenseRef-Woodstamp.txt).
* The files in [.yarn] by the [Yarn] Contributors are licensed under
[BSD-2-Clause].
* Most of the other files are licensed under [MIT].
For more accurate information, check the individual files.
[Foundry Virtual Tabletop]: http://foundryvtt.com
[git+dungeonslayers-ds4-155-issue-@git.f3l.de]: mailto:git+dungeonslayers-ds4-155-issue-@git.f3l.de
[Dungeonslayers]: http://dungeonslayers.de/
2021-06-27 00:21:23 +02:00
[Game-icons.net]: https://game-icons.net/
2021-06-26 22:02:00 +02:00
[Lora]: https://github.com/cyrealtype/Lora-Cyrillic
[Ryoichi Tsunekawa]: https://dharmatype.com/
[Yarn]: https://github.com/yarnpkg/berry
[LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT]: https://foundryvtt.com/article/license/
[CC BY-NC-SA 3.0]: LICENSES/CC-BY-NC-SA-3.0.txt
[CC BY 3.0]: LICENSES/CC-BY-3.0.txt
[OFL 1.1]: LICENSE/OFL-1.1.txt
[BSD-2-Clause]: LICENSES/BSD-2-Clause.txt
[MIT]: LICENSES/MIT.txt
[src/assets/icons/official]: src/assets/icons/official
[src/packs]: src/packs
[src/assets/icons/game-icons]: src/assets/icons/game-icons
2021-06-26 22:02:00 +02:00
[src/fonts/Lora]: src/fonts/Lora
[src/fonts/Woodstamp]: src/fonts/Woodstamp
[.yarn]: .yarn