What it does
Lib About Panel is a small library which will add an about panel to your Blizzard interface options. You can specify whether or not to have the panel linked to a main panel, or just have it created separately. It will populate the fields of the about panel from the fields located in your ToC.
Where to get it
CurseForge - Often Beta quality
Curse - Most updated stable version
How to get it to work
To create the about panel, just add the following line of code into your mod:
LibStub("LibAboutPanel").new(parentframe, addonname)
It will also return the frame so you can call it like:
frame = LibStub("LibAboutPanel").new(parentframe, addonname)
The parentframe option may be nil, in which case it will not anchor the about panel to any frame. Otherwise, it will anchor the about frame to that frame.
The second option is the name of your add-on. This is manditory as the about panel will pull all information from this add-ons ToC.
The ToC fields which the add-on reads are:
"Notes"
"Version"
"Author"
"X-Author-Faction"
"X-Author-Server"
"X-Category"
"X-License"
"X-Email"
"X-Website"
"X-Credits"
"X-Localizations"
"X-Donate"
It will only read fields when they exist, and skip them if they do not exist.
Example Code
ToC File:
## Title: Alt-Tabber
## Notes: Plays a noise when you're alt-tabbed for a ready check (even when sound is turned off)
## Notes-enUS: Plays a noise when you're alt-tabbed for a ready check (even when sound is turned off)
## Author: Ackis
## X-Author-Server: Illidan US
## X-Author-Faction: Horde
## eMail: ackis AT shaw DOT ca
## X-email: ackis AT shaw DOT ca
## X-License: MIT modified with notification clause
## X-Donate: Send me UDE Point codes, a Murky Code, or donate a few bucks/hours at your local animal shelter.
## Interface: 20400
## Version: 1.2
## X-Revision: $Rev: 78812 $
## X-Date: $Date: 2008-07-20 14:41:47 -0600 (Sun, 20 Jul 2008) $
## X-credits:
## X-Category: Raid
## X-Localizations: enUS
## X-Website: http://www.wowwiki.com/AltTabber/
## X-Feedback: http://www.curse.com/downloads/details/12774/
## X-AceForum: 13439
## X-RelSite-Curse: 12774
Load the panel in LUA code not attached to anything:
LibStub("LibAboutPanel").new(nil, "AltTabber")
Load the panel in LUA code attached to other panels:
self.optionsFrame[L["About"]] = LibStub("LibAboutPanel").new("Ackis Recipe List", "Ackis Recipe List")
Known Issues
All known issues will be kept at the CurseForge tracker.
Please use the CurseForge tracker to file bug reports.
Wish List
Please use the CurseForge tracker to add suggestions and feature requests.
Bug Reporting
Please use the CurseForge tracker to file bug reports.
Wiki
WoW Wiki
------------------------------------------------------------------------
r20 | ackis | 2008-10-20 17:34:52 +0000 (Mon, 20 Oct 2008) | 1 line
Changed paths:
A /tags/v1.111 (from /trunk:19)
Tagging as v1.111
------------------------------------------------------------------------
r19 | ackis | 2008-10-20 17:31:37 +0000 (Mon, 20 Oct 2008) | 1 line
Changed paths:
M /trunk/LibAboutPanel.toc
I'm an idiot
------------------------------------------------------------------------
r17 | ackis | 2008-10-20 05:06:41 +0000 (Mon, 20 Oct 2008) | 1 line
Changed paths:
M /trunk/LibAboutPanel.toc
ToC Update for 3.02
------------------------------------------------------------------------
r15 | ackis | 2008-10-02 15:27:35 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/LibAboutPanel.toc
Update toc
------------------------------------------------------------------------
r14 | nevcairiel | 2008-10-02 15:21:56 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/.pkgmeta
Fix .pkgmeta
------------------------------------------------------------------------
r13 | ackis | 2008-10-01 19:08:18 +0000 (Wed, 01 Oct 2008) | 1 line
Changed paths:
M /trunk/LibAboutPanel.toc
ToC Update
------------------------------------------------------------------------
r12 | ackis | 2008-08-13 17:26:43 +0000 (Wed, 13 Aug 2008) | 2 lines
Changed paths:
M /trunk/LibAboutPanel.toc
LibAboutPanel:
- Update ToC with release info and wiki page
------------------------------------------------------------------------
r11 | ackis | 2008-08-13 02:12:18 +0000 (Wed, 13 Aug 2008) | 2 lines
Changed paths:
M /trunk/LibAboutPanel.toc
Ackis is dum
------------------------------------------------------------------------
r8 | ackis | 2008-08-12 17:27:44 +0000 (Tue, 12 Aug 2008) | 2 lines
Changed paths:
A /trunk/lib.xml
LibAboutPanel:
- Add lib.xml
------------------------------------------------------------------------
r7 | ackis | 2008-08-12 17:01:33 +0000 (Tue, 12 Aug 2008) | 2 lines
Changed paths:
M /trunk/.pkgmeta
LibAboutPanel:
- Update pkgmeta to add ignore section to ignore .pkgmeta file
------------------------------------------------------------------------
r6 | ackis | 2008-08-12 16:00:02 +0000 (Tue, 12 Aug 2008) | 2 lines
Changed paths:
M /trunk/.pkgmeta
LibAboutPanel:
- Changed pkgmeta into tabs
------------------------------------------------------------------------
r4 | ackis | 2008-08-12 15:26:11 +0000 (Tue, 12 Aug 2008) | 2 lines
Changed paths:
M /trunk/LibAboutPanel.toc
LibAboutPanel:
- Change version number
------------------------------------------------------------------------
r3 | ackis | 2008-08-12 15:23:42 +0000 (Tue, 12 Aug 2008) | 2 lines
Changed paths:
A /trunk/.pkgmeta
LibAboutPanel:
- Add .pkgmeta file
------------------------------------------------------------------------
r2 | ackis | 2008-08-12 15:14:51 +0000 (Tue, 12 Aug 2008) | 2 lines
Changed paths:
A /trunk/LibAboutPanel.lua
A /trunk/LibAboutPanel.toc
A /trunk/embeds.xml
LibAboutPanel:
- Initial commit
------------------------------------------------------------------------
r1 | root | 2008-08-12 15:06:17 +0000 (Tue, 12 Aug 2008) | 1 line
Changed paths:
A /branches
A /tags
A /trunk
"libaboutpanel/mainline: Initial Import"
------------------------------------------------------------------------
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)...