UI FAQ/AddOn Author Resources

UI FAQ » AddOn Author Resources

The UI FAQ is posted here on Warcraft Wiki as well as on Blizzard's UI & Macros Forum and at WoWInterface.com.

Some of the texts will direct you to "post followups" and the like; this is referring to those two forums.

Resources

• Warcraft Wiki - Project:Interface customization - Documents almost all of the WoW API as well as in-game events that you are able to respond to.
• Lua Manual - http://www.lua.org/manual/5.1/ - Official Lua Manual (version 5.1 used by WoW) [See also: alternative manual interface
• Lua Wiki - http://lua-users.org/ - Wiki for Lua - useful for more in depth descriptions of Lua syntax, etc.
• WoW Programming - http://wowprogramming.com/ - A companion site to the book, "World of Warcraft Programming: A Guide and Reference for Creating WoW Addons!", that provides an expanded API reference, forums, working code snippets, utilities, and an experienced, helpful community of developers.
• WoW Programming (BLP2PNG) - http://wowprogramming.com/utils/blp2png - This utility allows you to convert BLP files to more editable PNG files via the web.
• WoW Programming Art Browser - http://wowprogramming.com/utils/artbrowser - A site that allows you to view all of the standard Blizzard artwork (and download it) via the web.
• BLPConverter - http://www.wowinterface.com/downloads/info14110-BLPConverter.html - This allows you to convert BLP files, which store the artwork for WoW.
• Blpc - http://www.wowinterface.com/downloads/info18810-Blpc.html - Another converter / viewer for BLP files with a graphical interface.
• Development Help Addons: Warcraft Wiki, WoWInterface.com
• WoWBench WoW API Emulator: WoWBench

Lua Editors

• EditPlus - http://editplus.com/ - Fairly decent editor w/ most of the options you'll need while scripting in Lua, there is a plugin for Lua syntax here. This is a trialware program -- eventually you will have to pay.
• Lua Eclipse - http://www.ideais.com.br/luaeclipse/ - Eclipse is a highly advanced and extensible editor and development tool. Though it mostly shines for Java development, there are several plug-ins for other languages. Lua Eclipse is such a plug-in. Unfortunately, work seems to have stopped on that plug-in and it is far from finished. It still works well with current versions of Eclipse (Oct 2006), but it mostly gives you syntax check and highligting.
• UltraEdit32 - http://www.ultraedit.com - My editor of choice. Lua syntax highlighting file available @ http://www.capnbry.net/wow/downloads/lua.txt courtesy of capnbry.
• BLua - http://blua.sourceforge.net/ - This is an editor being developed exclusively for Blizzard's flavor of Lua, and when complete hopes to THE complete IDE for Blizzard Lua, however, development on this project stalled in 2005.
• SciTE-WOWInterface - http://www.wowinterface.com/downloads/info4989-SciTE-WOWInterface.html - This is a re-package of the popular ScITE editor (based on the scintilla editing component). You can find more information about SciTE at http://www.scintilla.org/SciTE.html. Some of the customization is from the package at http://gisdeveloper.tripod.com/scite.html , but those just amount to some configuration files that have been altered. I've adjusted some of the preferences and added the bulk of the WoW API with prototypes and descriptions as pop-up calltips (you can see a few examples in the attached screenshots).
• http://luaforge.net/projects/lualangpack - This is a lua plug-in for Visual Studio 2005 supporting syntax highlighting, hidden code regions / auto outlining and Lua projects.
• http://www.sjbrown.co.uk/index.php?code=lualite - This is a lua syntax highlighting plug-in for Visual Studio 2003.
• Notepad++ - http://notepad-plus.sourceforge.net/ - has Lua support, really nice free editor
• http://smultron.sourceforge.net/ - Lua editor for Macs
• TextMate - commercial (not free) text editor for MacOS X with support for many languages, including Lua (using the Lua bundle). Information on installing bundles.
• AddOn Studio - free version of Visual Studio tailored for creating World of Warcraft mods, with Lua syntax highlighting, TOC generation, a FrameXML editor, IntelliSense, and other features

Also see the Lua editors page for a more complete list.

XML Editors

• XMLSpy - http://www.altova.com - This is probably the best XML editor out there, and there is a free version available. Unfortunately many of the things that make it so great are not present in the free version. There is a 30 day trial of the good version.
• XMLMarker - http://symbolclick.com/ - Completely free and pretty decent tree based XML Editor -- probably the best of no-cost editors out there.
• Peter's XML Editor - http://www.iol.ie/~pxe/ - Another decent, completely free XML editor.
• TextMate -http://www.macromates.com - Me boss (Mister Fizzwidget) tells me I should be lettin you know 'bout his favorite editor, wit' all kindsa good voodoo for XML, Lua, and other lingos you be programmin' and scriptin' with. It be good and hackable, too, so it be easy to add support for other languages: Lua support be a third-party addition, which you can get from here: http://phrogz.net/tmp/Lua.tmbundle.tar.gz - TextMate's lua support bundle is also available now in the subversion repository of bundles hosted by TextMate's author: http://macromates.com/wiki/Main/Bundles/ , http://anon:[email protected]/svn/Bundles/trunk/Bundles

Tutorials

• Nevir's Tutorials - Nevir has a pair of tutorials that I found very useful when starting my WoW UI modding adventure. (Note: This resource does not exist anymore; for the sake of possible restoration/mirrors, this has been left up for posterity's sake.) Archive of the addons can be found here.
• Warcraft Wiki HOWTOs - Warcraft Wiki has a number of writeups here on how to accomplish specific tasks; some basic, some advanced.
• Farang's Frames Tutorial - An excellent beginner's guide to creating GUIs for your addon.
• Code Snippets at WoWProgramming - Code snippets to aid in quickly developing WoW AddOns. The rest of the site provides an expanded API reference, utilities, forums, and a helpful community.

Viewing and Converting Screenshots

• IrfanView: http://www.irfanview.de/ (free for non-commercial use)
• EyeBrowse: http://www.eyebrowse.co.uk/ (freeware)
• Paint.net: http://getpaint.net/ (freeware)