mcpField
W
wow-addon-structure

wow-addon-structure

github.com/jburlisonDevelopment4677 installsUpdated 37w ago
Repository

About wow-addon-structure

A reference skill for World of Warcraft Retail AddOn developers, covering folder layout, .toc files, load order, and SavedVariables. It targets Patch 12.0.0 and notes restricted directives and relevant APIs for third-party AddOns.

Key features

  1. 01AddOn folder layout and naming
  2. 02.toc metadata and file order
  3. 03Load lifecycle and login events
  4. 04SavedVariables persistence
  5. 05C_AddOns metadata and load APIs
  6. 06Inspecting Blizzard UI source

Use cases

  1. 01Designing or reviewing AddOn folder structures
  2. 02Authoring or auditing .toc files
  3. 03Planning initialization and login events
  4. 04Troubleshooting SavedVariables persistence

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/jburlison/wowaddonapiagents --skill wow-addon-structure

After installing, type/wow-addon-structurein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
ADDON_STRUCTURE.md
C_ADDONS_API.md
LOADING_LIFECYCLE.md
SAVED_VARIABLES.md
TOC_FORMAT.md
VIEWING_BLIZZARD_UI.md

Details

From the project README

WoW AddOn Structure (Retail)

Scope

  • Retail only, current as of Patch 12.0.0.
  • Focuses on folder layout, .toc metadata, loading order, and SavedVariables.
  • Avoid deprecated or removed APIs and call out restricted directives.

When to use this skill

Use this skill when you need to:

  • Design or review an AddOn folder layout.
  • Author or audit a .toc file.
  • Reason about file load order and login events.
  • Wire SavedVariables or troubleshoot persistence.
  • Query or load AddOns via C_AddOns APIs.

How to use this skill

  1. Start with layout and naming rules in references/ADDON_STRUCTURE.md.
  2. Build the .toc file using references/TOC_FORMAT.md.
  3. Plan initialization order with references/LOADING_LIFECYCLE.md.
  4. Wire persistence with references/SAVED_VARIABLES.md.
  5. Use C_AddOns metadata APIs from references/C_ADDONS_API.md.
  6. Cross-check patterns in Blizzard UI source from references/VIEWING_BLIZZARD_UI.md.

Reference files

  • references/ADDON_STRUCTURE.md - Folder layout rules, naming, and common patterns.
  • references/TOC_FORMAT.md - .toc syntax, directives, and file order rules.
  • references/LOADING_LIFECYCLE.md - Load order, events, and login timeline.
  • references/SAVED_VARIABLES.md - Persistence rules and file locations.
  • references/C_ADDONS_API.md - Key C_AddOns metadata and load APIs.
  • references/VIEWING_BLIZZARD_UI.md - How to inspect Blizzard UI source.

Key rules and reminders

  • The AddOn folder name and .toc filename must match.
  • The .toc file is required and defines file load order.
  • Files load top to bottom in the .toc list.
  • SavedVariables are available after ADDON_LOADED unless LoadSavedVariablesFirst is used.
  • Use LoadOnDemand and C_AddOns.LoadAddOn for heavy modules.
  • Some .toc directives are restricted to Blizzard AddOns and are not available to third-party AddOns.

Sources

Comments

Markdown supported