LibAboutPanel-2.0
Table of Contents
- Quick Integration
- Adding LibAboutPanel-2.0 via .pkgmeta
- Ace3 Example Usage
- API Usage
- Supported ToC Fields
- Features
- Troubleshooting
- Contributing
- Full Documentation
LibAboutPanel-2.0
LibAboutPanel-2.0 is a World of Warcraft Lua library for displaying addon metadata in the Interface Options panel or AceConfig-3.0 options tables. It works with Classic Era, Classic, and Retail.
Quick Integration
Dependencies:
- Requires: LibStub, CallbackHandler-1.0, AceConfig-3.0
- Add these to your
.tocand.pkgmetafiles.
Embedding:
- With Ace3:
local MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "LibAboutPanel-2.0") - Without Ace3:
LibStub("LibAboutPanel-2.0"):Embed(MyAddon) - Or use as a standalone library:
local LAP = LibStub("LibAboutPanel-2.0")
- With Ace3:
API Usage:
:CreateAboutPanel(addon, parent)— Adds an About panel to Blizzard's settings.:AboutOptionsTable(addon)— Returns an AceConfig-3.0 options table for About info.- Both APIs auto-detect and display metadata from your
.tocfile, including localized fields.
Supported ToC Fields
- Author, Title, Notes (all languages)
- Version, X-Date, X-ReleaseDate, X-Revision
- X-Author-Guild, X-Author-Faction, X-Author-Server
- X-Website, X-Email, X-Localizations, X-Credits, X-Category
- X-License, X-Copyright
Features
- Automatic localization for faction, locale, and common strings
- Embedded API for easy integration
- AceConfig-3.0 support for flexible UI placement
- Shared editbox for copying fields (email, website)
Troubleshooting
- Ensure all dependencies are listed in your
.tocand loaded before LibAboutPanel-2.0 - For bug reports, provide:
- Addon name, LAP version, WoW version/build, language
- Steps to reproduce, error logs (BugSack, Swatter, etc), screenshots
Contributing
- Help translate or verify localization at CurseForge
- Report bugs or request improvements via the GitHub issue tracker
Adding LibAboutPanel-2.0 via .pkgmeta
To include LibAboutPanel-2.0 in your addon using CurseForge packaging, add the following to your .pkgmeta file:
externals:
Libs/LibStub: https://repos.curseforge.com/wow/libstub/trunk
Libs/CallbackHandler-1.0: https://repos.curseforge.com/wow/callbackhandler/trunk/CallbackHandler-1.0
Libs/AceConfig-3.0: https://repos.curseforge.com/wow/ace3/trunk/AceConfig-3.0
Libs/LibAboutPanel-2.0:
url: https://github.com/Myrroddin/libaboutpanel-2.0/LibAboutPanel-2.0
curse-slug: libaboutpanel-2-0- The
urlpoints to the GitHub repository for the library. - The
curse-slugensures proper packaging and updates via CurseForge.
See also: WIKI.md for full documentation and API reference.
For full API details and examples, see the wiki.
Comments
-
Sygon_Paul Owner
-
Artur91425 Author
-
View User Profile
-
Send Message
Posted Jul 26, 2024Hello!
One of my addon users reported this error. I've tried looking to see if this code was renamed or something but haven't found anything yet. Hoping that this error message helps!
Message: ...omAudio/Libs/LibAboutPanel-2.0/LibAboutPanel-2.0.lua:495: attempt to call global 'InterfaceOptions_AddCategory' (a nil value)
Time: Fri Jul 26 22:39:22 2024
Count: 1
Stack: ...omAudio/Libs/LibAboutPanel-2.0/LibAboutPanel-2.0.lua:495: attempt to call global 'InterfaceOptions_AddCategory' (a nil value)
[string "@Interface/AddOns/ElvUI_Libraries/Core/Ace3/AceAddon-3.0/AceAddon-3.0.lua"]:494: in function `InitializeAddon'
[string "@Interface/AddOns/ElvUI_Libraries/Core/Ace3/AceAddon-3.0/AceAddon-3.0.lua"]:619: in function <...UI_Libraries/Core/Ace3/AceAddon-3.0/AceAddon-3.0.lua:611>
Locals: self = <table> {
initializequeue = <table> {
}
statuses = <table> {
}
embeds = <table> {
}
frame = AceAddon30Frame {
}
addons = <table> {
}
enablequeue = <table> {
}
}
addon = <table> {
modules = <table> {
}
defaultModuleLibraries = <table> {
}
name = "RareScanner"
orderedModules = <table> {
}
db = <table> {
}
baseName = "RareScanner"
enabledState = true
defaultModuleState = true
}
-
View User Profile
-
Send Message
Posted Aug 5, 2024In reply to SweetsourGamer: Thank you for the bug report. I didn't see it because my notifications are for GitHub. I created an issue report and will fix the deprecated API. https://github.com/Myrroddin/libaboutpanel-2.0/issues/1
-
View User Profile
-
Send Message
Posted Aug 6, 2024In reply to Sygon_Paul: Perfect, thank you! I'm the author of the addon and will push the latest version out! I'll also be sure to use your github for any bugs in the future. :)
-
View User Profile
-
Send Message
Posted Aug 9, 2024In reply to SweetsourGamer: Sorry for the late reply. Have you updated your pkgmeta to use the new method to get LibAboutPanel-2.0's repository? The old method works, but adds extra files to your addon which aren't needed. See the main description for details.
-
View User Profile
-
Send Message
Posted Aug 5, 2024In reply to SweetsourGamer: Please tell the author of "...omAudio" to push an updated zip. I cannot read the full name of the addon. The fix is in LibAboutPanel-2.0 version 1.0.71.
-
View User Profile
-
Send Message
Posted Nov 5, 2023Not sure how you managed this; but within the addon; inside "LibAboutPanel-2.0" > "LibStub" -- there are two "LibStub.lua" files.
Which one is needed?
-
View User Profile
-
Send Message
Posted Nov 7, 2023In reply to JDM12983: I'll check on that. There should only be one. EDIT: I looked at a couple of addons I wrote, and see one copy of LibStub. Which addon are looking at?
-
View User Profile
-
Send Message
Posted May 20, 2017Is this ready to be embedded in other addon?
-
View User Profile
-
Send Message
Posted Oct 8, 2019In reply to arithmandar:
Better late than never. I put it in beta October 8, 2019