AddOn: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
(110 intermediate revisions by 73 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, basically, somewhat self-contained UI pieces. AddOns can be dependent on other AddOns to work though. 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.


== How do I create an AddOn? ==
== 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.


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


Major version numbers as part of AddOn directory names might work, though.


== What is this .toc file? ==
[[Category:AddOn]]
 
[[Category:Interface customization]]
You need to create a file named <YourAddOnDirectoryName>.toc in "Interface\AddOns\YourAddOnDirectoryName\".
[[Category:UI]]
 
[[Category:Acronyms]]
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.
 
Minimal .toc file contents:
## Interface: 4062
YourAddOnDirectoryName.xml
 
== 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.
 
For a more detailed look on [[Bindings.xml]], click the wiki word.
 
== What other keywords are there in the .toc file? ==
 
Please check out [[AddOn_Keywords]] for a more detailed list.

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"