dh-actor-updater/README.md

48 lines
1.8 KiB
Markdown

# Daggerheart Actor Updater
A FoundryVTT module for the Daggerheart system that automatically checks your actors for outdated items against the SRD Compendium.
## Features
- **Automatic Checks**: Checks for updates on first load and whenever the Daggerheart system version changes.
- **Manual Check**: API available for macros/manual checks.
- **Detailed Comparison**: Compares names, images, and system data (descriptions, damage, etc.).
- **Selective Updates**: Choose which items to update or ignore specific items (e.g., custom homebrew items).
- **Supports**: Classes, Subclasses, Ancestries, Communities, Domains, Weapons, Armor, Consumables, Loot, and Beastforms.
## Installation
### Installation via Manifest URL
1. In Foundry VTT, go to the **Add-on Modules** tab.
2. Click **Install Module**.
3. Paste the following URL into the **Manifest URL** field:
```
https://git.geeks.gay/cosmo/dh-actor-updater/raw/branch/main/module.json
```
4. Click **Install**.
## Usage
1. Enable the module in your world settings.
2. On login (if a new system version is detected) or via macro, the "Daggerheart Actor Updater" window will appear if differences are found.
3. Review the list of changes.
4. Click **Update** to sync with the compendium.
5. Click **Ignore** to suppress warnings for a specific item (useful for customized items).
## Manual Check
To manually trigger a check, you can use the button in the module settings or run the following macro code:
```javascript
game.modules.get('dh-actor-updater').api.checkAll();
```
## Compatibility
- **Foundry VTT**: v13+
- **Daggerheart System**: Verified on 1.5.4
## Important Note
This module modifies your actor data directly. **Always back up your world** before performing bulk updates, especially if you have significant customizations on your actors.