Home

Jump to bottom

R41z0r edited this page Mar 8, 2026 · 16 revisions

LibEQOL Docs

LibEQOL ships four helper modules:

LibEQOLEditMode-1.0 – selection overlays, dialog widgets, and helpers for the Edit Mode settings frame.
LibEQOLNativeEditMode-1.0 – optional native edit-mode manager flow (separate include).
LibEQOLSettingsMode-1.0 – helpers for the Blizzard Settings UI (categories, controls, sound dropdown, multi-select, color overrides).
LibEQOLDebugMode-1.0 – explicit opt-in debug sessions with timeline capture and bug report export.

The umbrella loader (LibEQOL.lua) surfaces sublibs on _G.LibEQOL. Load LibStub before the library when embedding. Download: CurseForge

Install / embed

Standalone: drop LibEQOL into Interface/AddOns and enable it (loads automatically).
Embedded: place it under libs/ and include LibEQOL.xml before calling the API.
Optional modules:
- Native Edit Mode: include LibEQOLNativeEditMode.xml.
- Debug Mode: include LibEQOLDebugMode.xml.
Packaging/CI: Do not list LibEQOL as a BigWigs packager External (it can bleed into other addons and cause XML/template conflicts). Vendor it into your repo instead; the GitHub Action in this repo downloads the latest release ZIP, extracts it to destination/LibEQOL, and stages it for commit:
```
- name: Install LibEQOL
  uses: R41z0r/LibEQOL@v1.0.0
  with:
    destination: EnhanceQoL/libs   # results in EnhanceQoL/libs/LibEQOL
```

Edit Mode

Getting started
API
Standalone settings dialog
Manager toggles
Widgets
- Checkbox
- Checkbox + Color
- Collapsible
- Color
- Divider
- Dropdown
- Dropdown + Color
- Input
- Multi Dropdown
- Slider
Examples
- EditModeExamples.lua
- Overlay toggle + drag predicate + collapse-exclusive

Settings Mode

Debug Mode