feat: Add README.md to document the Daggerheart Fear Tracker Plus module.
This commit is contained in:
parent
b570a9dd8b
commit
8a01374d3f
1 changed files with 43 additions and 0 deletions
43
README.md
Normal file
43
README.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# Daggerheart Fear Tracker Plus
|
||||
|
||||
**Daggerheart Fear Tracker Plus** is a Foundry VTT module that provides extensive customization options for the Foundryborne Daggerheart system's Fear Tracker. Personalize your game's atmosphere with custom icons, color themes, and sizing options.
|
||||
|
||||
## Features
|
||||
|
||||
### 🎨 Custom Themes
|
||||
Choose from a variety of pre-defined color themes or create your own!
|
||||
- **Foundryborne (Default)**: Matches the system's default style.
|
||||
- **Hope & Fear**: A dynamic orange-to-purple gradient.
|
||||
- **Blood Moon**: Deep red gradient suitable for horror themes.
|
||||
- **Ethereal**: Cyan-to-blue magical aesthetic.
|
||||
- **Toxic**: Green-to-yellow hazard theme.
|
||||
- **Custom**: Define your own start/end gradient colors or solid colors.
|
||||
|
||||
### 🖌️ Icon Customization
|
||||
Replace the default fear tokens with something that fits your campaign:
|
||||
- **Preset List**: Choose from built-in FontAwesome icons like Skulls, Ghosts, Spiders, and more.
|
||||
- **Custom FontAwesome**: Enter any FontAwesome class code (e.g., `fas fa-dragon`). Includes a **real-time preview** in settings!
|
||||
- **Custom SVG**: Upload your own SVG image files to use as fear tokens.
|
||||
|
||||
### 📏 Tracker Scaling
|
||||
Is the Fear Tracker taking up too much screen space? Or maybe it's too small?
|
||||
- **Resize**: Scale the tracker from 0.25x to 2.0x.
|
||||
- **Reset**: Easily restore the default size with a single click.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Open Foundry VTT and go to the **Add-on Modules** tab.
|
||||
2. Click **Install Module**.
|
||||
3. Paste the following Manifest URL into the field:
|
||||
```
|
||||
https://github.com/cptn-cosmo/dh-feartrackerplus/releases/latest/download/module.json
|
||||
```
|
||||
or search for Fear Tracker Plus in the Foundry VTT Add-on Modules tab.
|
||||
4. Click **Install**.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Enable the module in your world's **Manage Modules** settings.
|
||||
2. Go to **Configure Settings** > **Daggerheart Fear Tracker Plus**.
|
||||
3. Adjust the settings to your preference. Changes apply immediately or upon closing the settings window.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue