AddOn: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
(91 intermediate revisions by 56 users not shown)
Line 1: Line 1:
== What is an AddOn? ==
:''See [[wo:AddOn]] for the World of Warcraft AddOn reference.''
:''See [[WildStar AddOn]] or [[ws:AddOn]] for the WildStar AddOn reference.''


AddOns are generally self-contained User Interface (UI) modification components. AddOns can be dependent on other AddOns to work though, and some AddOns are actually collections of other AddOns. There is currently no size restriction on AddOns (so you can make one huge lump of lua/XML if you want).
AddOns are self-contained components that change the behavior of a program.


In plain English, it's just something 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).
== Summary ==
An AddOn for a game is generally a collection files you can put in your game folder, that can enhance interaction with the game. AddOns can perform a wide variety of tasks, including adding new buttons to the screen, altering or adding windows, replacing or adding significant functionality, or adding whole new programs.


*'''For a good introduction and explination, please see [http://forums.worldofwarcraft.com/thread.aspx?FN=wow-interface-customization&T=163945&P=1 The Definitive AddOn and Macro FAQ] (v2).'''
== Details ==
Some AddOns can be dependent on other AddOns to work, and some AddOns can be just collections of other AddOns. Some AddOns are standalone, able to run without any additional software. Others are built on libraries. For example, in WoW, the old [[wo:Sea (AddOn)|Sea]] or [[wo:Ace (AddOn)|Ace]] libraries. Others such as the old WoW [[wo:Cosmos (AddOn)|Cosmos]] addon, are compilations of many individually-developed mods or addons.


== How do I create an AddOn? ==


First of all, you need to create a new directory in Interface\AddOns. The name of this directory is kinda important, as it is what other AddOns use to refer to your AddOn (in dependencies and stuff). I would therefore recommend that you do not use version numbers in your AddOn directory name, or you will run the risk of having other AddOns "break" when you upgrade the version. This will probably lead to people either not depending on your AddOn or, worse, that they'll keep using an old version.
[[Category:AddOn]]
 
[[Category:Interface customization]]
Major version numbers as part of AddOn directory names might work, though.
[[Category:UI]]
 
[[Category:Acronyms]]
== What is this .toc file? ==
 
'''.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 filename of an xml file you want to load. However, Blizzard asks that you include at least four lines.
 
Minimal .toc file contents:
## Interface: 1600
## Title: My Add On
## Description: What my addon does
YourAddOnDirectoryName.xml
 
: 'TIP': Make sure you don't 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.
 
The interface number can be seen in the WoW login screen, at the lower left. The number in the .toc file must match the current build or the add on will not be loaded/active.
 
Note: ''Use the Interface Customization Kit that Blizzard provides to determine the real Interface number.''
 
It's also probably a good idea to add a short description of your AddOn, since this is now displayed in the Addon List UI. To do so, simply add a line like the following after the Title or Description line:
 
## Notes: Short desription of the Addon
 
== Special case : [[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.
 
== What other keywords are there in the .toc file? ==
 
Please check out [[AddOn_Keywords]] for a more detailed list.
 
== What Addons are available? ==
See [[Community AddOns List]] for a list of current Add-Ons.<br>
See [[Cosmos AddOns]] for [[Cosmos]]-specific Add-Ons
 
[[Category:Interface Customization]][[Category:AddOns]]

Latest revision as of 06:56, 15 August 2023

See WoW:AddOn for the World of Warcraft AddOn reference.
See WildStar AddOn or WildStar:AddOn for the WildStar AddOn reference.

AddOns are self-contained components that change the behavior of a program.

Summary[edit]

An AddOn for a game is generally a collection files you can put in your game folder, that can enhance interaction with the game. AddOns can perform a wide variety of tasks, including adding new buttons to the screen, altering or adding windows, replacing or adding significant functionality, or adding whole new programs.

Details[edit]

Some AddOns can be dependent on other AddOns to work, and some AddOns can be just collections of other AddOns. Some AddOns are standalone, able to run without any additional software. Others are built on libraries. For example, in WoW, the old Sea or Ace libraries. Others such as the old WoW Cosmos addon, are compilations of many individually-developed mods or addons.

Retrieved from "https://addonstudio.org/mw/index.php?title=AddOn&oldid=20963"