You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update CHANGELOG and README for v2.0.0 feature additions
CHANGELOG (v2.0.0 section):
- Added entries for !aura reset-fx, !aura reset-all, !aura settings,
Aura 1/2 detail commands, public settings snapshot, and !aura on/off
semantics change. Bumped schema version entry to 1.1.0.
- Added Fixed entries for FX color assignment, random channel
neutralization, spawnFx fallback path, particle profile tuning,
BAR validation, empty bar_max handling, Aura 1/2 output rows,
settings output deduplication, and proactive FX definition sync.
README:
- Document !aura settings, !aura a1shape/a1tint/a2size/a2shape/a2tint,
!aura reset-fx, and !aura reset-all commands.
- Update !aura bar description to include immediate token sync behavior.
- Update !aura heal default hint to FDDC5C.
- Add note about Aura 1/2 detail rows in settings output.
- Note that setting changes post a single game-chat snapshot.
- Add troubleshooting notes for FX rendering variance and missing
bar max value.
Signed-off-by: Steve Roberts <steve@shadowcomputers.co.uk>
Copy file name to clipboardExpand all lines: HealthColors/CHANGELOG.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,35 @@ Major modernization and stability refactor of the entire script, consolidating p
14
14
-**Persistent Default Auras** — tokens at 100% health now default to a clean **Green** Aura 1 (at the configured `AuraSize`) to indicate stability.
15
15
-**JSDoc Documentation** — every function is now fully documented with parameter types, return values, and behavioral descriptions to improve maintainability.
16
16
-**Centralized Configuration** — all default state values, FX definitions, and internal parameters are now managed via unified constants.
17
+
-**FX Recovery Commands** — added `!aura reset-fx` (rebuild default heal/hurt custom FX objects) and `!aura reset-all` (restore all settings to defaults + rebuild default FX + force update).
18
+
-**Public Settings Snapshot** — setting-changing `!aura` commands now post a read-only settings panel to game chat for table visibility.
19
+
-**Aura Detail Commands** — added `!aura a1shape`, `!aura a1tint`, `!aura a2size`, `!aura a2shape`, and `!aura a2tint` to adjust displayed Aura 1/Aura 2 detail values from chat.
20
+
-**Settings Output Command** — added `!aura settings` to post the current settings snapshot to game chat on demand.
17
21
18
22
### Changed
19
23
-**`_` (Underscore) dependency** — no longer required.
20
24
-**`buttonColor` function** — legacy function completely removed after
21
25
verifying no external or internal dependencies; superseded by `nameBtn`.
22
26
-**Tautological FX condition**`(UseBlood !== "OFF" || UseBlood !== "NO")`.
27
+
-**`!aura on/off` semantics** — now explicitly sets global enabled state instead of toggling on `on`.
28
+
-**Schema version** — bumped to `1.1.0` to reflect incremental state/data migration changes in the v2.0.0 line.
23
29
24
30
### Fixed
25
31
- Consistent casing for `checkInstall` and `handleToken` throughout.
26
32
- Initialization of `OneOff` state key to prevent `undefined` collisions.
27
-
- Corrected logic in `playDeath` to ensure jukebox tracks are properly stopped
28
-
before restarting.
33
+
- Corrected logic in `playDeath` to ensure jukebox tracks are properly stopped before restarting.
29
34
- Page scale calculation and aura radius math standardized for better precision.
35
+
- Heal and hurt FX color assignment now resolves `startColour`/`startColor` and `endColour`/`endColor` consistently, preventing gray/white fallback artifacts.
36
+
- Default heal/hurt FX random color channels are explicitly neutralized during spawn preparation to preserve configured color fidelity.
37
+
- Added a fallback spawn path that updates and triggers default custom FX by id (`spawnFx`) when definition-based spawning renders colors inconsistently.
38
+
- Tuned default heal/hurt particle profile values for clearer saturation and reduced washed-out appearance in experimental sandboxes.
39
+
-`!aura bar` now validates `1|2|3`, whispers confirmation on change, and immediately runs a full sync to apply the new bar selection.
40
+
- Tokens with no `max` value on the configured bar now have aura/tint cleared, preventing stale health indicators.
41
+
- Configuration output now explicitly includes Aura 2 detail rows in both the GM menu and public settings snapshot.
42
+
- Prevented duplicate settings output: setting-changing commands now publish a single game-chat snapshot instead of both GM and public panels.
43
+
- Aura 2 output values are now sourced from state-backed defaults (`Aura2Size`, `Aura2Shape`, `Aura2Color`) instead of hardcoded labels.
44
+
- Added Aura 1 Shape/Tint rows to settings output and backed them with default state values (`Aura1Shape`, `Aura1Color`).
45
+
- Default heal/hurt custom FX definitions are now synchronized proactively on install/reset and when FX colors change, preventing delayed/stale visual updates after color edits or token lifecycle events.
30
46
31
47
32
48
---
@@ -37,8 +53,7 @@ Major modernization and stability refactor of the entire script, consolidating p
37
53
38
54
## [1.6.0] – 2020-08-19
39
55
40
-
- Added per-character `USEBLOOD` attribute support for custom FX colours and
41
-
named custom FX overrides.
56
+
- Added per-character `USEBLOOD` attribute support for custom FX colours and named custom FX overrides.
Copy file name to clipboardExpand all lines: HealthColors/README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,7 @@
9
9
-**Dynamic Color Shifting**: Automatically transitions from Green (Healthy) to Red (Critical) as health drops.
10
10
-**Aura & Tint Modes**: Choose between a glowing health ring (Aura 1) or a full token color overlay (Tint).
11
11
-**Aura 1 Exclusive Management**: The script only manages Aura 1. You are free to manually use Aura 2 for range indicators, light sources, or status markers without script interference.
12
+
-**Aura 1 & Aura 2 Details in Output**: Settings output includes Aura 1 Shape/Tint and Aura 2 Radius/Shape/Tint rows using state-backed defaults for clear reference.
12
13
-**Manual Overrides**: Visual updates are only triggered when health values change. You can manually adjust colors or radii in the token settings, and they will "stick" until the next time the token takes damage or heals.
13
14
-**Blood & Heal FX**: Spawns custom particle effects when tokens are hurt or healed.
14
15
-**Automated Dead Status**: Automatically applies a configurable status marker (default: Red X) when a token reaching 0 HP.
@@ -30,24 +31,33 @@
30
31
### The Configuration Menu
31
32
32
33
Type `!aura` in the chat to open the interactive configuration menu. From here, you can toggle all features and adjust percentages.
34
+
When a command changes a setting, HealthColors posts a single read-only settings snapshot to game chat (instead of duplicating menu output).
|`!aura bar <1/2/3>`| Sets which token bar represents health and immediately forces a full token sync. |
44
52
|`!aura pc / !aura npc`| Toggles health tracking for PCs or NPCs. |
45
53
|`!aura perc <PC> <NPC>`| Sets the health percentage at which the aura appears (e.g., `!aura perc 100 100`). |
46
54
|`!aura dead / !aura deadPC`| Toggles the automatic "Dead" status marker. |
47
55
|`!aura fx`| Toggles particle effects for damage and healing. |
48
-
|`!aura heal <hex>`| Sets the color of healing particle effects (e.g., `!aura heal 00FF00`). |
56
+
|`!aura heal <hex>`| Sets the color of healing particle effects (e.g., `!aura heal FDDC5C`). |
49
57
|`!aura hurt <hex>`| Sets the color of damage particle effects (e.g., `!aura hurt FF0000`). |
50
58
|`!aura reset`| Resets the script's state to factory defaults. |
59
+
|`!aura reset-fx`| Rebuilds `-DefaultHeal` and `-DefaultHurt` custom FX objects. |
60
+
|`!aura reset-all`| Restores all settings to `DEFAULTS`, rebuilds default FX, and force-syncs tokens. |
51
61
52
62
---
53
63
@@ -56,6 +66,8 @@ Type `!aura` in the chat to open the interactive configuration menu. From here,
56
66
-**Aura Visibility**: If you are using a 5ft grid and set the Aura 1 radius to `0.7`, it may be hidden by the token image. Increase the radius (e.g., `3.0`) if you want the health ring to be visible outside the token's edge.
57
67
-**Manual Changes**: If you manually change a token's aura color or radius in the Roll20 dialog, it will stay that way as long as the token's health doesn't change. Once health is updated, the script will re-sync the visuals to the calculated health color.
58
68
-**One-Off Tokens**: You can toggle "One-Offs" in the settings to enable health tracking for tokens that are not linked to a character sheet.
69
+
-**FX Rendering Variance**: Some Roll20 sandbox/client combinations can render `spawnFxWithDefinition` colors inaccurately. HealthColors uses a fallback that updates default custom FX objects and spawns by FX ID to keep heal/hurt colors consistent.
70
+
-**Missing Max HP**: If the configured health bar has no `max` value on a token, HealthColors now clears that token's aura/tint until a max value is set.
0 commit comments