# Token Action HUD Ironsworn

![GitHub all releases](https://img.shields.io/github/downloads/jendave/token-action-hud-ironsworn/total)
[![Latest Version](https://img.shields.io/github/v/release/jendave/token-action-hud-ironsworn?display_name=tag&sort=semver&label=Latest%20Version)](https://github.com/jendave/token-action-hud-ironsworn/releases/latest)
![Foundry Version](https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https%3A%2F%2Fraw.githubusercontent.com%2Fjendave%2Ftoken-action-hud-ironsworn%2Fmain%2Fmodule.json)
[![License](https://img.shields.io/github/license/jendave/token-action-hud-ironsworn)](LICENSE)

The `Token Action HUD Ironsworn` is a repositionable HUD of actions for a selected token for the Ironsworn and Ironsworn: Starforged family of games.

## HUD Features

* Open moves, assets, progress tracks, connections and bondsets.
* Make stat and meter rolls directly from the HUD.
* Increase and decrease meters.
* Toggle impacts and combat position.
* View and increase Legacy tracks.
* Mark progress, make Progress Rolls for Connection, Vow and Progress tracks.
* Create new Connection, Vow and Progress tracks.
* Make Progress Roll for Ironsworn Bondset track.
* Tooltips for Stats, Meters, Impacts, and Combat Position.
* Move the HUD and choose to expand the menus up or down.

### Supported Systems

* [Ironsworn & Ironsworn: Starforged](https://foundryvtt.com/packages/foundry-ironsworn)

## Installation

### Method 1

1. On Foundry VTT's **Configuration and Setup** screen, go to **Add-on Modules**
2. Click **Install Module**
3. Search for **Token Action HUD Ironsworn**
4. Click **Install** next to the module listing

### Method 2

1. On Foundry VTT's **Configuration and Setup** screen, go to **Add-on Modules**
2. Click **Install Module**
3. In the Manifest URL field, paste: `https://github.com/jendave/token-action-hud-ironsworn/releases/latest/download/module.json`
4. Click **Install** next to the pasted Manifest URL

### Required Modules

**IMPORTANT** Token Action HUD Ironsworn/Starforged requires the [Token Action HUD Core](https://foundryvtt.com/packages/token-action-hud-core) module to be installed.

### Recommended Modules

Token Action HUD uses the [Color Picker](https://foundryvtt.com/packages/color-picker) library module for its color picker settings.

## Support

For a guide on using Token Action HUD, go to: [How to Use Token Action HUD](https://github.com/jendave/token-action-hud-ironsworn/wiki/How-to-Use-Token-Action-HUD)

For questions, feature requests or bug reports, please open an [issue](https://github.com/jendave/token-action-hud-ironsworn/issues).

[Pull requests](https://github.com/jendave/token-action-hud-ironsworn/pulls) are welcome. Please include a reason for the request or create an issue before starting one.

## Troubleshooting and Tips

* If the HUD layout appears incomplete or is inconsistent among users:
  * In `Configure Settings`, select `Token Action HUD Core`, select `Layout`, click on `Reset All Layouts` and click on `Yes`.
  * This will reset the layout for all users.
* When a Move is selected from the HUD, the auto-scrolling in the Move Sheet does not always work. Clicking on the HUD item twice should work.

## Acknowledgements

Created for the incredible [Ironsworn & Ironsworn: Starforged](https://tomkinpress.com/) family of games.

Many thanks to Ben Straub for his fantastic [Ironsworn & Starforged Game System](https://foundryvtt.com/packages/foundry-ironsworn).

Many thanks to the [Datasworn](https://github.com/tbsvttr/datasworn) project for distilling the rules into a JSON format.

## License

This Foundry VTT module is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) and this work is licensed under [Foundry Virtual Tabletop EULA - Limited License Agreement for module development](https://foundryvtt.com/article/license/).

## Contact

* [Ironsworn/Starforged Discord Server - FoundryVTT Channel](https://discord.com/channels/437120373436186625/867434336201605160) (jendave)
* [FoundryVTT Discord Server - Module Discussion Channel](https://discord.com/channels/170995199584108546/513918036919713802) (jendave)
* [VOID Affiliate Network Discord Server - Game Hacks Channel](https://discord.com/channels/1222986351272787990/1222986351792619687) (jendave)
* [GitHub Repository](https://github.com/jendave/token-action-hud-ironsworn)
* [Itch.io](https://jendave.itch.io/)

## FoundryVTT Modules and Other Resources

Please check out my other modules and resources for Ironsworn, Ironsworn: Starforged and other systems.

### [FoundryVTT](https://foundryvtt.com/community/david-hudson/packages) Modules

* [Starforged Custom Compendiums](https://foundryvtt.com/packages/starforged-custom-oracles)
* [Starsmith Compendiums for Ironsworn: Starforged](https://foundryvtt.com/packages/starsmith-expanded-oracles)
* [Ironsmith Expanded Oracles for Ironsworn](https://foundryvtt.com/packages/ironsmith-expanded-oracles)
* [Augmented Reality Cyberpunk City Kit](https://foundryvtt.com/packages/augmented-reality-foundry)
* [Token Note Hover](https://github.com/jendave/token-note-hover)
* [Token Action HUD Ironsworn](https://foundryvtt.com/packages/token-action-hud-ironsworn)
* [VOID 1680 AM for FoundryVTT](https://foundryvtt.com/packages/void-1680-am)
* [Ancient Wonders](https://foundryvtt.com/packages/ancient-wonders)
* [Rise & Shiningstar * An Adventure for Ironsworn: Starforged](https://foundryvtt.com/packages/rise-and-shining-star)
* [Roll Table Importer](https://foundryvtt.com/packages/roll-table-importer)
* [Ironsworn Impacts](https://foundryvtt.com/packages/ironsworn-impacts)

### [Itch.io](https://jendave.itch.io/) Resources

* [The City on the Breeze * Cyberpunk-inspired Oracle arrays](https://jendave.itch.io/the-city-on-the-breeze)
* [I'll Be Home for Life Day! * Star Wars Life Day Oracle](https://jendave.itch.io/ill-be-home-for-life-day)
* [Critical Success Oracles](https://jendave.itch.io/critical-success-oracles)
* [I Owe My Soul to the Company Planet Oracles](https://jendave.itch.io/i-owe-my-soul-to-the-company-planet)
* [Creature Rank Generator](https://jendave.itch.io/creature-rank-generator)