AddonManager helps you keep track of your addons and provides easy ways to access them.
It has a main window that lists all registered addons and their details, as well as a "Mini-Addon bar", where small addon icons can go.
The more addon developers that use it (and it's really easy to use!), the more addons will show up in the list. Give it time =)
For users
- Type /addons to see all your registered addons
- Alternatively, click on the AddonManager button in the "Mini Addons" bar
For addon developers
Registering your Addon
- As of v1.04, you can call AddonManager.RegisterAddonTable, which takes the same parameters as RegisterAddon, but in table form, to make things simpler.
- Add a call to AddonManager.RegisterAddon in your VARIABLES_LOADED event
- Example1. At minimum, you can do this:
if AddonManager then
AddonManager.RegisterAddon("MyAddonName", "My addon makes you awesome")
end
- Example 2. Using a custom icon, a config frame, and a mini-addon button:
if AddonManager then
local addon = {
name = "MyAddonName",
version = "v0.01",
author = "Me",
description = "My addon makes you awesome",
icon = "Interface/Addons/MyAddon/myAddon32.tga",
category = "Other",
configFrame = MyAddonConfigFrame,
slashCommand = "/myaddon",
miniButton = MyAddonMiniButton,
disableScript = MyAddon_Disable,
enableScript = MyAddon_Enable,
}
if AddonManager.RegisterAddonTable then
AddonManager.RegisterAddonTable(addon)
else
AddonManager.RegisterAddon(addon.name, addon.description, addon.icon, addon.category,
addon.configFrame, addon.slashCommand, addon.miniButton, addon.version, addon.author)
end
end
- Of course, replace "my addon" with your addon
- I recommend not printing out that your addon has loaded if you use AddonManager, since the user will be able to see it in the AddonManager list.
- In the first example, your addon would be considered a "Passive" addon - its text would be colored green (like passive skills) and you can't click on it.
AddonManager.RegisterAddon
AddonManager.RegisterAddonTable = function(addon) -- Since v1.042
AddonManager.RegisterAddon = function(name, description, icon, category, configFrame, slashCommands, miniButton, onClickScript, version, author, disableScript, enableScript)
Registers an addon with AddonManager. Adds the addon to the addons list and potentially also to the mini-addons-frame.
Parameters:
- name - Your addon's name. Default is "[No Name]".
- description - A brief (one or two sentence) description of your addon. Something that fits in a tooltip.
- icon - Path to a 32x32 image icon (e.g., "Interface/Addons/AddonManager/Textures/addonManagerIcon32.tga").
If no icon is specified, will use default "recipe" icon.
- category - One of AddonManager.Categories; will be used for filtering the addons list. Default is "Other".
One of Development, Economy, Information, Interface, Inventory, Leveling, Map, PvP, Social, or Other.
- configFrame - If your addon has a config frame or other frame you want to show when your addon is clicked, use this.
- slashCommands - Specify any slash commands you've registered so that the user doesn't have to remember them.
- miniButton - If you want to display a button on the "Mini-Addons" bar, specify it here.
- onClickScript - If you need to special handling when your addon's button is clicked, you can specify a script for it.
If this parameter is specified, configFrame is ignored.
- version - what version this addon's in
- author - who made this addon
- disableScript - A script that can be used to disable your addon. Adds the disable option in the AddonManager list if both disableScript and enableScript are specified
- enableScript - A script that can be used to re-enable your addon
The Mini-Addon Bar
- To use a mini-button, you need to first have one created in your xml
- Example:
<Button name="MyAddonMiniButton" hidden="true" inherits="UIPanelButtonTemplate" parent="AddonManagerMiniFrame">
<Size>
<AbsDimension y="24" x="24"/>
</Size>
<Scripts>
<OnClick>
AddonManager.MiniButton_OnClick(this)
</OnClick>
<OnEnter>
AddonManager.MiniButton_OnEnter(this)
</OnEnter>
<OnLeave>
AddonManager.MiniButton_OnLeave(this)
</OnLeave>
</Scripts>
<NormalTexture file="Interface\AddOns\MyAddon\myAddonIconNormal.tga"/>
<PushedTexture file="Interface\AddOns\MyAddon\myAddonIconDown.tga"/>
</Button>
- The only things you should change here are the Button's name and the two textures.
- Note that you can't have a MiniButton if your addon is passive (because what should happen when the user clicks on it?). A passive addon is one that has no config frame and no custom onClickScript.
List of sample Registrations
------------------------------------------------------------------------
r11 | alleris2_0 | 2009-04-05 06:57:41 +0000 (Sun, 05 Apr 2009) | 6 lines
Changed paths:
A /tags/v1.14 (from /trunk:10)
Added FrameStrata option
Added Category filter dropdown
Added "Enabled" check mark
Changed RegisterAddon to take in two additional parameters: disableScript and enableScript
If the addon allows it, users will have the option to disable an addon from within AddonManager
------------------------------------------------------------------------
r10 | alleris2_0 | 2009-04-05 06:55:38 +0000 (Sun, 05 Apr 2009) | 1 line
Changed paths:
M /trunk/AddonManager.lua
Changed placement of Enabled checkbox if the addon doesn't have a mini button (it's more appealing this way)
------------------------------------------------------------------------
r9 | alleris2_0 | 2009-04-05 06:13:42 +0000 (Sun, 05 Apr 2009) | 2 lines
Changed paths:
M /trunk/AddonManager.lua
M /trunk/AddonManager.xml
Added "Enabled" check mark
Changed RegisterAddon to take in two additional parameters: disableScript and enableScript
------------------------------------------------------------------------
r8 | alleris2_0 | 2009-04-05 05:23:11 +0000 (Sun, 05 Apr 2009) | 2 lines
Changed paths:
M /trunk/AddonManager.lua
M /trunk/AddonManager.toc
M /trunk/AddonManager.xml
M /trunk/AddonManagerMini.lua
M /trunk/AddonManagerMini.xml
M /trunk/Libs/Sol.lua
Added FrameStrata option
Added Category filter dropdown
------------------------------------------------------------------------
r6 | alleris2_0 | 2009-04-03 20:28:14 +0000 (Fri, 03 Apr 2009) | 1 line
Changed paths:
M /trunk/AddonManager.lua
M /trunk/AddonManager.toc
Incremented version numbers >.>
------------------------------------------------------------------------
r5 | alleris2_0 | 2009-04-03 20:26:41 +0000 (Fri, 03 Apr 2009) | 3 lines
Changed paths:
M /trunk/AddonManager.lua
M /trunk/AddonManagerMini.lua
M /trunk/AddonManagerMini.xml
Fixed bug - Addons with names < "AddonManager" now register correctly and the mini button will display and be clickable
Added tooltip to the mini-addon bar's move corner... thing
------------------------------------------------------------------------
r3 | alleris2_0 | 2009-04-03 09:57:58 +0000 (Fri, 03 Apr 2009) | 1 line
Changed paths:
M /trunk/AddonManager.lua
M /trunk/AddonManager.toc
A /trunk/Libs
A /trunk/Libs/LibStub.lua
A /trunk/Libs/Sol.lua
Using new Sol structure
------------------------------------------------------------------------
r2 | alleris2_0 | 2009-04-03 01:31:38 +0000 (Fri, 03 Apr 2009) | 1 line
Changed paths:
A /trunk/AddonManager.lua
A /trunk/AddonManager.toc
A /trunk/AddonManager.xml
A /trunk/AddonManagerMini.lua
A /trunk/AddonManagerMini.xml
A /trunk/Textures
A /trunk/Textures/addonManagerIcon32.tga
A /trunk/Textures/addonManagerMiniIcon.tga
A /trunk/Textures/addonManagerMiniIconInv.tga
A /trunk/Textures/addonsTab2.tga
A /trunk/Textures/settingsTab.tga
AddonManager v1.11 - First commit
------------------------------------------------------------------------
r1 | root | 2009-04-02 09:24:49 +0000 (Thu, 02 Apr 2009) | 1 line
Changed paths:
A /branches
A /tags
A /trunk
"addonmanager/mainline: Initial Import"
------------------------------------------------------------------------
