cxUI

Installation

1. Extract the cxUI folder into World of Warcraft\_retail_\Interface\AddOns\
2. Restart the game or /reload
3. Configure via ESC → Options → AddOns → cxUI

Settings window

• Home page — the title and one large button per module (module name in blue, description in yellow).
• Module page — module list on the left, that module's options on the right. Every option is two rows: [x] Name and a short description under it. Hover an option for a longer explanation when it has one.
• Options marked (Requires Reload)* only take full effect after /reload. Everything else applies immediately.

The window is generated from the module registry — adding a module or feature never requires touching options.lua.

Structure

cxUI/
├── cxUI.toc
├── core.lua                 # SavedVariables defaults + startup
├── options.lua              # settings window (built from the registry)
├── libs/
├── media/                   # one sub-folder per feature that owns files
│   ├── CDMGlow/             #   pixel-glow textures
│   ├── DispelAlert/
│   ├── ExecuteAlert/
│   ├── ExternalAlert/
│   └── LowHealthSound/
└── modules/
    ├── Modules.lua          # module registry + feature lifecycle (shared by all modules)
    ├── <Module>/
    │   ├── <Module>.lua     # registers the module + helpers shared by its features
    │   └── <Feature>.lua    # exactly one file per feature
    └── ...

Load order in cxUI.toc matters in one place: CDM before ClassFeatures (ClassFeatures uses the CDM glow engine). Media paths are built with ns.Media("Folder", "file.ogg").

How features work (the lifecycle)

Every option is a feature object registered in its module:

local M = ns:GetModule("Sounds")

local F = M:NewFeature{
    key  = "myOption",              -- CXUI_DB key (also the default = true)
    name = "My Option",
    desc = "One short line shown under the checkbox.",
    -- default = false,             -- start disabled
    -- reload = true,               -- only (de)activated at login
    -- class  = "WARRIOR",          -- only ever runs on this class
}

function F:OnEnable()
    local ev = self:NewEventFrame()                 -- events/OnUpdate are removed automatically on disable
    ev:RegisterEvent("READY_CHECK")
    ev:SetScript("OnEvent", function() ... end)

    self:NewTicker(1, function() ... end)           -- timers are cancelled automatically on disable
    self:After(2, function() ... end)
    self:Hook("SomeBlizzardFunc", function() ... end)          -- installed once, inert while the option is off
    self:HookScript(SomeFrame, "OnShow", function() ... end)
end

function F:OnDisable()
    -- undo anything *visible* (hide frames, restore alpha/anchors, remove engine-side registrations)
end

Guarantee: an option that is off has no events, no timers and no OnUpdate scripts. Blizzard hooks (hooksecurefunc) cannot be removed, so they are installed only if the option has been on at some point in the session, and return immediately while it is off. Use F:IsOn() in any callback you write yourself.

(Requires Reload) features are only activated at login (their code does nothing at all if the option is off then).

Modules

1. Transparency — modules/Transparency/

Auto-hide action bars, micro menu and quest tracker.
Shared file: Transparency.lua

2. CDM — modules/CDM/

Glow effects for Cooldown Manager icons.
Shared file: CDM.lua

3. Class Features — modules/ClassFeatures/

Class-specific overlays and alerts. Each class is its own submenu in the settings window.
Shared file: ClassFeatures.lua

4. Combat — modules/Combat/

Absorb, enemy counter, movement alert, input safety, resurrection.
Shared file: Combat.lua

5. Interface — modules/Interface/

Blizzard UI cleanup and behaviour tweaks.
Shared file: Interface.lua

6. Sounds — modules/Sounds/

Audio alerts for ready checks, invites, queues and pulls.
Shared file: Sounds.lua

7. Group Finder — modules/GroupFinder/

Dungeon Finder filters and layout.
Shared file: GroupFinder.lua

8. Vendor & Mail — modules/VendorMail/

Vendor window, purchases and mailbox helpers.
Shared file: VendorMail.lua

9. Mythic+ — modules/MythicPlus/

Alerts, teleports and timer add-ons for dungeons.
Shared file: MythicPlus.lua

Commands

/cdmglow test | testoff | debug | diag     CDM glow engine / CDM frames
/cxaoe scan | status | debug               Death Knight CDM overlays
/cxmage scan | force                       Flurry cross
/cxwarlock show | hide | status            Burning Rush reminder
/cxexternal debug | scan | status          External cooldown alert
/cxdispel debug | status                   Dispellable debuff alert
/cxautoconfirm debug | status              Auto confirm

Customising

• CDM proc glow spells — edit PROC_CONFIG in modules/CDM/CDMGlow.lua.
• ESC teleport list — edit DUNGEONS in modules/MythicPlus/ESCTeleports.lua each season.
• Dispel spell-ID list — SPELLS_BY_TYPE in modules/MythicPlus/DispelAlert.lua.

License

Open source under the MIT License.