Wowpedia

We have moved to Warcraft Wiki. Click here for information and the new URL.

READ MORE

Wowpedia
 
(welcoming new contributor)
 
Line 1: Line 1:
  +
{| class="navbox" style="font-size:100%; margin-bottom:0.5em;" cellpadding="5"
'''AddOns''' are generally self-contained User Interface (UI) modification components. However, some AddOns can be dependent on other AddOns to work, and some AddOns are actually collections of other AddOns. There is no size restriction on AddOns, some can grow to be quite massive.
 
  +
|-
  +
! Welcome to WoWWiki!
  +
|- style="text-align:left;"
  +
|
  +
[[Image:Wiki.png|70px|right|Wiki logo]]
  +
Hello, '''Lairpie''', and welcome to '''[[WoWWiki:About|WoWWiki]]''', the Warcraft wiki! Thanks for your edit to the "Quest:Runecloth" page, and we heartily [[WoWWiki:Be bold in updating pages|encourage you to continue contributing]]!
   
  +
Some links you may find useful:
In plain English, an AddOn is just some files you can put in your game folder that can (theoretically) improve your interaction with the World of Warcraft game (i.e. make it easier to play, or give you more information about what's going on in the game).
 
  +
* The [[:Category:Things to do|'''things to do''' category]] has lots of things to keep you busy!
  +
* Check out the '''[[Portal:Community|Community portal]]''' for some useful editors' links.
  +
* Note that WoWWiki isn't an absolute democracy, but many decisions are [[WoWWiki:Voting policy|voted on]]. See a [[:Category:Votes in progress|list of '''votes in progress''']].
  +
* Many WoWWikians frequent our [[WoWWiki:IRC|'''IRC Channel''']], on [irc://chat.freenode.net/wowwiki chat.freenode.net, #wowwiki].
  +
* '''Finally, please check out the site [[WoWWiki:Guidelines|guidelines]] and [[WoWWiki:Policies|policies]]!'''
   
  +
We hope you enjoy editing here and being a [[WoWWiki:WoWWikians|WoWWikian]]!<br/>Please sign your name on talk pages using four tildes (<code><nowiki>~~~~</nowiki></code>) as this will automatically produce your name and the date. If you have any questions, just ask on the relevant talk page, or visit the [[Forum:Index|'''site forums''']].
Often the name '''modification''' (or "mod" for short) is used interchangeably with AddOn. More specifically, a mod is a third-party AddOn that alters or enhances some aspect of World of Warcraft's interface. Mods can perform a wide variety of tasks, including adding new buttons to the screen, altering the built-in player and party frames. In extreme cases, mods completely supplant the standard WoW [[UI|interface]], usually offering more advanced functionality.
 
  +
|}
   
  +
Feel free to create a new topic on the [[Forum:Index|WoWWiki forums]] if you need help with anything!
Some mods are standalone, able to run without any additional software. Others are built on libraries such as [[Sea]] or [[Ace (AddOns)|Ace]]. Still others, such as [[Cosmos]], are compilations of many individually-developed mods.
 
 
== Blizzard's AddOn policy ==
 
With the release of [[Patch 3.1]], [[Blizzard Entertainment]] introduced a new UI AddOn development policy.<ref name="policy">http://www.worldofwarcraft.com/policy/ui.html</ref> Here is a summary below:
 
# AddOns must be free of charge.
 
# AddOn code must be completely visible.
 
# AddOns must not negatively impact World of Warcraft realms or other players.
 
# AddOns may not include advertisements.
 
# AddOns may not solicit donations.
 
# AddOns must not contain offensive or objectionable material.
 
# AddOns must abide by World of Warcraft ToU and EULA.
 
# Blizzard Entertainment has the right to disable AddOn functionality as it sees fit.
 
 
It isn't exactly clear how Blizzard plans to enforce this policy, but developers should follow the policy or risk some sort of exclusion of their AddOns from the game. The following sentence ends the introductory paragraph of the policy: "failure to abide by them may result in measures up to and including taking formal legal action."<ref name="policy"/>
 
 
== Creating an AddOn ==
 
First of all, you need to create a new directory in Interface\AddOns. The name of this directory is kind of important, as it is what other AddOns use to refer to your AddOn (in dependencies). Therefore, using version numbers in your AddOn directory name can be a bad idea; you will run the risk of having other AddOns "break" when you change the version. This will probably lead to people either not depending on your AddOn or, worse, that they'll keep using an old version.
 
 
Major version numbers as part of AddOn directory names might work, though.
 
 
Look at [[Getting started with writing addons]] to get a better idea of the structure of an addon.
 
 
== Toc files ==
 
'''.toc''' is short for "table of contents".
 
 
A functioning AddOn will need a file named <code>&lt;YourAddOnDirectoryName&gt;.toc</code> in "<code>Interface\AddOns\YourAddOnDirectoryName\</code>".
 
 
This file needs to have two things - an interface keyword with a correct interface number, and the name(s) of one or more files to load. However, Blizzard asks that you include at least these five client recognized tag lines:
 
 
## Interface: 30000
 
## Title: My Add On
 
## Version: 1.0.0
 
## Notes: A short description of my AddOn
 
## Author: Your name or memorable descriptor (e.g. LuckyLuke)
 
 
* Tip: Make sure you do not have any extra spaces at the end of the line with the filename specified. If you do, the extra space is taken as part of the filename and will cause your AddOn to silently fail to load.
 
 
* Tip: The .toc file is not reloaded when you reload the user interface; if you make changes to it, you will need to quit all the way to the desktop before they take effect.
 
 
To get the latest interface number, see [[Getting the current interface number]]. The number in the .toc file must match the current build or the add on will not be loaded/active, unless the user has explicitly told WoW to load out-of-date Addons. If the .toc file declares an interface number prior to 2.0.0 (i.e. pre-[[The Burning Crusade]]), the AddOn can not be loaded, regardless of the load out of date AddOns setting.
 
 
=== Bindings.xml ===
 
If you include a [[Bindings.xml]] file, it does not have to be included in your .toc list of files to load - WoW loads this file automatically. This file is used to set key bindings specific to the AddOn.
 
 
=== Other keywords in the toc file ===
 
Please check out [[The TOC Format]] for a more detailed list.
 
 
== Troubleshooting an AddOn ==
 
As of [[Patch 2.3]], if you get a message "Interface action failed because of an AddOn", this means that an AddOn interfered with the Blizzard UI in some way. To diagnose this, enter the following into chat "<tt>/console taintLog 1</tt>" and restart the game and try to reproduce it. If you reproduce it, you can quit the game and search through the file <tt>Logs\taint.log</tt> for the word "<tt>blocked</tt>" and mail the log to the author of the AddOn listed there. Once you have done this you can turn off logging by entering the following into chat "<tt>/console taintLog 0</tt>"
 
 
== See also ==
 
* [[UI Beginners Guide]] has plenty of reference links
 
* [[The TOC Format]]
 
* [[Bindings.xml]] for creating key bindings
 
* [[UI FAQ/AddOns]]
 
* [[UI FAQ/AddOn Author Resources]]
 
* [[Troubleshooting a mod]]
 
 
== Video Guides ==
 
 
<Youtube>h2lpadDsd00</Youtube>
 
<youtube>22ukGjLugpQ</youtube>
 
<youtube>zM6WjGgQCwQ</youtube>
 
 
==References==
 
{{Reflist}}
 
 
== External links ==
 
{{elink|type=wowus|link=http://www.worldofwarcraft.com/policy/ui.html|desc=UI Add-On Development Policy}}
 
{{elink|type=wowus|link=http://forums.worldofwarcraft.com/board.html?forumId=11114&sid=1|desc=UI Forum}}
 
{{elink|site=Wowace Forums|link=http://forums.wowace.com|desc=Great Addon Developer Forum}}
 
 
=== Addon Providers ===
 
{{elink|type=curse|link=http://www.curse.com/}}
 
{{elink|type=wowi|link=http://www.wowinterface.com/|site=WoWInterface}}
 
{{elink|site=WoWUI|type=incgamers|link=http://wowui.incgamers.com/}}
 
 
=== Updaters ===
 
<!-- {{elink|site=nUpdate|link=http://www.nupdate.com/}} When there is an actual download available, they can have their link -->
 
{{elink|site=Curse Client|type=curse|link=http://wow.curse.com/client/|desc= Windows & Macintosh versions}}
 
{{elink|site=WoWInterface UI Manager|type=wowi|link=http://www.wowinterface.com/downloads/info8239-WoWInterfaceUIManager-Windows.html|desc=Windows version}}
 
{{elink|site=WoWInterface UI Manager|type=wowi|link=http://www.wowinterface.com/downloads/info8242-WoWInterfaceUIManager-GenericLinuxMacintosh.html|desc=Generic (Linux/Mac) version}}
 
{{elink|site=MMOUI Minion|type=wowi|link=http://minion.mmoui.com|desc=Generic (Linux/Mac/Windows) version - you may refer to this place as WoWInterface, and this is their "v2" of UI Manager}}
 
[[Category:Interface customization]]
 
[[Category:AddOns| ]]
 
[[Category:UI]]
 

Revision as of 19:52, 3 October 2010

Feel free to create a new topic on the WoWWiki forums if you need help with anything!