Kerzo Quest Expansion Public API

Comprehensive technical documentation for World of Warcraft addon developers. Integrate accurate quest expansion data, official crest textures, atmospheric parchment background tinting, and zero-maintenance settings synchronization into your own interface.

1. Dual Operation Model (Standalone vs Library)

KQE is engineered to behave either as an autonomous player-facing addon or as a silent underlying data engine for host addons (like Kerzo Classic Quest Log, quest trackers, or custom UI replacements).

2. API Versioning Contract & Retrocompatibility

To ensure third-party addons never break when KQE introduces internal updates or signature changes, KQE incorporates an explicit version handshake contract.

When loading KQE, host addons can query API:GetAPI(requiredMajorVersion). If KQE advances to future major versions, compatibility wrappers ensure older signatures remain 100% operational.

local KQE_ROOT = _G.KerzoQuestExpansion
if not KQE_ROOT then return end

-- 1. Request API v2 explicitly:
local KQE = KQE_ROOT:GetAPI(2)
if not KQE then
    print("[MyAddon] Incompatible KQE version installed.")
    return
end

-- 2. Switch KQE to library mode so it subordinates cleanly:
KQE:SetLibraryMode(true)

-- 3. Consume API methods safely:
local expKey, name, logo = KQE:GetQuestExpansion(questID)

3. Mode Control Methods

4. Quest Identification & Cromatics

local key, name, logo, ratio = KQE:GetQuestExpansion(78522)
if logo then
    myTexture:SetTexture(logo)
    myTexture:SetSize(22 * ratio, 22)
end

5. Parchment & Dialogue Background Tinting

local shouldTint, r, g, b, alpha = KQE:ShouldTintQuest(questID)
if shouldTint then
    parchmentBg:SetColorTexture(r, g, b, alpha)
    parchmentBg:Show()
else
    parchmentBg:Hide()
end

6. Ready-to-Use UI Badges

7. Dynamic Settings Schema (Zero-Maintenance UI)

KQE provides a complete schema via GetSettingsSchema(). Host addons can loop through this schema to generate check buttons, sliders, and color pickers automatically without writing a single line of boilerplate code when new features are added.

{
    clave = "MostrarLogosDetalle",      -- Configuration key
    tipo = "booleano",                  -- "booleano" | "rango" | "seleccion"
    defecto = true,                     -- Factory default
    categoria = "visual",               -- "visual" | "tintado" | "sistema"
    claveTexto = "opt:ShowLogosDetail", -- Localization token
    claveDesc = "opt:desc:ShowLogosDetail"
}

8. Reactive Observer Pattern

Host addons can subscribe to configuration changes without polling or manual reloading.

local function OnKQEConfigChanged(key, newValue, oldValue)
    if key == "TintarFondoExpansion" or key == "OpacidadTinte" then
        MyQuestLog:RefreshParchmentTints()
    elseif key == "MostrarLogosLista" then
        MyQuestLog:RefreshListIcons()
    end
end

-- Subscribe:
KQE:RegisterConfigObserver(OnKQEConfigChanged)

-- Unsubscribe (on addon teardown):
KQE:UnregisterConfigObserver(OnKQEConfigChanged)

9. Localization Engine

In strict accordance with the Kerzo Development Architecture (arquitectura_desarrollo.md), KQE provides complete, native localization across all 10 official Blizzard languages (12 locale variants) using on-demand closure loading with zero CPU idle in background:

10. Canonical Expansion Keys Catalog

11. Technical API Changelog