Wowpedia

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

READ MORE

Wowpedia
(upgraded rare quality template)
 
m (Fixed link to Sea)
 
Line 1: Line 1:
  +
'''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.
−
<noinclude>__NOTOC__</noinclude>
 
−
{| style="{{{{{1|{{If|{{Equal|{{PAGENAME}}|Warhelm of the Bold}}|then=tooltipcss|else=Smalltooltipcss}}}}}}}"
 
−
| colspan=2 | {{quality|Rare|Warhelm of the Bold}}
 
−
|-
 
−
| colspan=2 | Binds when picked up
 
−
|-
 
−
| Head || align=right | Plate
 
−
|-
 
−
| colspan=2 | 946 Armor
 
−
|-
 
−
| colspan=2 | +24 Strength
 
−
|-
 
−
| colspan=2 | +22 Agility
 
−
|-
 
−
| colspan=2 | +23 Stamina
 
−
|-
 
−
| colspan=2 | Durability 80 / 80
 
−
|-
 
−
| colspan=2 {{Blue Socket}}
 
−
|-
 
−
| colspan=2 {{Meta Socket}}
 
−
|-
 
−
| colspan=2 style="color: #AAAAAA;" | Socket Bonus: +4 Strength
 
−
|-
 
−
| colspan=2 | Requires Level 70
 
−
|-
 
−
| colspan=2 style="color: #0f0;" | <u>Equip</u>: Increases defense rating by 20.
 
−
|-
 
−
| colspan=2 | Set: [[Bold Armor]] (1/5)
 
−
|-
 
−
| colspan=2 | Sells for {{cost|g=4|s=44|c=72}} to vendors
 
−
|-
 
−
| colspan=2 | Item Level 115
 
−
|}<noinclude>
 
−
{{Icon|INV_Helmet_20}}
 
−
The '''Warhelm of the Bold''' is the [[Warrior]] [[Dungeon Set 3]] plate helm. It gives bonuses to [[strength]], [[agility]] and [[stamina]].
 
−
{{clrl}}
 
== Source ==
 
−
The Warhelm of the Bold drops off [[Warp Splinter]] in [[The Botanica]].
 
   
  +
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).
== External Links ==
 
−
{{elinks-item|28350}}
 
   
  +
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.
[[Category:Plate Armor]]
 
  +
[[Category:Armor:Head]]
 
  +
Some mods are standalone, able to run without any additional software. Others are built on libraries such as [[Sea (add-on)|Sea]] or [[Ace (AddOns)|Ace]]. Still others are compilations of many individually-developed mods.
−
[[Category:Rare Items]]
 
  +
−
[[Category:Warrior Sets]]
 
  +
== Blizzard's AddOn policy ==
−
</noinclude>
 
  +
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: {{API_LatestInterface}}
  +
## 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.
  +
  +
* '''{{API_LatestInterface}} is the current interface number.'''
  +
  +
=== 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 ==
  +
* [[Installing an addon]] - in-depth guide to manually installing addons
  +
* [[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 22:39, 8 February 2011

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.

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).

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 interface, usually offering more advanced functionality.

Some mods are standalone, able to run without any additional software. Others are built on libraries such as Sea or Ace. Still others 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.[1] Here is a summary below:

  1. AddOns must be free of charge.
  2. AddOn code must be completely visible.
  3. AddOns must not negatively impact World of Warcraft realms or other players.
  4. AddOns may not include advertisements.
  5. AddOns may not solicit donations.
  6. AddOns must not contain offensive or objectionable material.
  7. AddOns must abide by World of Warcraft ToU and EULA.
  8. 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."[1]

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 <YourAddOnDirectoryName>.toc in "Interface\AddOns\YourAddOnDirectoryName\".

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: 100206
## 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.

  • 100206 is the current interface number.

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 "/console taintLog 1" and restart the game and try to reproduce it. If you reproduce it, you can quit the game and search through the file Logs\taint.log for the word "blocked" 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 "/console taintLog 0"

See also

Video Guides

References

External links

Addon Providers

Updaters