mirror of
https://github.com/Foundryborne/daggerheart.git
synced 2026-01-11 19:25:21 +01:00
495575fba4
* add typo report template (#971) Co-authored-by: Psitacus <walther.johnson@ucalgary.ca> * Fix/fix weapon damage datas in sheet (#988) * Temp ActionField attack type missing * Move missing attack type to getModel * Fix weapon base attack reseting on update * [PR]Fix/allow deal damage button use owner (#985) * Temp ActionField attack type missing * Move missing attack type to getModel * Fix player not allowed to use Deal Damage button if Actor not assigned * Fix/add translation key for Unarmed Attack (#973) Co-authored-by: Chris Ryan <chrisr@blackhole> * Add setup script for development (#981) * [PR] testing something (#995) * testing something * added template for PR test * Initial Commit (#992) --------- Co-authored-by: Psitacus <59754077+Psitacus@users.noreply.github.com> Co-authored-by: Psitacus <walther.johnson@ucalgary.ca> Co-authored-by: Dapoulp <74197441+Dapoulp@users.noreply.github.com> Co-authored-by: Chris Ryan <73275196+chrisryan10@users.noreply.github.com> Co-authored-by: Chris Ryan <chrisr@blackhole> Co-authored-by: Luiz HD Costa <luiz.costa@hey.com> Co-authored-by: Nikhil Nagarajan <potter.nikhil@gmail.com>
79 lines
2.7 KiB
Markdown
79 lines
2.7 KiB
Markdown
# 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:**
|
||
|
||
```bash
|
||
npm run setup:dev -- --foundry-path="/path/to/foundry/main.js" --data-path="/path/to/data"
|
||
```
|
||
|
||
4. **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 setup:dev -- --foundry-path="<path>" --data-path="<path>"` - Configure development environment
|
||
|
||
### 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.
|
||
|
||
## 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.
|