RGX | Framework

One dependency. Everything your addon suite needs.

Retail Library AddOn

Overview

RGX-Framework is a modern WoW Retail addon framework — an alternative to Ace3. One dependency gives your addon suite events, timers, hooks, slash commands, fonts, colors, textures, dropdowns, UI controls, minimap buttons, options panels, a design system, and more. No embedding. No version conflicts. When the framework updates, every addon on the player's machine benefits automatically.

It stays quiet for players and useful for authors. If another addon requires RGX-Framework, install it and leave it enabled. If you are building addons, use it as a single shared library with a clean API — no LibStub, no embedding tax, no legacy compat shims.

Features

• Events & Messages — Blizzard event registration + internal message bus
• Timers — RGX:After / RGX:Every, native OnUpdate driver
• Fonts — 40 bundled + 4 WoW defaults (44 total, 10 blocked), grouped dropdowns, style objects
• Colors — named palette, class/quality colors, color picker
• Textures — statusbar registry, LibSharedMedia import
• Dropdowns — nested menus, auto-width, inline buttons
• UI Controls — slider, toggle, label, color picker, options panels
• Minimap — drag-to-reposition minimap button builder
• Design — static brand palette + visual building blocks
• Hooks — safe hooksecurefunc post-hooks
• Slash Commands — RGX:RegisterSlashCommand
• Combat Queue — SafeShow, SafeHide, SafeSetPoint
• Lifecycle — RGX:OnReady(fn) / RGX:IsReady()
• DataBroker — LibDataBroker-compatible proxy data sources
• Sound — level-up sound system with variant playback

Active Modules

• RGXFonts — font registry, style objects, grouped dropdowns
• RGXColors — color palette, math, wrapping, picker
• RGXTextures — statusbar textures, LSM import
• RGXDropdowns — nested menus, auto-width, inline buttons
• RGXUI — controls factory, options panel builder
• RGXColorPicker — custom HSV picker with palettes
• RGXMinimap — circular-drag minimap buttons
• RGXDesign — visual building blocks, brand palette
• RGXDataBroker — data object registry, LDB bridge
• RGXSound — level-up sounds, variant playback
• RGXSharedMedia — sound/font/texture registry + external pack scanner
• RGXCombat — enter/leave/kill/crit/low-health callbacks
• RGXPetBattles — pet level-up, capture, battle state
• RGXReputation — reputation + renown tracking
• Event Callbacks — Achievement, LevelUp, Quest, Honor, Delves, Housing, TradingPost, Prey, Collectibles, Loot

As of v2.1.0 every module ships active — no dormant code.

Font Coverage

Sans/UI: Inter, Ubuntu, Liberation Sans, DejaVu Sans, Lato, Poppins, Rajdhani
Serif: Crimson Text
Monospace: IBM Plex Mono, JetBrains Mono
Display: Bebas Neue, Bangers, Creepster, Anton
Pixel: Press Start 2P, Silkscreen, VT323
Fantasy: Uncial Antiqua
WoW defaults: Friz Quadrata, Arial Narrow, Morpheus, Skurri

Temporarily unavailable: Montserrat, Merriweather, Playfair Display, Oswald, Orbitron, Audiowide, Cinzel — corrupted assets, blocked in unavailableFonts

Quick Start

## RequiredDeps: RGX-Framework

local RGX = assert(_G.RGXFramework, "MyAddon: RGX not loaded")

RGX.Addon("MyAddon", {
  slash   = "myaddon",
  minimap = true,
  db      = { enabled = true, volume = 80 },
  options = {
    General = {
      { toggle = "enabled", label = "Enable Addon" },
      { slider = "volume",  label = "Volume", min = 0, max = 100 },
    },
  },
  welcome = "loaded — /myaddon for options",
})

One call = saved settings, options panel, slash command, minimap button — all routed through taint-safe framework paths.

Compatibility

• WoW Retail only
• Interface version: 120007
• Full Ace3 alternative — no LibStub required

Documentation

• Full Wiki
• API Reference
• Migration Guide
• Super Simple Integration
• Declarative API

Developer Tooling: rgx-mcp

An MCP server ships in-tree at tools/rgx-mcp/ — validate, audit, and generate addons against the framework's own schema. Read-only, excluded from the packaged zip.

• rgx_validate_addon — schema-check an RGXAddon table • rgx_audit_lua — scan for unsafe WoW patterns • rgx_generate_addon — emit a contract-congruent addon

Support

Discord:
https://discord.gg/N7kdKAHVVF

GitHub:
https://github.com/DonnieDice/RGX-Framework

Issues:
https://github.com/DonnieDice/RGX-Framework/issues

License

MIT for framework code.

Bundled fonts retain their own original open licenses. See Font Sources for attribution.