Skip to content

jburlison/wow-addon-dev

v2.2.0MIT

Build and maintain addons for Retail, Forever, and Classic progression with version-aware API research and shared Lua code.

wow-addon-development

Design, build, debug, port, and package World of Warcraft addons for Retail, Forever, Classic progression, or any combination of these clients. Use for addon architecture, UI mock-ups and visual fidelity, UIForever testing, optional Witchcraft MCP and computer-use checks, Lua/XML/TOC implementation, compatibility, and release validation.

wow-addon-structure

Verbose guide for WoW AddOn structure, .toc metadata, loading order, SavedVariables, and C_AddOns metadata and load APIs. Use when planning addon folder layout, file order, or SavedVariables wiring. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-achievements

Look up WoW Achievement, Statistics, and Achievement Criteria APIs. Covers C_AchievementInfo, global achievement functions (GetAchievementInfo, GetAchievementCriteriaInfo, GetStatistic, GetComparisonStatistic), achievement categories, guild achievements, achievement links, tracked achievements, toast notifications, and achievement-related events. Use when working with achievement tracking, achievement display, statistics, achievement criteria, guild achievements, or achievement completion detection. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-calendar-events

Look up WoW Calendar and Event Scheduler APIs. Covers C_Calendar (event creation, editing, invites, holidays, raid resets, filtered events, date navigation, guild events, community events, texture lookups) and C_EventScheduler (scheduled event system). Use when working with the in-game calendar, creating events, managing invites, displaying holidays, or scheduling guild/community activities. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-collections

Look up WoW Mount, Pet, Pet Battle, Toy, Stable, and Heirloom Collection APIs. Covers C_MountJournal (mount list, filtering, favorites, summoning, display info), C_PetJournal (pet collection, favorites, summoning, caging, abilities), C_PetBattles (pet battle system, turns, actions, pets, abilities, traps), C_PetInfo, C_ToyBox/C_ToyBoxInfo (toy collection, use, favorites), C_StableInfo (hunter pet stables), C_Heirloom/C_HeirloomInfo (heirloom collection, upgrades). Use when working with mount journal, pet journal, pet battles, toy box, heirloom collection, or hunter stables. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-combat

Look up WoW Combat, Damage Meter, Threat, Loss of Control, Combat Text, Combat Audio Alert, Secret Values, and Spectator APIs. Use when working with combat data, damage meters, threat, loss of control, combat text, encounter events, or any combat-related addon functionality. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-currency-economy

Look up WoW Currency, Auction House, Token, Store, Trading Post, Black Market, Mail, and Player Trading APIs. Covers C_CurrencyInfo (currency data, tracking, backpack), Auction House (full listing/bidding/buying/selling/search/commodity), C_WowTokenPublic (WoW Token market), AccountStore (in-game shop), CatalogShop, C_PerksProgram (Trading Post — Trader's Tender), BlackMarket (BMAH), TradeInfo (player trading), MailInfo (mailbox), and related events. Use when working with currencies, auction house UI, WoW Tokens, the in-game store, Trading Post, black market, mail, or player-to-player trading. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-encounters

Look up WoW Encounter Journal, Mythic+/Challenge Mode, Instance, Scenario, Raid Lock, and Season APIs. Covers EncounterJournal (dungeon/raid boss database, loot tables, section navigation), C_ChallengeMode (M+ keystones, affixes, timers, best times), C_MythicPlus (weekly runs, seasonal data, rating), ScenarioInfo (delves/scenarios objectives and stages), InstanceLeaverInfo (deserter), RaidLocks (saved instances), C_SeasonInfo (seasonal info), and related events. Use when working with dungeon/raid encounter data, M+ keystones, mythic plus scores, scenario stages, raid lockouts, or seasonal content. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-escape-sequences

Look up World of Warcraft UI escape sequences — pipe-character sequences embedded in text strings to produce colors, inline textures, atlas icons, grammar inflections, word-wrap hints, Kstrings, and other special rendering. Use when formatting chat output, tooltip text, FontString content, or any UI text that needs color codes, inline icons, named colors, item-quality colors, texture markup, atlas markup, localized grammar forms, or escape-sequence utilities like WrapTextInColorCode, CreateTextureMarkup, CreateSimpleTextureMarkup, and CreateAtlasMarkup. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-events

Look up complete source-pinned WoW event declarations, ordered typed payloads, nilability, secrecy and callback-versus-frame dispatch across Retail, Forever and Classic progression. Verify addon-facing registration and runtime delivery separately.

wow-api-framexml

Look up World of Warcraft FrameXML functions — global Lua functions, mixins, object pools, SharedXML utilities, and game utility modules. Use this for UI helpers (StaticPopup_Show, EasyMenu), formatting (SecondsToTime, FormatLargeNumber), table/math utils (tContains, Lerp), mixin/pool patterns, chat frame filters, tooltip helpers, bag functions, texture/atlas markup, and all FrameXML game utility modules. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-group-lfg

Look up WoW Party, Raid, Dungeon Finder, Premade Groups (LFG List), Social Queue, Lobby Matchmaker, and Raid Marker APIs. Covers C_PartyInfo (party management, invites, conversion, ready check, countdown), C_LFGInfo (dungeon finder queue, role selection), C_LFGList (premade groups listing, search, application, creation), C_SocialQueue (friend queue tracking), C_LobbyMatchmakerInfo, raid markers, and group-related events. Use when working with party/raid management, group finder, premade group listing, dungeon queue, role selection, ready checks, or raid markers. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-guild

Look up WoW Guild Management, Guild Bank, Guild Info, and Guild Event APIs. Covers guild management functions (invite, promote, demote, kick, disband, MOTD, info), guild roster (GetGuildRosterInfo, GuildRoster, sorting), guild bank functions (GetGuildBankItemInfo, deposit, withdraw, tab management, permissions), guild perks/reputation, C_GuildInfo, and the Club API guild integration (guilds are ClubType.Guild in the Club system). Use when working with guild management, guild roster, guild bank, guild chat, guild events, or guild achievements. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-housing

Look up WoW Player Housing APIs (new in Patch 12.0.0). Covers HousingUI (core housing system), C_HouseEditorUI (placement/editing modes), C_HousingCatalog (decoration catalog), HousingBasicModeUI, HousingCleanupModeUI, HousingCustomizeModeUI, HousingDecorUI, HousingExpertModeUI, C_HouseExteriorUI (exterior customization), HousingLayoutUI, C_HousingNeighborhood (neighborhoods/visiting), C_NeighborhoodInitiative (community goals), and CatalogShop. Use when working with player housing placement, decoration, editing modes, neighborhoods, housing catalogs, exterior customization, or neighborhood initiatives. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-index

Find source-pinned WoW functions, events, object methods, structures, enums and domain guidance across Retail, Forever and Classic progression. Use the packaged narrow-query tool and complete ownership routing before implementation.

wow-api-items-inventory

Look up WoW Item, Container (Bag), Bank, Loot, Equipment, Socket, Upgrade, Merchant, and World Loot Object APIs. Covers C_Item info/count/cooldown/equip/type checks, C_Container bag slots/sort/search/use, C_Bank tabs/deposit/withdraw, C_Loot roll/legacy mode, C_ItemSocketInfo gem sockets, C_ItemInteraction conversion, C_MerchantFrame vendor buy/sell/repair, item location/mixin patterns, and looting functions. Use when working with items, bags, inventory, bank, loot, equipment sets, item sockets, item upgrades, merchants, vendors, item links, or world loot objects. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-lua-environment

Look up the WoW Lua 5.1 runtime environment, restrictions, secure execution, taint system, addon security model, timers, hooks, frame scripting, logging, and restricted actions. Covers hooksecurefunc, C_Timer, securecallfunction, issecurevariable, taint propagation, combat lockdown, protected frames, InCombatLockdown, C_RestrictedActions, C_Log, and the FrameScript sandbox. Use when working with Lua restrictions, secure code, taint, timers, hooks, addon security, debugging, or the WoW Lua sandbox. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-map-navigation

Look up WoW Map, Navigation, Area POI, Taxi, Vignette, Minimap, Nameplate, Waypoint, Zone Ability, Fog of War, and Exploration APIs. Covers C_Map (50+ functions for map data, coordinates, map IDs, area info), C_MapExplorationInfo, C_AreaPoiInfo, C_TaxiMap (flight paths), C_Vignette, C_SuperTrackManager, C_Navigation (in-game navigation), C_ZoneAbility, C_FogOfWar, Minimap functions, C_NamePlateManager, and coordinate conversion. Use when working with maps, coordinates, waypoints, flight paths, minimap, nameplates, vignettes, exploration, zone abilities, or in-game navigation. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-misc-systems

Catch-all reference for smaller WoW API systems that don't warrant individual skills. Covers Tutorial, ReportSystem, SplashScreen, Cinematic, ChromieTimeInfo, AlliedRaces, UserFeedback, WarbandSceneInfo, ResearchInfo (archaeology), Log, EventUtils, SlashCommand, ClickBindings, TooltipInfo, TooltipComparison, GossipInfo (NPC dialog), PlayerChoice, PlayerInteractionManager, ImmersiveInteraction, Localization, Locale, MirrorTimer, ModelInfo, Movie, ParentalControls, PerksActivities, RecruitAFriend, ContributionCollector, GarrisonInfo (legacy), Covenant/Soulbinds (legacy), AzeriteItem (legacy), and other utility namespaces. Use when working with NPC gossip/dialog, player choices, tooltips, tutorials, cinematics, Chromie Time, allied races, warbands, report system, or any miscellaneous game system. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-professions

Look up WoW Professions, Tradeskill, Crafting Orders, Recipe, and Profession Specialization APIs. Covers C_TradeSkillUI (recipe list, crafting, reagents, skill lines, categories, recrafting, salvage, enchanting), C_CraftingOrders (customer/crafter order system, public/private/guild orders, order creation, fulfillment, listing), C_ProfessionSpecUI (profession knowledge, specialization trees), global tradeskill functions, and profession-specific patterns. Use when working with professions, recipes, crafting, work orders, crafting orders, profession specialization, or tradeskill UI. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-pvp

Look up WoW PvP, Battlegrounds, Arenas, Rated PvP, War Mode, Duels, War Games, and Honor/Conquest APIs. Covers C_PvP (PvP info, rated stats, rewards, battlegrounds, arenas, war mode, brawls, special events), duel functions (AcceptDuel, CancelDuel, StartDuel), war game functions, honor/conquest tracking, PvP talent integration, and PvP-related events. Use when working with PvP systems, battlegrounds, arenas, rated PvP, war mode, honor, conquest, duels, or PvP UI. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-quests

Look up WoW Quest, Quest Log, Quest Info, Quest Offer, Quest Session, Quest Task, Campaign, Content Tracking, Quest Hub, and Quest Line APIs. Covers C_QuestLog (70+ functions for quest state, objectives, tracking, completion), C_QuestInfoSystem (quest type/tag info), C_QuestOffer (quest accept/decline), C_QuestSession (party sync quests), C_QuestTaskInfo (bonus objectives/world quests), C_ContentTracking, C_CampaignInfo, C_QuestHubUI, C_QuestLineUI, C_QuestItemUse, C_WarCampaign (legacy), quest POI functions, and quest gossip patterns. Use when working with quest tracking, quest log display, quest objectives, quest accept/complete flows, world quests, campaign progress, bonus objectives, or content tracking systems. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-reputation

Look up WoW Reputation, Faction, Major Factions, Paragon, and Neighborhood Initiative APIs. Covers C_Reputation (faction info, standings, watched faction, headers, friendship reps, paragon), C_MajorFactions (Dragonflight+ renown factions, renown levels, rewards), C_NeighborhoodInitiative (12.0.0 housing neighborhood reputation), faction expansion data, and reputation-related events. Use when working with reputation tracking, faction standings, renown systems, paragon rewards, friendship reputations, or neighborhood initiatives. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-settings-system

Look up WoW Settings registration, CVars, input/keybindings, gamepad, Edit Mode, sound/video, time/build information and Forever game rules. Use for addon preferences, client options and settings integration. Resolve Retail, Forever or Classic with wow-client-targets first.

wow-api-social-chat

Look up WoW Chat, Social, Club/Community, Friend List, Voice Chat, BattleNet, Ping, Social Queue, and Addon Messaging APIs. Covers C_ChatInfo, C_Club, C_ClubFinder, C_FriendList, C_BattleNet, C_VoiceChat, C_SocialRestrictions, C_SocialQueue, C_RecentAllies, C_PingManager, C_TTSSettings, ChatFrame functions, chat filters, addon message system, and 12.0.0 instance restrictions (SendAddonMessage blocked, chat messages may be secret). Use when working with chat output, chat channels, communities, friend lists, voice chat, BattleNet friends, addon communication, social features, or ping system. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-spells-abilities

Look up WoW Spell, SpellBook, ActionBar, Cooldown, Totem, and Shapeshifting APIs. Covers C_Spell info/cooldown/usability/range, C_SpellBook navigation/slot queries, C_ActionBar slot management/state/overrides, C_SpellActivationOverlay procs, C_SpellDiminish DR tracking, C_CooldownViewer, C_AssistedCombat rotation helpers, totem queries, shapeshift forms, casting/channeling functions, flyouts, spell confirmation, and global spell category functions. Use when working with spells, abilities, action bars, cooldowns, casting, totems, shapeshift forms, spell procs, or diminishing returns. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-talents

Look up WoW Class Talents, Hero Talents, Traits system, Specialization, and Profession Specialization APIs. Covers C_ClassTalents (loadouts, config management, talent tree interactions), C_Traits (the underlying trait system — nodes, entries, configs, currencies, conditions), C_SpecializationInfo (spec queries, recommended content), global specialization functions (GetSpecialization, GetSpecializationInfo, SetSpecialization), and profession specialization. Use when working with talent trees, talent loadouts, hero talent selection, trait nodes, specialization switching, talent import/export, or Forever Legacy trees and their challenge/reward integration. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-transmog

Look up WoW Transmogrification, Appearance Collection, Transmog Sets, Transmog Outfits, Dye Colors, and Barber Shop APIs. Covers C_Transmogrify (applying transmog at NPC), C_TransmogCollection (appearance source info, categories, search, collected status), C_TransmogSets (set collection, set info, base sets, variants), C_TransmogOutfits (outfit management, save/load), C_DyeColor/C_DyeColorInfo (armor dye system new in 12.0.0), and C_BarberShop (customization). Use when working with transmog, appearance collections, wardrobe, transmog sets, outfit management, armor dyes, or character customization. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-unit-player

Look up WoW Unit and Player APIs — UnitId tokens, GUIDs, health/power/stats, auras, roles, casting, threat, inspection, paper doll, death/resurrection, and player-specific functions. Use when querying unit identity, health, power, auras, stats, combat state, group membership, casting info, threat, or player character details. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-weekly-rewards

Look up WoW Weekly Rewards (Great Vault) API. Covers C_WeeklyRewards — vault activities (M+, raids, PvP, world), reward selection, item preview, canEquip checks, vault UI state, and related events. Use when working with the Great Vault, weekly reward choices, vault activity tracking, or end-of-week item selection. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-widget

Curated guide to the WoW Widget API (Retail). Focuses on core widget types, common methods, and patterns for CreateFrame, anchoring, scripts, textures, fonts, animations, and UI controls. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-api-xml-schema

Look up the World of Warcraft XML schema — all XML elements, attributes, types, defaults, and inheritance used to define UI frames, textures, fonts, and animations in addon XML files. Covers Ui, LayoutFrame, Frame and all subtypes (Button, EditBox, Slider, StatusBar, Cooldown, etc.), Texture, MaskTexture, Line, FontString, Font, FontFamily, AnimationGroup, Animation and all subtypes (Alpha, Scale, Translation, Path, Rotation), plus shared elements like Anchors, Layers, Scripts, KeyValues, Color, Gradient, TexCoords, and Shadow. Use when writing or reading WoW addon XML files, defining frames in XML, setting up XML templates, or understanding XML attribute-to-API mappings. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-client-targets

Resolve Retail, Forever, and Classic progression targets and verify version-specific WoW API evidence. Use before addon API lookup, client detection, compatibility decisions, TOC generation, or porting between WoW versions.

wow-lua-api

Verbose guide to Lua 5.1 functions available in WoW, including Blizzard-specific differences and WoW-only additions. Use for core Lua behavior in the WoW addon environment. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.

wow-macro-commands

Look up WoW macro commands (slash commands), macro conditionals, macro syntax and options, secure command rules, castsequence, #show/#showtooltip, and conditional targeting. Use when writing macros, explaining /cast, /use, /castsequence, conditionals like [mod], [harm], [help], [@unit], or any slash command behavior. Select Retail, Forever, or Classic with wow-client-targets before using historical listings.