From 8c22130cdf7181eaefa273fedff2625d320db170 Mon Sep 17 00:00:00 2001 From: Brues <5278969+brues-code@users.noreply.github.com> Date: Wed, 13 May 2026 16:03:17 -0500 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 6e5ef885..ee8039bf 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,32 @@ DLL. 3. Add `ClassicAPI.dll` to `dlls.txt`. 4. Launch the game with `VanillaFixes.exe`. +## Bundled addon: !!!ClassicAPI + +The Lua-side companion library lives in +[`AddOns/!!!ClassicAPI/`](AddOns/!!!ClassicAPI/). It's a 1.12.1 / +Lua 5.0 backport of the modern Blizzard helpers that aren't engine +functions but that consumer code still expects to find as globals — +`Mixin` / `CreateFromMixins`, `CallbackRegistryMixin`, `EventRegistry`, +`ColorMixin` + `CreateColor`, `Item` / `ItemLocation`, `MathUtil` +(`Lerp` / `Clamp` / `CreateCounter`), `TableUtil` (`tCompare`, +`MergeTable`, `SafePack`, etc.), and `EventUtil` +(`ContinueOnAddOnLoaded` etc.). + +Some of the addon's surface depends on engine functions ClassicAPI +provides (`C_UIColor.GetColors` populates the modern color globals, +`C_Item.GetItemInfoInstant` powers `ItemMixin`, the +`ITEM_DATA_LOAD_RESULT` event drives `ContinueOnItemLoad`); the rest +is pure Lua and would work standalone. Without the DLL the addon +still loads, but those features no-op. + +The triple-`!` prefix is **load-order-significant** — WoW loads +addons alphabetically, so `!!!ClassicAPI` is guaranteed to run before +any consumer that depends on its globals. Don't rename the folder. + +To install: copy [`AddOns/!!!ClassicAPI/`](AddOns/!!!ClassicAPI/) into +your `Interface/AddOns/` directory. + ## Bundled addon: DebugTools A 1.12.1 / Lua 5.0 backport of Blizzard's `Blizzard_DebugTools` addon