Description
myAddOns is a World of Warcraft AddOn. It's an AddOn Manager accessible from
the Main Menu. It lists your AddOns per category. You can view details and help
for the supporting AddOns and open their options window if they have one. You
can also load the load on demand AddOns and setup myAddOns to load these AddOns
automatically when you login.
Install
Extract the files into your ..World of WarcraftInterfaceAddOns directory.
Features
- AddOns list per category
- Automatic AddOns loading (automatic, per class, per character)
- Personal notes for each AddOn
- Localization (english, french, german)
- Low memory usage (~0.2MB)
For supporting AddOns:
- AddOns details
- AddOns help
- Link to the options window
Usage
Players
To access the AddOn manager, click on the 'AddOns' button in the Main Menu.
The AddOns list is automatic. The loaded AddOns are yellow while the AddOns not
yet loaded are grey.
You can see details and help for the AddOns in the 'Details' and 'Help' tabs. You
can setup the automatic load for a load on demand AddOn in the 'Load' tab.
Developers
Here is a small tutorial to add myAddOns support to your AddOns.
> Automatic method
myAddOns will automatically add your AddOn to the AddOns list and read its toc file
to get info about your AddOn. Here is what myAddOns uses:
- Interface:
- Title: <AddOn name in the AddOns list>
- Notes: <AddOn description>
- Version: <AddOn version>
- X-Date: <AddOn release date>
- Author: <Author name>
- X-Email: <Author email address>
- X-Website: <Author website address>
- X-Category: <AddOn category name>
- X-Help: <AddOn help variable name>
- X-OptionsFrame: <AddOn options frame name>
- RequiredDeps:
- OptionalDeps:
- LoadOnDemand: <loadable by myAddOns?>
- SavedVariables:
- SavedVariablesPerCharacter:
The category name has to be one of the following:
- MYADDONS_CATEGORY_AUDIO
- MYADDONS_CATEGORY_BARS
- MYADDONS_CATEGORY_BATTLEGROUNDS
- MYADDONS_CATEGORY_CHAT
- MYADDONS_CATEGORY_CLASS
- MYADDONS_CATEGORY_COMBAT
- MYADDONS_CATEGORY_COMPILATIONS
- MYADDONS_CATEGORY_DEVELOPMENT
- MYADDONS_CATEGORY_GUILD
- MYADDONS_CATEGORY_INVENTORY
- MYADDONS_CATEGORY_MAP
- MYADDONS_CATEGORY_OTHERS
- MYADDONS_CATEGORY_PLUGINS
- MYADDONS_CATEGORY_PROFESSIONS
- MYADDONS_CATEGORY_QUESTS
- MYADDONS_CATEGORY_RAID
If not, your AddOn will be listed in the 'Unknown' cateogry.
That's all you need to register your AddOn. You don't have to add anything
in your code.
> Manual method
However if you want to override the toc values, you can register manually your
AddOn by calling the following function:
myAddOnsFrame_Register(details, help);
The details variable is required. Use it to update the details of your AddOn.
The help variable is optional. Use it to update the help for your AddOn.
The details variable has the following structure:
details = {
name = 'HelloWorld',
version = '1.0',
releaseDate = 'January XX, 20XX',
author = 'Anyone',
email = 'anyone@anywhere.com',
website = 'http://www.anywhere.com',
category = MYADDONS_CATEGORY_OTHERS,
optionsframe = 'HelloWorldOptionsFrame'
};
The only required field is the name. It has to match the name of the directory/toc
file of your AddOn or its title in the toc file. If it doesn't an error will be
printed in the chat window and the registration will fail. This name field is used
to identify your AddOn within myAddOns. myAddOns will use the title in the toc file
to display your AddOn in the AddOns list.
The other fields are non mandatory and will overwrite the values extracted from the
toc file.
You have to use one of the global variables described above to populate the category
field. They are localized in english, french and german. If you don't, your AddOn
will be listed in the 'Unknown' category.
The optionsframe field is used to detect if your AddOn has an options frame and
make a link to it. myAddOns will use the Show() function to open it.
The help variable has the following structure:
HelloWorldHelp = {};
HelloWorldHelp[1] = 'Help Page1 line1nline2nline3...';
HelloWorldHelp[2] = 'Help Page2 line1nline2nline3...';
Each item in the table is a help page. You have to use the 'n' character to mark the
end of the lines.
FAQ
Q: My AddOn XYZ is not listed! Why??
A: Check if you enabled it at the character selection screen. Check if it has a
required dependency that is missing.
Q: I get the following error in my chat window: 'Error during the registration of
<addon> in myAddOns.'. What does it mean?
A: This error message means that the AddOn named '<addon>' is trying to register
with an unknown name/title. Check with the author if he can update his AddOn to
make it compatible with the new registration method. Anyway this has no impact on
the gameplay or on myAddOns so everything should be working okay.
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...
