# Foundryborne Daggerheart

## Table of Contents

- [Overview](#overview)
- [User Install Guide](#user-install)
- [Documentation](#documentation)
- [Developer Setup](#development-setup)
- [Contribution Info](#contributing)

## Overview

This is the community repo for the Foundry VTT system _Foundryborne_ Daggerheart. It is not associated with Critical Role or Darrington Press.

## User Install

1. **Recommended** Searching for _Daggerheart_ or _Foundryborne_ in the System Installation dialogue of the FoundryVTT admin settings.
2. Pasting `https://raw.githubusercontent.com/Foundryborne/daggerheart/refs/heads/main/system.json` into the Install System dialog on the Setup menu of the application.
3. Downloading one of the .zip archives from the Releases page and extracting it into your foundry Data folder, under Data/systems/daggerheart.

## Documentation

You can find the documentation here: https://github.com/Foundryborne/daggerheart/wiki

## Development Setup

1. **Navigate to the repo directory:**

    ```bash
    cd <path>/<to>/<repo>
    ```

2. **Install dependencies:**

    ```bash
    npm install
    ```

3. **Configure your Foundry paths:**

    Copy `.env.example` to `.env` and set up the foundry path and data path. The foundry path must point to main.js, and the data path must point the folder containing the Data folder itself (but not the `Data` folder itself).

4. **Setup symlinks:**

    In a shell with elevated privilages, run `npm run createSymlink`. It will add a foundry folder for types, and add a symlink to the daggerheart folder into your foundry data.

5. **Start developing:**
    ```bash
    npm start
    ```

### Available Scripts

- `npm start` - Start development with file watching and Foundry launching
- `npm run build` - One-time build
- `npm run createSymlink` - Setup types and output symlinks

### Notes

- The repo should be placed in your Foundry `Data/systems/` directory or symlinked there
- Linux symlink can be made using `ln -snf <path to development folder> daggerheart` inside the systems folder
- Your `.env` file is ignored by git, so each developer can have their own configuration
  [Foundry VTT Website][1]

[1]: https://foundryvtt.com/

## Contributing

Looking to contribute to the project? Look no further, check out our [contributing guide](CONTRIBUTING.md), and keep the [Code of Conduct](coc.md) in mind when working on things.

## AI Policy

The Foundryborne Daggerheart system does not make use of AI (generative or otherwise) for any area of its implementation. We expect all contributors to follow this same policy when contributing with a pull request; contributions made using AI will be rejected outright.

## Disclaimer:

**Daggerheart System**
Daggerheart is a trademark of Darrington Press LLC. All original content, mechanics, and intellectual property related to the Daggerheart roleplaying game are © Darrington Press LLC.

This project is intended for personal or non-commercial use. All rights to Daggerheart’s original materials remain with their respective owners.

**Free Icons**
Some Icons used in this project are provided by https://game-icons.net and are licensed under the Creative Commons Attribution 3.0 Unported (CC BY 3.0).

This project is an unofficial fan creation and is not affiliated with or endorsed by Darrington Press or Critical Role.
