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, find it in the list in the Install System dialog on the Setup menu of the application. Alternatively, paste the following Manifest URL in that dialog:

https://git.athemis.de/api/packages/Athemis/generic/ds4/latest/system.json

Development

Prerequisites

In order to build this system, recent versions of node and pnpm are required. Most likely using npm or yarn also works but only pnpm is officially supported. We recommend using the latest lts version of node. 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 project's dependencies. To do so, run

pnpm install

Building

You can build the project by running

pnpm build

Alternatively, you can run

pnpm 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

pnpm link-package

Running the tests

You can run the tests with the following command:

pnpm test

Git Hooks

This project uses Husky to enforce code quality through Git hooks:

Pre-commit Hook

Automatically runs before each commit to ensure code is properly formatted:

pnpm format:check

If the check fails, run pnpm format to fix formatting issues.

Commit Message Hook

Validates that commit messages follow the Conventional Commits specification:

• Format: type(scope): subject
• Types: feat, fix, docs, style, refactor, perf, test, chore
• Example: feat(actor): add group actor sheet

The hooks are automatically installed when you run pnpm install (via the prepare script).

Manual Validation

You can manually check your code before committing:

# Check formatting
pnpm format:check

# Fix formatting
pnpm format

# Validate last commit message
pnpm exec commitlint --from HEAD~1

Contributing

Code and content contributions are accepted. To report issues, please contact us in Matrix.

Licensing

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. REUSE is used to specify the licenses for the individual files. Most of the licenses are specified either inside the source file or by an accompanying .license file, but for some files, the licenses are specified in .reuse/dep5. Some of the work that is being reused by this project requires attribution to the original author(s). You can find these attributions in ATTRIBUTION.md.