From 9beff39cc7ddccfbd08ecdd4643f29e18786c0ff Mon Sep 17 00:00:00 2001 From: Wurmschwanz Date: Sun, 30 Aug 2026 17:09:10 +0200 Subject: [PATCH] Revise README for version 1.0.8 updates Updated README to reflect changes in version 1.0.8, including new features and adjustments to existing functionalities. --- README.md | 247 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 209 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index c6d70b8..b9b73df 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,144 @@ # ⚔️ Blizz Nameplates+ -**Blizz Nameplates+** enhances the original Blizzard nameplates for **Vanilla WoW / 1.12** while preserving their classic look. +**Blizz Nameplates+** enhances the original Blizzard nameplates for **Vanilla WoW / WoW 1.12** while preserving their classic look and feel. -It adds multi-target aura tracking, castbars, Crowd Control, Combo Points and useful visual options without replacing the original nameplate design. +It adds reliable multi-target aura tracking, Crowd Control, castbars, Combo Points, PvP totem indicators and additional visual customization without replacing the original Blizzard nameplate design. -**Current version:** `v1.0.7` +**Current version:** `v1.0.8` **Required:** `SuperWoW.dll` and `ClassicAPI.dll` +--- + ## ✨ Features -* GUID-based multi-target debuff and DoT tracking -* Numeric aura timers and stack counters -* Separate Crowd Control tracking with an optional dedicated row -* Optional supported CC effects from other players -* Enemy castbars with spell icons -* Blizzard-style Combo Points for Rogues and Druids -* Target Glow and Target Plate on Top -* Health text, class colors and Tank Mode -* Foreign-tagged mobs shown with a neutral grey healthbar -* Adjustable nameplate scale, Y offset, aura size and non-target alpha -* Instant target-alpha updates and clean nameplate/aura layering -* In-game settings through the **BN+ minimap button** or `/bnp` +### 🎯 Nameplates -## 🔎 New: Missing Spell / Aura Recorder +- Adjustable nameplate scale and Y offset +- Adjustable non-target alpha +- Enemy class colors +- Tank Mode +- Health text options +- Foreign-tagged mobs shown with a neutral grey healthbar +- Target Glow with selectable glow color +- Target Plate on Top +- Clean nameplate and aura layering -Missing a spell, DoT, proc or custom-server aura? The new recorder creates one complete, copyable diagnostic report—no screenshots or manual chat commands required. +### ☠️ Auras & Debuffs -1. Open the BNP settings and click **Missing Spell / Aura...** -2. Select the affected unit. -3. Click **Start Recording**. -4. Apply the aura, refresh it while active, then let it expire or remove it. -5. Click **Stop**, followed by **Copy Report**. -6. Paste the report into your bug report or support message. +- GUID-based multi-target debuff and DoT tracking +- Numeric aura timers +- Stack counters +- Reliable tracking across multiple visible nameplates +- Adjustable aura icon size +- Debuff positioning: + - **Top** + - **Left** + - **Right** +- Instant target-alpha updates -The report includes the relevant Spell IDs, aura timing, target data and refresh events. The recorder is completely inactive until **Start Recording** is pressed and stops when the window is closed. +### 🌀 Crowd Control + +- Dedicated Crowd Control tracking +- Optional supported CC effects from other players +- Separate **CC Icon Size** +- Optional dedicated CC row when using the **Top** aura layout +- Side layouts automatically keep CCs compact with the other aura icons + +### 🔥 Totem Indicators + +Shaman totems can now be displayed as clean, easily recognizable icons instead of full nameplates. + +- Automatically detects supported Shaman totems +- Replaces the entire totem nameplate with the corresponding spell icon +- No healthbar, name or level clutter +- Adjustable **Totem Icon Size** +- Designed especially for clearer PvP situations +- Supports ranked totems without requiring separate configuration + +### ✨ Class Features + +- Blizzard-style Combo Points for: + - Rogue + - Druid + +### 🔥 Castbars + +- Enemy castbars +- Spell icons +- Adjustable castbar height +- Adjustable spacing +- Castbar test mode + +--- + +## 🆕 What's New in v1.0.8 + +### New Aura Positioning + +Aura icons can now be positioned: + +- **Top** +- **Left** +- **Right** + +This is especially useful when many nameplates overlap and a horizontal layout provides better visibility. + +### Separate CC Icon Size + +Crowd Control icons now have their own independent size setting. + +You can keep regular DoTs compact while making important CC effects larger and easier to recognize. + +### Totem Icon Mode + +Shaman totem nameplates can now be automatically replaced by their spell icons. + +Instead of several small 5 HP nameplates filling the screen, important battlefield objects remain immediately recognizable with significantly less visual clutter. + +### Redesigned Options Menu + +The settings menu has been reorganized into compact tabs: + +- **Nameplates** +- **Auras** +- **Totems** +- **Castbar** +- **Target** +- **Tools** + +This keeps the interface much cleaner as Blizz Nameplates+ continues to grow. + +--- + +## 🔎 Missing Spell / Aura Recorder + +Missing a spell, DoT, proc or custom-server aura? + +The built-in recorder creates one complete, copyable diagnostic report — no screenshots or manual chat commands required. + +1. Open the BNP settings. +2. Go to **Tools**. +3. Click **Missing Spell / Aura...** +4. Select the affected unit. +5. Click **Start Recording**. +6. Apply the aura. +7. Refresh it while it is active. +8. Let it expire or remove it. +9. Click **Stop**. +10. Click **Copy Report**. +11. Paste the report into your bug report or support message. + +The report can include: + +- Spell IDs +- Aura timing +- Target information +- Refresh events +- Relevant aura state changes + +The recorder is completely inactive until **Start Recording** is pressed and stops when the recorder window is closed. + +--- ## 📦 Requirements @@ -41,17 +146,32 @@ Both DLLs are required and must be loaded before the game starts. ### SuperWoW.dll -Provides the GUID, unit, combat and cast information used for multi-target tracking, castbars and nameplate identification. +Provides the GUID, unit, combat and cast information used for: + +- Multi-target tracking +- Castbars +- Nameplate identification +- Unit tracking [Download SuperWoW](https://github.com/balakethelock/SuperWoW) ### ClassicAPI.dll -Provides exact nameplate resolution and more reliable aura information, including Spell IDs, durations and expiration times. It is also used for instant target-alpha updates and the recorder’s direct **Copy Report** function. +Provides exact nameplate resolution and more reliable aura information, including: + +- Spell IDs +- Aura durations +- Expiration times +- Exact nameplate resolution +- Instant target updates +- Recorder functionality [Download ClassicAPI](https://github.com/brues-code/ClassicAPI) -> Keep both DLLs up to date. Without them, Blizz Nameplates+ is not supported. +> **Keep both DLLs up to date.** +> Without SuperWoW and ClassicAPI, Blizz Nameplates+ is not supported. + +--- ## 📥 Installation @@ -61,25 +181,76 @@ Provides exact nameplate resolution and more reliable aura information, includin 3. Delete any older `BlizzNameplatesPlus` addon folder. -4. Extract the new folder into `Interface\AddOns\`. +4. Extract the new addon folder into: -5. Verify the final path: + `Interface\AddOns\` + +5. Verify that the final path is: `Interface\AddOns\BlizzNameplatesPlus\BlizzNameplatesPlus.toc` -6. Start the game through your DLL-enabled launcher and enable enemy nameplates. +6. Start the game through your DLL-enabled launcher. -## ⚙️ Main Settings +7. Enable enemy nameplates. -* **Nameplates:** Scale, Y Offset, Non-Target Alpha, Class Colors, Tank Mode and Health Text -* **Target:** Target Glow, glow color and Target Plate on Top -* **Auras:** Icon Size, Debuffs, Crowd Control, separate CC row and CCs from other players -* **Castbar:** Enable/disable and adjust height -* **Class Features:** Combo Points for Rogue and Druid +--- -Changes are applied immediately. +## ⚙️ Settings + +Open the settings through the **BN+ minimap button** or type: + +`/bnp` + +### Nameplates + +- Nameplate Scale +- Y Offset +- Non-Target Alpha +- Class Colors +- Tank Mode +- Health Text +- Combo Points + +### Auras + +- Aura Icon Size +- Debuffs +- Aura Position: Top / Left / Right +- Crowd Control +- CC Icon Size +- Separate CC Row +- CCs from other players + +### Totems + +- Enable Totem Icons +- Totem Icon Size + +### Castbar + +- Enable Castbars +- Castbar Height +- Castbar Spacing +- Test Castbars + +### Target + +- Target Glow +- Glow Color +- Target Plate on Top + +### Tools + +- Missing Spell / Aura Recorder + +Most changes are applied immediately. + +--- ## ❤️ Credits Created by **Wurmschwanz**. -Thanks to everyone who tested the addon, reported bugs and supplied recorder data. + +Thanks to everyone who tested **Blizz Nameplates+**, reported bugs, suggested features and supplied recorder data. + +Special thanks to everyone helping test different classes, PvP situations and large raid environments. ❤️