Simple example frame with LibDBIcon minimap button (for review)

[Codger]

This is a simple example of an addon with a frame and minimap button(using LibDBIcon-1.0).
Since I'm fairly new to addon development I thought I would post this to see if there is anything I should do differently.
This will require a Libs directory in the MyAddon directory that contains the LibDBIcon-1.0 library.

This is the .toc file:

## Title: MyAddon
## Interface: 100206
## Version: 1.0
## Author: 
## Notes: A simple WoW addon with a minimap button
embeds.xml
MyAddon.lua

Here is the embeds.xml file:

<Ui xsi:schemaLocation="http://www.blizzard.com/wow/ui/ ..\FrameXML\UI.xsd">
    <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua"/>  
</Ui>

Here is the lua file:

local LibDBIcon = LibStub("LibDBIcon-1.0")
 
local frame = CreateFrame("Frame", "MyAddonFrame", UIParent, "BackdropTemplate")
frame:SetBackdrop({
      bgFile="Interface\\DialogFrame\\UI-DialogBox-Background", 
      edgeFile="Interface\\DialogFrame\\UI-DialogBox-Border", 
      tile=1, tileSize=32, edgeSize=32, 
      insets={left=10, right=10, top=10, bottom=10}
})
frame:SetPoint("CENTER")
frame:SetSize(200, 200)
frame:EnableMouse(true)
frame:SetMovable(true)
frame:RegisterForDrag("LeftButton")
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStop", function(self) self:StopMovingOrSizing() end)
local fontStr = frame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
fontStr:SetPoint("CENTER")
fontStr:SetText("MyAddonFrame")
frame:Show()
 
-- Create a minimap button
local icon = LibDBIcon:Register("MyAddon", {
    icon = "Interface\\Icons\\Ability_Marksmanship",
    OnClick = function(self, button)
        if button == "LeftButton" then
            if frame:IsShown() then
                frame:Hide()
            else
                frame:Show()
            end
        elseif button == "RightButton" then
            print("Right click not configured")
        end
    end,
    OnTooltipShow = function(tooltip)
        tooltip:SetText("MyAddon")
        tooltip:AddLine("Left-click to open / close", 1, 1, 1)
        tooltip:AddLine("Right-click not configured", 1, 1, 1)
    end,
})

[Fizzlemizz]

LibDBIcon has dependancies on LibStub and LibCallBackHandler. Those should both be included in your addon (lib folder) and .toc (or other .XML include file eg. embeds.xml) in case the user doesn't have another addon that does include them (libs aren't automatically included or loaded).

Frame names are also added to the global table and should also be unique "CodgerAddonFrame" instead of "MyAddonFrame". If it has a name (and is unique) you can use it in your show/hide code

OnClick = function(self, button)
        if button == "LeftButton" then
            CodgerAddonFrame:SetShown(not CodgerAddonFrame:IsShown()) -- toggle show/hide
        elseif button == "RightButton" then
            print("Right click not configured")
        end
    end,

Edit: Missed the "MyAddon" in:

local icon = LibDBIcon:Register("MyAddon", {

It should also be unique (like the name of your addon folder).

[Codger]

This is a simple example of an addon with a frame and minimap button(using LibDBIcon-1.0).
The Addon has been renamed to "MyAddonFrameExample" to incorporate some necesssary changes noted in the forum thread above by Fizzelmizz (Thank you!!)
The addon consists of three files and a Libs directory containing the four required libraries.
The three files are located in the "MyAddonFrameExample" directory and are:

• MyAddonFrameExample.toc
• core.lua
• embeds.xml

Four libraries are required and must be installed into the Libs directory contained in the MyAddonFrameExample directory. The required libraries are(in order of dependency):
embeds.xml

• LibStub
• CallbackHandler-1.0
• LibDataBroker-1.1
• LibDBIcon-1.0

Here is the MyAddonFrameExample.toc file:

## Title: MyAddonFrameExample
## Interface: 100206
## Version: 1.0
## Author: 
## Notes: A simple WoW addon with a minimap button derived from LibDB-Icon
embeds.xml
core.lua

Here is the embeds.xml file:

<Ui xsi:schemaLocation="http://www.blizzard.com/wow/ui/ ..\FrameXML\UI.xsd">
    <Script file="Libs\LibStub\LibStub.lua"/>
    <Include file="Libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
    <Script file="Libs\LibDataBroker-1.1\LibDataBroker-1.1.lua"/>    
    <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua"/>  
</Ui>

Here is the core.lua file:

local LibDBIcon = LibStub("LibDBIcon-1.0")
 
--Frame names are global and must be unique: 'MyAddonFrameExample'
local frame = CreateFrame("Frame", "MyAddonFrameExample", UIParent, "BackdropTemplate")
frame:SetBackdrop({
      bgFile="Interface\\DialogFrame\\UI-DialogBox-Background", 
      edgeFile="Interface\\DialogFrame\\UI-DialogBox-Border", 
      tile=1, tileSize=32, edgeSize=32, 
      insets={left=10, right=10, top=10, bottom=10}
})
frame:SetPoint("CENTER")
frame:SetSize(200, 200)
frame:EnableMouse(true)
frame:SetMovable(true)
frame:RegisterForDrag("LeftButton")
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStop", function(self) self:StopMovingOrSizing() end)
local fontStr = frame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
fontStr:SetPoint("CENTER")
fontStr:SetText("MyAddonFrameExample")
frame:Show()
 
-- Create a minimap button  
local icon = LibDBIcon:Register("MyAddonFrameExample", {
    icon = "Interface\\Icons\\inv_gizmo_bronzeframework_01",
    OnClick = function(self, button)
        if button == "LeftButton" then
            MyAddonFrameExample:SetShown(not MyAddonFrameExample:IsShown()) -- toggle show/hide
        elseif button == "RightButton" then
            print("Right click not configured")
        end
    end,
    OnTooltipShow = function(tooltip)
        tooltip:SetText("MyAddonFrameExample")
        tooltip:AddLine("Left-click to open / close", 1, 1, 1)
        tooltip:AddLine("Right-click not configured", 1, 1, 1)
    end,
})

[Fizzlemizz]

That actual code isn't using LibDataBroker-1.1 but I'm guessing it's all meant to come together with the previous code (or other).

As a frame that shows/hides using the minimap button, it works as is.

[Codger]

Ok. I'm still trying to figure this stuff out. Thanks again for your thoughtful and instructional replies.
The reason I thought I needed it was an entry in the Libs\LibDBIcom-1.0\embeds.xml file

<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/..\FrameXML\UI.xsd">
 
<Script file="LibStub\LibStub.lua"/>
<Script file="CallbackHandler-1.0\CallbackHandler-1.0.lua"/>
<Script file="LibDataBroker-1.1\LibDataBroker-1.1.lua"/>
 
</Ui>

After looking at the embeds file I was thinking maybe I should have included a link to the Libs\LibDBIcom-1.0\embeds.xml
rather than the Libs\LibDBIcom-1.0\LibDBIcon-1.0.lua file in my addon embeds.xml file as it appears to have the
libraries and dependencies in the LibDBIcon xml file.

However when I tried to do that the LibDBIcon xml file contained a split line which generated an error.
I didn't want to change my local LibDBIcon library as others who use this example may not have a
working version of the library to depend on and the example would fail so I included all four of the libraries
in my addon embeds.xml file.

[Fizzlemizz]

You have two (for want of a better term) "primary" libraries (although your posted code only uses LibDBIcon)

• LibDBIcon -- Creates manages the minimap button
• LibDataBroker -- Helps creating plugins for addons like TitanPanel.

Both of these use (depend on) LibStub (a library for managing library versioning) and LibCallBackHandler (for handling callbacks).

If your included a libraries depend on another library (or more) then the "sub-libraries" also need to be included in your addon and listed in the .toc (or via an xml file that does this).

Other addons may also use/include the same libraries (and sub-libraries). The loading of these is managed via LibStub.

    <Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/..\FrameXML\UI.xsd">
     
    <Script file="LibStub\LibStub.lua"/>
    <Script file="CallbackHandler-1.0\CallbackHandler-1.0.lua"/>
     <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua"/>
    </Ui>

Only include LibDataBroker-1.1 if you are actually using it (maybe you are, it just wasn't it the code you posted).

[Xrystal]

Codger, if you want to have a look at a relatively simple addon that uses the libdatabroker part of the library you can grab a copy of my AltILevel addon I created 10 years ago. It was still working as of the start of dragonflight. But with some of the minimap having changes this patch ( Tracking frame name changed .. again ) I might have to test it out again rofl.


https://www.wowinterface.com/downloa...AltILevel.html

[Codger]

I loaded the Xinfo addon but I'm not seeing a menu come up?

[Xrystal]

Originally Posted by Codger I loaded the Xinfo addon but I'm not seeing a menu come up?

It doesn't come up on the minimap button. My addon uses the LibDataBroker part to place a button display on things like titanpanel, chocolatebar type of addons. The addon page explains that.

But, on clicking that button, it should start generating a list of your characters as you log them in. Like in the screenshots on the addon page.

Edit:
Just double checked in case it had bugged out and it still works as expected.

An addon like chocolatebar ( only one available when I tested at the start of dragonflight ) is needed, and you need to select to show text or show label as I have no icon for the addon. After that mousing over, left clicking or right clicking will show a variety of windows/menus.

[Codger]

This fixes an issue affecting coordination with other addons.
I noticed that although the icon was being shown on the mini-map, addons that combined mini-map buttons would not display this addons icon. This version fixes that problem by adding libdatabroker to handle communication between this addon and others that may need to coordinate with it; including as examples; leatrix plus and titan panel.

This addon is using the four libraries: CallbackHandler-1.0, LibDataBroker-1.1, LibDBIcon-1.0 and LibStub.

Here is the MyAddonFrameExample.toc file:

## Title: MyAddonFrameExample
## Interface: 100206
## Version: 2.0
## Author: Codger
## Notes: A simple WoW addon with a minimap button derived from LibDB-Icon
## OptionalDeps: LibDBIcon-1.0, LibDataBroker-1.1.lua
## IconTexture: Interface\\Icons\\inv_gizmo_bronzeframework_01
 
embeds.xml
core.lua

Here is the embeds.xml file:

<Ui xsi:schemaLocation="http://www.blizzard.com/wow/ui/ ..\FrameXML\UI.xsd">
    <Script file="Libs\LibStub\LibStub.lua"/>
    <Include file="Libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
    <Script file="Libs\LibDataBroker-1.1\LibDataBroker-1.1.lua"/>    
    <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua"/>  
</Ui>

Here is the core.lua file:

local addon = LibStub("AceAddon-3.0"):NewAddon("MyAddonFrameExample")  
local MyAddonFrameExampleLDB = LibStub("LibDataBroker-1.1"):NewDataObject("MyAddonFrameExample", {  
    type = "data source",  
    text = "MyAddonFrameExample!",  
    icon = "Interface\\Icons\\inv_gizmo_bronzeframework_01",  
    OnClick = function(self, button)
        if button == "LeftButton" then
            MyAddonFrameExample:SetShown(not MyAddonFrameExample:IsShown()) -- toggle show/hide
        elseif button == "RightButton" then
            ReloadUI()
        end
    end,
    OnTooltipShow = function(tooltip)
        tooltip:SetText("MyAddonFrameExample")
        tooltip:AddLine("Left-click to open / close", 1, 1, 1)
        tooltip:AddLine("Right-click to Reload Ui", 1, 1, 1)
    end,
})  
local icon = LibStub("LibDBIcon-1.0")  
 
function addon:OnInitialize()
    -- Assuming you have a ## SavedVariables: BunniesDB line in your TOC
    self.db = LibStub("AceDB-3.0"):New("BunniesDB", {
        profile = {
            minimap = {
                hide = false,
            },
        },
    })
    icon:Register("MyAddonFrameExample", MyAddonFrameExampleLDB, self.db.profile.minimap)
end
 
--Frame names are global and must be unique: 'MyAddonFrameExample'
local frame = CreateFrame("Frame", "MyAddonFrameExample", UIParent, "BackdropTemplate")
frame:SetBackdrop({
      bgFile="Interface\\DialogFrame\\UI-DialogBox-Background", 
      edgeFile="Interface\\DialogFrame\\UI-DialogBox-Border", 
      tile=1, tileSize=32, edgeSize=32, 
      insets={left=10, right=10, top=10, bottom=10}
})
frame:SetPoint("CENTER")
frame:SetSize(200, 200)
frame:EnableMouse(true)
frame:SetMovable(true)
frame:RegisterForDrag("LeftButton")
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStop", function(self) self:StopMovingOrSizing() end)
local fontStr = frame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
fontStr:SetPoint("CENTER")
fontStr:SetText("MyAddonFrameExample")
frame:Show()

[Codger]

So I must have been lucky enough in my previous testing to have had another addon installed that loaded AceDB-3.0. A new Wow install due to a computer crash revealed the bug due to the missing library. I also added a saved variable for the database and renamed it from BunniesDB to MyAddonFrameExampleDB and included it in the .toc file.

This addon is using the five libraries: CallbackHandler-1.0, LibDataBroker-1.1, AceDB-3.0, LibDBIcon-1.0 and LibStub.

Here is the MyAddonFrameExample.toc file:

## Title: MyAddonFrameExample
## Interface: 100206
## Version: 2.0
## Author: Codger
## Notes: A simple WoW addon with a minimap button derived from LibDB-Icon
## OptionalDeps: LibDBIcon-1.0, LibDataBroker-1.1.lua
## IconTexture: Interface\\Icons\\inv_gizmo_bronzeframework_01
## SavedVariables: MyAddonFrameExampleDB
 
embeds.xml
core.lua

Here is the embeds.xml file with the added library. The order of the libraries is important/:

<Ui xsi:schemaLocation="http://www.blizzard.com/wow/ui/ ..\FrameXML\UI.xsd">
    <Script file="Libs\LibStub\LibStub.lua"/>
    <Include file="Libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
    <Include file="Libs\AceDB-3.0\AceDB-3.0.xml"/>
    <Script file="Libs\LibDataBroker-1.1\LibDataBroker-1.1.lua"/>    
    <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua"/>  
</Ui>

And the core.lua file:

local addon = LibStub("AceAddon-3.0"):NewAddon("MyAddonFrameExample")  
local MyAddonFrameExampleLDB = LibStub("LibDataBroker-1.1"):NewDataObject("MyAddonFrameExample", {  
    type = "data source",  
    text = "MyAddonFrameExample!",  
    icon = "Interface\\Icons\\inv_gizmo_bronzeframework_01",  
    OnClick = function(self, button)
        if button == "LeftButton" then
            MyAddonFrameExample:SetShown(not MyAddonFrameExample:IsShown()) -- toggle show/hide
        elseif button == "RightButton" then
            ReloadUI()
        end
    end,
    OnTooltipShow = function(tooltip)
        tooltip:SetText("MyAddonFrameExample")
        tooltip:AddLine("Left-click to open / close", 1, 1, 1)
        tooltip:AddLine("Right-click to Reload Ui", 1, 1, 1)
    end,
})  
local icon = LibStub("LibDBIcon-1.0")  
 
function addon:OnInitialize()
    self.db = LibStub("AceDB-3.0"):New("MyAddonFrameExampleDB", {
        profile = {
            minimap = {
                hide = false,
            },
        },
    })
    icon:Register("MyAddonFrameExample", MyAddonFrameExampleLDB, self.db.profile.minimap)
end
 
--Frame names are global and must be unique: 'MyAddonFrameExample'
local frame = CreateFrame("Frame", "MyAddonFrameExample", UIParent, "BackdropTemplate")
frame:SetBackdrop({
      bgFile="Interface\\DialogFrame\\UI-DialogBox-Background", 
      edgeFile="Interface\\DialogFrame\\UI-DialogBox-Border", 
      tile=1, tileSize=32, edgeSize=32, 
      insets={left=10, right=10, top=10, bottom=10}
})
frame:SetPoint("CENTER")
frame:SetSize(200, 200)
frame:EnableMouse(true)
frame:SetMovable(true)
frame:RegisterForDrag("LeftButton")
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStart", function(self) self:StartMoving() end)
frame:SetScript("OnDragStop", function(self) self:StopMovingOrSizing() end)
local fontStr = frame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
fontStr:SetPoint("CENTER")
fontStr:SetText("MyAddonFrameExample")
frame:Show()