seed: initial README

This commit is contained in:
2026-06-20 04:28:37 +00:00
commit aa5e95e44a

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
# Hax's Tools — Hooks Lib
Foundry VTT module: turns Foundry's hook soup (dnd5e, combat, token updates) into a clean normalized event stream. Works independently of any specific consumer (Battle Focus uses it; other modules can too).
## Status
Not yet implemented. Sourced from battle-focus `scripts/events/core/` and `scripts/events/registry.js`. Coming soon to a separate repo.
## Planned Event Shape
```json
{
"kind": "combat-start | combat-end | combat-turn | combat-round | ...",
"ts": <epoch_ms>,
...
}
```
Includes:
- combat lifecycle (combat-start, combat-end, combat-turn, combat-round, combatant-add, combatant-remove)
- token/actor updates (pre-update-actor, update-actor, pre-update-token, update-token, pre-update-item, update-item)
- effects (create-active-effect, delete-active-effect)
- dnd5e rolls (roll-attack, roll-damage)
- token avatar change
## Maintained by Kaysser Taylor + Hermes