wow-api-framexml

A reference guide to the Lua functions and shared utilities used by World of Warcraft's interface code. FrameXML is Blizzard's Lua and XML layer for building parts of the game's user interface.

In plain words
What is it for?
Use it when building or maintaining World of Warcraft add-ons that show panels or menus, format values, filter chat, or use Blizzard's shared UI patterns.
Why use it?
It helps developers find the right existing function instead of recreating common interface, formatting, table, math, mixin, or object-pool behavior.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/jburlison/wowaddonapiagents/wow-api-framexml
Any agent
npx skills add JBurlison/WoWAddonAPIAgents --skill wow-api-framexml
Clone the repo
git clone --depth 1 https://github.com/JBurlison/WoWAddonAPIAgents

Made for: Claude Code, Codex.

Per session 96 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 897 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00096 $0.00897
Opus 5 $0.00048 $0.00449
Sonnet 5 $0.00019 $0.00179
Haiku 4.5 $0.00010 $0.00090

Measured 2d ago against content hash 58c31d914c4a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

wow-api-framexml scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/skills/wow-api-framexml/SKILL.md · 45 lines

How it starts

The opening of the file, as written. The whole thing — 45 lines — stays where its author put it; the contents beside it link to each section on GitHub.

FrameXML Functions API

This skill documents the FrameXML layer of the WoW API — global Lua functions defined by Blizzard's interface code, shared XML utility modules, mixin system, object pools, and game utility modules. These are distinct from the C-based Widget API.

Source of truth: https://warcraft.wiki.gg/wiki/FrameXML_functions FrameXML source: https://github.com/Gethe/wow-ui-source/tree/live/Interface/FrameXML SharedXML source: https://github.com/Gethe/wow-ui-source/tree/live/Interface/SharedXML Current as of: Patch 12.0.0 — Retail only.

When to Use This Skill

Use this skill when you need to:

  • Toggle standard UI panels (ToggleCharacter, ShowUIPanel, ToggleSpellBook)
  • Use standard UI dialogs (StaticPopup_Show) or context menus (EasyMenu)
  • Use the Mixin / Object Pool system (CreateFromMixins, CreateFramePool)
  • Filter or extend chat messages (ChatFrame_AddMessageEventFilter)
  • Format numbers, money, or time (SecondsToTime, FormatLargeNumber, GetMoneyString)
  • Use table utilities (tContains, tDeleteItem, tInvert, CopyTable)
  • Use math utilities (Lerp, Clamp, Round, CalculateDistance)
  • Create texture/atlas markup for FontStrings (CreateAtlasMarkup, CreateTextureMarkup)
  • Build tooltips with helpers (GameTooltip_AddNormalLine, GameTooltip_SetTitle)
  • Handle pixel-perfect UI (PixelUtil.SetSize, PixelUtil.SetPoint)
  • Use event convenience functions (EventUtil.ContinueOnAddOnLoaded)
  • Register/animate frames (UIFrameFadeIn, ScriptAnimationUtil.ShakeFrameRandom)
  • Manage bags (OpenAllBags, ToggleBag, IsBagOpen)
  • Preview items/mounts in dressing room (DressUpItemLink)
  • Query player/class/spec info (PlayerUtil.GetCurrentSpecID, GetClassColor)
  • Work with quest icons, map utils, communities, transmog, or other game utilities

References

Reference Contents
UIPARENT.md UI panel toggles, ShowUIPanel, CloseSpecialWindows, MouseIsOver, number abbreviation
MIXINS-AND-POOLS.md Mixin system, CreateFromMixins, CreateColor, object/frame/texture pools
SHAREDXML-DATA-UTILS.md TableUtil, MathUtil, TimeUtil, FormattingUtil, ColorUtil, CvarUtil, EasingUtil, EventUtil, EventRegistry, FunctionUtil, LinkUtil, Flags, AuraUtil, UnitUtil
SHAREDXML-UI-UTILS.md FrameUtil, TextureUtil, PixelUtil, AnchorUtil, NineSlice, RegionUtil, ScriptAnimationUtil, GameTooltipTemplate, TooltipUtil, UIFrameFadeIn/Out
FRAMEXML-GAME-UTILS.md AchievementUtil, ActionButtonUtil, AzeriteUtil, CalendarUtil, CampaignUtil, CommunitiesUtil, DifficultyUtil, ItemRef/ItemUtil, MapUtil, PlayerUtil, PVPUtil, PartyUtil, QuestUtils, TransmogUtil, and more
CHATFRAME-CONTAINERS.md ChatFrame functions, bag open/close/toggle, DressUpFrames, StaticPopup_Show, EasyMenu

Read the full file on GitHub · 45 lines

Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 45 lines · 96 tokens per session scan A 58c31d914c4a

Subscribe to this mod's changes

wow-api-framexml is a skill published in the GitHub repository JBurlison/WoWAddonAPIAgents (43 stars, last pushed 6mo ago), licensed MIT. It adds 96 tokens to every session and 897 once invoked, about $0.0005 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

particles

Use this skill when creating particle effects in Phaser 4. Covers ParticleEmitter, emission zones, death zones, particle properties, textures, gravity wells, and particle movement. Triggers on: particles, emitter, particle effect, explosion, fire, smoke.

phaserjs/phaser · 53 tokens

web-games

Web browser game development principles. Framework selection, WebGPU, optimization, PWA.

vudovn/ag-kit · 20 tokens

develop-web-game

Use when Codex is building or iterating on a web game (HTML/JS) and needs a reliable development + testing loop: implement small changes, run a Playwright-based test script with short input bursts and intentional pauses, inspect screenshots/text, and review console errors with rendergametotext.

netease-youdao/LobsterAI · 64 tokens

gameobject-component-destroy

Destroy one or more Components from a target GameObject. Missing (null) components are skipped — they cannot be destroyed. Use 'gameobject-find' and 'gameobject-component-get' to identify the components first.

IvanMurzak/Unity-MCP · 49 tokens

ship-web-games

Package, deploy, and verify a playable Three.js or web game. Use for release builds, asset delivery, private/public deployment, production smoke tests, browser proof, release notes, rollback readiness, and cleanup of temporary QA resources.

MengTo/Skills · 50 tokens

unity

Compile, test, and drive Unity for this repo's C# packages (unity/core, jint, quickjs, clearscript) and the two Unity projects (tests/, kitchen-sink/). Use when a change touches C# under unity/, when Unity test results are needed, when a rendering snapshot has to be checked or regenerated, or when the app has to be…

ReactUnity/core · 108 tokens