Initial commit

2024-05-04 19:45:07 +10:00 · 2024-05-04 19:45:07 +10:00 · 03761d2e2f
commit 03761d2e2f
17 changed files with 5662 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,51 @@
+![Downloads](https://img.shields.io/github/downloads/Larkinabout/fvtt-token-action-hud-template/latest/module.zip?color=2b82fc&label=DOWNLOADS&style=for-the-badge) [![Forge Installs](https://img.shields.io/badge/dynamic/json?label=Forge%20Installs&query=package.installs&suffix=%25&url=https%3A%2F%2Fforge-vtt.com%2Fapi%2Fbazaar%2Fpackage%2Ftoken-action-hud-template&colorB=448d34&style=for-the-badge)](https://forge-vtt.com/bazaar#package=token-action-hud-template)
+
+# Token Action HUD Template
+
+Token Action HUD is a repositionable HUD of actions for a selected token.
+
+![Token Action HUD](.github/readme/token-action-hud.gif)
+
+# Features
+- Make rolls directly from the HUD instead of opening your character sheet.
+- Use items from the HUD or right-click an item to open its sheet.
+- Move the HUD and choose to expand the menus up or down.
+- Unlock the HUD to customise layout and groups per user, and actions per actor.
+- Add your own macros, journal entries and roll table compendiums.
+
+# 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 Pathfinder 2** 
+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/Larkinabout/fvtt-token-action-hud-template/releases/latest/download/module.json`
+4. Click **Install** next to the pasted Manifest URL
+
+## Required Modules
+
+**IMPORTANT** - Token Action HUD Template 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/Larkinabout/fvtt-token-action-hud-core/wiki/How-to-Use-Token-Action-HUD)
+
+For questions, feature requests or bug reports, please open an issue [here](https://github.com/Larkinabout/fvtt-token-action-hud-core/issues).
+
+Pull requests are welcome. Please include a reason for the request or create an issue before starting one.
+
+# Acknowledgements
+
+Thank you to the Community Helpers on Foundry's Discord who provide tireless support for people seeking help with the HUD.
+
+# 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/).