docs: add DPSLog to DLL_README and release notes

- DLL_README.md: full feature description, GetSpellInfo API, module name in dev API list
- RELEASE_NOTES.md: updated DPSLog entry with WotLK parity details, removed from gaps list
- README.md: updated module table
This commit is contained in:
MarcelineVQ
2026-03-18 00:16:57 -07:00
parent 56f5c0405d
commit d52d4bc661
3 changed files with 33 additions and 7 deletions
+23 -1
View File
@@ -163,6 +163,28 @@ No other configuration needed, install and forget.
---
### DPSLog (Combat Log Events)
Provides WotLK 3.3.5-style `COMBAT_LOG_EVENT` for the vanilla client. Fires a single unified event with structured arguments instead of vanilla's fragmented localized text events. Enables modern DPS meter addons without expensive string parsing.
37 subevents covering all combat interactions: damage (spell, melee, periodic, environmental, damage shield, damage split), healing (direct, periodic, overheal tracking), misses (all types), auras (applied, removed, refreshed, broken, dose changes), casts (start, success, failed, interrupted), power (energize, drain, leech), dispels, extra attacks, deaths, and kills.
Each event includes source/destination names and GUIDs, spell names, school bitmasks, overkill/overheal amounts, and all WotLK-standard fields.
Also provides `GetSpellInfo(spellId)` -- the TBC/WotLK spell lookup API that doesn't exist in vanilla:
```lua
local name, rank, icon, castTime, minRange, maxRange, spellId = GetSpellInfo(133)
```
Includes an embedded tracker addon (`/dpslog`) for verifying event coverage.
See the [DPSLog wiki page](https://codeberg.org/gwenael/WeirdUtils/wiki/DPSLog) for full event reference and addon developer guide.
**DLL:** `dpslog.dll`
---
### SuperWoW Heal Text Fix
Fixes duplicate floating heal numbers caused by SuperWoW 1.5. Only relevant if you use SuperWoW. No configuration needed, install and forget.
@@ -240,7 +262,7 @@ WeirdUtils exports three functions for querying and disabling modules at runtime
Module names are case-insensitive and match the released dll names:
`customassets`, `framecrash`, `logsessions`, `transmogfix`, `minimapicons`, `healtextfix`, `bigcursor`, `worldmarkers`, `interact`, `outline`, `pngscreenshots`, `clickthrough`
`customassets`, `framecrash`, `logsessions`, `transmogfix`, `minimapicons`, `healtextfix`, `bigcursor`, `worldmarkers`, `interact`, `outline`, `pngscreenshots`, `clickthrough`, `dpslog`
There is no re-enable API.
+1 -1
View File
@@ -13,7 +13,7 @@ interaction helpers, and an embedded addon with Lua API + keybindings.
| **Interact** | Nearest NPC/object interaction, bulk looting with queue processing. |
| **Markers** | World-space raid markers (5 colors) using M2 model entities. Proximity respawn, group sync, animated spawn/despawn. Lua API + slash commands (`/wm`, `/cwm`). |
| **Framecrash** | Anchor vtable guards - prevents crashes from dangling relativeTo pointers and NULL frame refs. |
| **Combatlog** | Combat log fixes. |
| **DPSLog** | WotLK-style `COMBAT_LOG_EVENT` for vanilla 1.12.1. Fires structured events with full WotLK 3.3.5 CLEU parity: spell prefix (spellId, spellName, spellSchool), source/dest names, overkill, overheal, all damage/heal/miss/aura/cast subevents. Includes `GetSpellInfo(spellId)` Lua API. Embedded tracker addon. See [wiki/DPSLog.md](wiki/DPSLog.md). |
| **Minimap Icons** | Minimap icon fixes. |
| **Transmogfix** | Coalesces transmog durability update packets to prevent death frame drops. |
| **Data Assets** | Loose file loading, permissive MPQ glob patterns, pre-indexed file hash set. |
+9 -5
View File
@@ -9,10 +9,15 @@ Track notable changes here between releases. Clear this file when cutting a new
the world. Slash commands (`/wm 1`, `/cwm`), keybindings, full Lua API, and automatic
group sync between WeirdUtils users. Requires party/raid leader or raid assist.
- **DPSLog (COMBAT_LOG_EVENT)** - unified TBC/WotLK-style COMBAT_LOG_EVENT system with
30 subevents across 23 hooks. Provides a single event (slot 549) with subevent strings
(SWING_DAMAGE, SPELL_HEAL, SPELL_AURA_APPLIED, etc.) instead of vanilla's fragmented
per-type events. Includes embedded addon for parsing. Not yet in DLL_README.
- **DPSLog (COMBAT_LOG_EVENT)** - WotLK 3.3.5 CLEU parity for vanilla 1.12.1. 37 subevents
across 24 hooks with full structured data: source/dest names via name cache, spell names
via SpellRec, overkill/overheal from unit descriptors, WotLK-standard field ordering
(blocked before absorbed, separate glancing/crushing booleans). Drain Life reclassified
as SPELL_PERIODIC_LEECH. SPELL_ENERGIZE with actual amount/powerType via dedicated
SMSG_SPELLENERGIZELOG hook. Periodic energize divides by power display factor (rage/10).
Includes `GetSpellInfo(spellId)` Lua API (name, rank, icon, castTime, minRange, maxRange)
with verified SpellRec/SpellIcon/SpellRange/SpellCastTimes DBC offsets.
Embedded tracker addon (`/dpslog`). Full event reference in wiki.
- **Interact** - smart interaction helpers: "Interact Nearest" right-clicks the closest
interactable NPC or object within 5 yards, "Loot All Corpses" bulk loots nearby corpses.
@@ -137,6 +142,5 @@ Features documented in DLL_README but never included in a release:
- Crash Fix (framecrash)
Features implemented but not yet documented in DLL_README:
- DPSLog (COMBAT_LOG_EVENT)
- Clickthrough lootable corpse priority
- World Markers battleground restriction