xiaerfei / vscode-wow-api

WoW extension for VSCode

WoW API

Adds IntelliSense features for World of Warcraft API to VS Code. This extension uses Sumneko's Lua Language Server with EmmyLua annotations.

See Recommended settings for suggested config options and comparisons.

Features

API

• Global API: Parsed 55% (743/1344) of non-Blizzard documented API that have an existing Wowpedia page
• C_ namespaced systems
• Lua shorthand references e.g. format (string.format) and tinsert (table.insert)
• Custom WoW Lua functions e.g. wipe and strsplit

Widgets

Events

CVars

Enums

• Enum table
• LE_ Lua Enums

GlobalStrings

Shows completion for GlobalStrings at >3 uppercase letters to declutter fuzzy search.

Generating documentation

• Blizzard documented functions are generated from Blizzard_APIDocumentation.
• Non-Blizzard documented functions are exported and parsed from Wowpedia.
• JSON data for the hover provider (Events, CVars and Enums) is generated from Lua/ToTypeScript.

lua53 ./Lua/main.lua

Dependencies

• luafilesystem: https://luarocks.org/modules/hisham/luafilesystem
• luasocket: https://luarocks.org/modules/luasocket/luasocket
• luasec: https://luarocks.org/modules/brunoos/luasec
• xml2lua: https://luarocks.org/modules/manoelcampos/xml2lua

Acknowledgements

The following people contributed to the development resources or their work was of invaluable help.

• Andols
• Buds
• Cladhaire
• DahkCeles
• Ellypse
• Foxlit
• Gethe
• Iriel
• Kaydeethree
• Marlamin
• Meorawr
• nebula
• Nevcairiel
• Resike
• Sumneko
• Stanzilla
• Yuyuli

---

• Blizzard Entertainment
• EmmyLua
• ScreenToGif
• WoWInterface
• Wowpedia