diff --git a/README.md b/README.md new file mode 100644 index 0000000..102cc52 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +---------------------------------------------------------------------- +-- ThreatPlates v1.1.0 +-- Threat percentage bars above nameplates +-- Styled after Kui Nameplates +-- Standalone - no dependencies required +-- Compatible with WoW 1.12 (Vanilla / Turtle WoW / Octo WoW) +---------------------------------------------------------------------- + += ThreatPlates = + +Shows a threat percentage bar above each nameplate's health bar. +The bar grows from 0% to 100% based on your threat level against +that unit, with colour coding from green (low) to red (aggro). + +== Features == + + * Threat bar above the in-game health bar on nameplates + * Percentage text displayed inside the bar + * Smooth colour gradient: green -> yellow -> orange -> red + * Kui Nameplates-style visuals (dark backgrounds, 1px inset, + spark effects, glow/shadow borders, outline fonts) + * Completely standalone - no dependencies + * Configuration GUI for all settings + * Works with Turtle WoW / Octo WoW (Vanilla 1.12 client) + +== Commands == + + /tp - Open the configuration GUI + /tp toggle - Toggle threat bars on/off + /tp reset - Reset settings to defaults + /tp help - Show help + +== Configuration == + +All settings are accessible via the /tp GUI: + + General: + - Enable Threat Plates (on/off) + - Show Threat Text (percentage in bar) + - Smooth Colours (gradient transitions) + + Appearance: + - Bar Height (2-12 px) + - Bar Offset Y (-20 to 0 px) + - Bar Alpha (0.1-1.0) + - Font Size (6-14 pt) + - Font Outline + + Kui Style Effects: + - Show Spark (bright leading edge) + - Show Fill Background (dim ghost behind bar) + - Fill Alpha (0.05-0.50) + - Enable Glow (border glow based on threat) + - Glow as Shadow (subtle vs bright) + - Glow Size (1-8 px) + + Display Filters: + - Show on Hostile units + - Show on Neutral units + - Show on Friendly units + +== Threat Detection == + +ThreatPlates uses a three-tier threat detection system: + + 1. UnitDetailedThreatSituation (Turtle WoW extension) - most accurate + 2. GetThreatPercent API (if available) - precise percentage + 3. UnitThreatSituation with heuristics - fallback estimation + +The addon polls threat every 0.2 seconds and updates nameplate +visuals every 0.3 seconds for smooth animation. + +== Installation == + + 1. Extract the ThreatPlates folder to your Interface/AddOns/ directory + 2. Restart WoW or reload the UI (/console reloadui) + 3. Type /tp to configure + +== Version History == + + v1.1.0 - Complete rewrite for Turtle WoW compatibility + - Fixed Lua 5.0/1.12 parser issues (no varargs, no string.match) + - Fixed bare format/floor globals (use string.format/math.floor) + - Fixed CheckButton SetBackdrop (use Frame + textures instead) + - Added pcall() safety for nameplate child scanning + - Cached GetChildren/GetRegions calls for performance + - Three-tier threat detection with fallback heuristics