[FeedTillers] Feed them their favourites!

[myrroddin]

FeedTillers very simply tells you the Tiller (Sho, Old Hillpaw, etc), their favourite dish for the daily quests A Dish For ..., and if you have fed them today. It plugs into any Broker display, and is so basic, there are no options!

Come look at the pretty picture!!

If you know other languages, please help with your Curse user name and password via the localization app.

There is more information on the project page, and can be downloaded on WoWInterface and Curse.

[Phanx]

Originally Posted by myrroddin If you know other languages, please help with your Curse user name and password via the localization app.

I'm pretty sure I'm not supposed to give you my Curse user name and password.

That said, I did give you a Spanish translation for the description. I didn't translate the addon name, as names are generally not translated.

[myrroddin]

Silliness aside, I don't want your user name and password, only that people use theirs to log in and translate LOL.

And I saw the Spanish translations, Phanx, and thank you. You could, in this case, translate the addon name because I only use it for display purposes, and "Feed Tillers" looks better than "FeedTillers".

[myrroddin]

I have Release 1.0.2 up, which fixes the log in error; public version works, not just developer build. I fail at string-fu!

Also, the Tillers changed their display order to match the order of faction ID. Cosmetic, but if Blizzard ever changes the list of Tillers, this makes it easier to keep track in the code.

[Phanx]

I made the mistake of looking at your code.

It's actually not that bad, but I rewrote it anyway. AceAddon seemed like overkill, so I removed it. I also removed all of the localization in the Lua file in favor of just pulling the translated name from the TOC via GetAddOnMetadata, and replaced all of the unnecessary upvalues with "GLOBALS: ..." comments which will keep FindGlobals from complaining, though personally I only use FindGlobals to check for set globals, not read ones.

I also moved to a table for storing NPC/item/quest IDs. Localized names are looked up on-demand and cached in the table. This allows easily sorting the display by any criteria, while retaining whatever order you find most convenient in the source code.

By default, all quests are shown, and tooltip lines are sorted by NPC name. Click the plugin to toggle between sorting by NPC name or item name. Shift-click to toggle between showing or hiding completed quests. You could easily save the sort and filter between sessions by changing the "currentSort" and "hideComplete" local variables to more distinctly-named global variables and listing them as SavedVariables in the TOC. I did not add any tooltip hints, since that would require localization, but it would be easy to add if you wanted.

I also aligned each column so my eyes can stop bleeding while looking at it, and highlighted each line green or red depending on quest completion status.

Feel free to make this the official version.

-- GLOBALS: sort, GetAddOnMetadata, GetFactionInfoByID, GetItemInfo, IsQuestFlaggedCompleted
-- GLOBALS: COMPLETE, ITEMS, NO, YES
-- GLOBALS: LibStub

local ADDON = ...
local ADDON_TITLE = GetAddOnMetadata(ADDON, "Title")
local TILLERS

local qtip = LibStub("LibQTip-1.0")

local npcs = {
	{ factionID = 1273, itemID = 74643, questID = 30439 }, -- Jogu the Drunk
	{ factionID = 1275, itemID = 74651, questID = 30386 }, -- Ella
	{ factionID = 1276, itemID = 74649, questID = 30396 }, -- Old Hillpaw
	{ factionID = 1277, itemID = 74647, questID = 30402 }, -- Chee Chee
	{ factionID = 1278, itemID = 74645, questID = 30408 }, -- Sho
	{ factionID = 1279, itemID = 74642, questID = 30414 }, -- Haohan Mudclaw
	{ factionID = 1280, itemID = 74652, questID = 30433 }, -- Tina Mudclaw
	{ factionID = 1281, itemID = 74644, questID = 30390 }, -- Gina Mudclaw
	{ factionID = 1282, itemID = 74655, questID = 30427 }, -- Fish Fellreed
	{ factionID = 1283, itemID = 74654, questID = 30421 }, -- Farmer Fung
}

local currentSort, hideComplete, tooltip = "NAME"
local sortByName = function(a, b)
	return a.name < b.name
end
local sortByItem = function(a, b)
	return a.item < b.item
end

LibStub("LibDataBroker-1.1"):NewDataObject(ADDON, {
	type = "data source",
	text = ADDON_TITLE,
	icon = [[Interface/ICONS/Achievement_Profession_ChefHat]],
	OnClick = function(self)
		if IsShiftKeyDown() then
			hideComplete = not hideComplete
		else
			currentSort = currentSort == "NAME" and "ITEM" or "NAME"
			sort(npcs, currentSort == "NAME" and sortByName or sortByItem)
		end
		self:GetScript("OnLeave")(self)
		self:GetScript("OnEnter")(self)
	end,
	OnEnter = function(self)
		if not TILLERS then
			TILLERS = GetFactionInfoByID(1272)
			for i = 1, #npcs do
				local npc = npcs[i]
				npc.name = GetFactionInfoByID(npc.factionID)
			end
			sort(npcs, sortByName)
		end

		tooltip = qtip:Acquire("FeedTillersTT", 3, "LEFT", "LEFT", "RIGHT")
		tooltip:AddHeader(TILLERS, ITEMS, COMPLETE)
		for i = 1, #npcs do
			local npc = npcs[i]
			if not npc.item then
				npc.item = GetItemInfo(npc.itemID)
			end
			if not IsQuestFlaggedCompleted(npc.questID) then
				local line = tooltip:AddLine(npc.name, npc.item, NO)
				tooltip:SetLineColor(line, 1, 0.1, 0.1, 0.3)
			elseif not hideComplete then
				local line = tooltip:AddLine(npc.name, npc.item, YES)
				tooltip:SetLineColor(line, 0.1, 1, 0.1, 0.3)
			end
		end
		tooltip:SmartAnchorTo(self)
		tooltip:Show()
	end,
	OnLeave = function(self)
		if qtip:IsAcquired("FeedTillersTT") then
			qtip:Release(tooltip)
		end
		tooltip = nil
	end
})

[myrroddin]

Good thing the dailies just reset. Bad thing is I need sleep. But I'll give it a whirl. If my tired eyes are reading correctly, I can reduce the pkgmeta and toc to just LibStub, LibDataBroker-1.1, and FeedTillers.lua.

And sorry for making you curious enough to look at my code

[Phanx]

Well, you also need LibQTip, though I suppose you could actually do away with that, since you could just do two columns with "<npc> / <item>" for incomplete quests and "<npc> / Complete" for complete ones:

	OnTooltipShow = function(tooltip)
		if not TILLERS then
			TILLERS = GetFactionInfoByID(1272)
			for i = 1, #npcs do
				local npc = npcs[i]
				npc.name = GetFactionInfoByID(npc.factionID)
			end
			sort(npcs, sortByName)
		end

		tooltip:AddDoubleLine(TILLERS, ITEMS)
		for i = 1, #npcs do
			local npc = npcs[i]
			if not npc.item then
				npc.item = GetItemInfo(npc.itemID)
			end
			if not IsQuestFlaggedCompleted(npc.questID) then
				tooltip:AddDoubleLine(npc.name, npc.item, 1, 0.8, 0.8, 1, 0.8, 0.8)
			elseif not hideComplete then
				tooltip:AddDoubleLine(npc.name, COMPLETE, 0.6, 0.8, 0.6, 0.6, 0.8, 0.6)
			end
		end
		tooltip:Show()
	end

[myrroddin]

Originally Posted by Phanx Well, you also need LibQTip

I just forgot to mention it. But either case, it will have to wait until later tonight until I can poke at it. Work beckons. I will try both and see which I prefer.

[myrroddin]

I just uploaded an alpha to the WoWAce project site, using Phanx's first version, because it looks the most similar to what I had visually. Therefore, no end user shock, or very little.

It might be good of me to cave in and add saved variables to maintain the sort through logging sessions, and put in a mouse over script to indicate that things can be sorted. That can come later.

[myrroddin]

Saved variables are in, which save the column sort by name or item, and holding <shift> + click to hide completed Tillers. Also added is localization for the tooltip help. But it looks terrible, and I have tried a few variants of formatting. Any suggestions on how to adjust the placement of the hints, starting line 97, is welcome.

On a side note, there are now four strings that need localizing, up from two. Still a tiny addon.

--[[
    - file and project errata -
    Project Author:     @project-author@
    Project Date:       @project-date-iso@
    Project Version:    @project-version@
    Project Revision:   @project-revision@
    
    File Author:        @file-author@
    File Date:          @file-date-iso@
    File Revision:      @file-revision@
]]--
 
-- GLOBALS: sort, GetAddOnMetadata, GetFactionInfoByID, GetItemInfo, IsQuestFlaggedCompleted, GetLocale
-- GLOBALS: COMPLETE, ITEMS, NO, YES, GameTooltip
-- GLOBALS: LibStub
-- GLOBALS: FeedTillers_hideComplete, FeedTillers_currentSort
 
local ADDON, L = ...
local ADDON_TITLE = GetAddOnMetadata(ADDON, "Title")
local TILLERS
local LOCALE = GetLocale()
local event_frame = CreateFrame("frame")
 
-- translate the tooltips
if LOCALE == "esES" then
--@localization(locale="esES", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "esMX" then
--@localization(locale="esMX", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "itIT" then
--@localization(locale="itIT", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "ptBR" then
--@localization(locale="ptBR", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "frFR" then
--@localization(locale="frFR", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "deDE" then
--@localization(locale="deDE", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "ruRU" then
--@localization(locale="ruRU", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "zhCN" then
--@localization(locale="zhCN", format="lua_additive_table", namespace="Normal")@
elseif LOCALE == "zhTW" then
--@localization(locale="zhTW", format="lua_additive_table", namespace="Normal")@
else
L["CLICK_SORT"] = "Click the plugin to sort by Tiller name or item name"
L["SHIFT_DOWN"] = "Hold the <Shift> key and click to hide already fed Tillers"
end
 
local qtip = LibStub("LibQTip-1.0")
 
local npcs = {
    { factionID = 1273, itemID = 74643, questID = 30439 }, -- Jogu the Drunk
    { factionID = 1275, itemID = 74651, questID = 30386 }, -- Ella
    { factionID = 1276, itemID = 74649, questID = 30396 }, -- Old Hillpaw
    { factionID = 1277, itemID = 74647, questID = 30402 }, -- Chee Chee
    { factionID = 1278, itemID = 74645, questID = 30408 }, -- Sho
    { factionID = 1279, itemID = 74642, questID = 30414 }, -- Haohan Mudclaw
    { factionID = 1280, itemID = 74652, questID = 30433 }, -- Tina Mudclaw
    { factionID = 1281, itemID = 74644, questID = 30390 }, -- Gina Mudclaw
    { factionID = 1282, itemID = 74655, questID = 30427 }, -- Fish Fellreed
    { factionID = 1283, itemID = 74654, questID = 30421 }, -- Farmer Fung
}
 
local tooltip = "NAME"
local sortByName = function(a, b)
    return a.name < b.name
end
local sortByItem = function(a, b)
    return a.item < b.item
end
 
local function CreateBroker()
    LibStub("LibDataBroker-1.1"):NewDataObject(ADDON, {
        type = "data source",
        text = ADDON_TITLE,
        icon = [[Interface/ICONS/Achievement_Profession_ChefHat]],
        OnClick = function(self)
            if IsShiftKeyDown() then
                FeedTillers_hideComplete = not FeedTillers_hideComplete
            else
                FeedTillers_currentSort = FeedTillers_currentSort == "NAME" and "ITEM" or "NAME"
                sort(npcs, FeedTillers_currentSort == "NAME" and sortByName or sortByItem)
            end
            self:GetScript("OnLeave")(self)
            self:GetScript("OnEnter")(self)
        end,
        OnEnter = function(self)
            if not TILLERS then
                TILLERS = GetFactionInfoByID(1272)
                for i = 1, #npcs do
                    local npc = npcs[i]
                    npc.name = GetFactionInfoByID(npc.factionID)
                end
                sort(npcs, sortByName)
            end
            
            tooltip = qtip:Acquire("FeedTillersTT", 3, "LEFT", "LEFT", "RIGHT")
            tooltip:AddLine(nil, nil, L.CLICK_SORT)
            tooltip:AddLine(nil, nil, L.SHIFT_DOWN)
            tooltip:AddLine("", "", "")
            tooltip:AddHeader(TILLERS, ITEMS, COMPLETE)
            for i = 1, #npcs do
                local npc = npcs[i]
                if not npc.item then
                    npc.item = GetItemInfo(npc.itemID)
                end
                if not IsQuestFlaggedCompleted(npc.questID) then
                    local line = tooltip:AddLine(npc.name, npc.item, NO)
                    tooltip:SetLineColor(line, 1, 0.1, 0.1, 0.3)
                elseif not FeedTillers_hideComplete then
                    local line = tooltip:AddLine(npc.name, npc.item, YES)
                    tooltip:SetLineColor(line, 0.1, 1, 0.1, 0.3)
                end
            end
            tooltip:SmartAnchorTo(self)
            tooltip:Show()
        end,
        OnLeave = function(self)
            if qtip:IsAcquired("FeedTillersTT") then
                qtip:Release(tooltip)
            end
            tooltip = nil
        end
    })
end
 
event_frame:RegisterEvent("ADDON_LOADED")
event_frame:SetScript("OnEvent", function(self, event, ...)
    if event == "ADDON_LOADED" and ... == ADDON then    
        if not FeedTillers_hideComplete then
            FeedTillers_hideComplete = false
        end
        if not FeedTillers_currentSort then
            FeedTillers_currentSort = "NAME"
        end
    end 
    CreateBroker()
    self:UnregisterEvent("ADDON_LOADED")
end)

[Phanx]

Added:

• in yellow: hints at the bottom of the tooltip that span all 3 cells,
• in pink: item counts instead of just "No" for not-yet-completed quests, with quests that are ready to turn in no longer highlighted in red,
• in green: auto-switching back to showing completed quests once all quests have been completed (you might want to use a second variable for this so as not to mess with the saved variable, or just take it out).

tooltip:AddHeader(TILLERS, ITEMS, COMPLETE)
local line
for i = 1, #npcs do
	local npc = npcs[i]
	if not npc.item then
		npc.item = GetItemInfo(npc.itemID)
	end
	if not IsQuestFlaggedCompleted(npc.questID) then
		-- note "line" is no longer local to this scope!
		local count = GetItemCount(npc.itemID)
		line = tooltip:AddLine(npc.name, npc.item, format("%d/%d", count, 5))
		if count < 5 then
			tooltip:SetLineColor(line, 1, 0.1, 0.1, 0.3)
		end
	elseif not hideComplete then
		line = tooltip:AddLine(npc.name, npc.item, YES)
		tooltip:SetLineColor(line, 0.1, 1, 0.1, 0.3)
	end
end

if not line then
	hideComplete = nil
	self:GetScript("OnLeave")(self)
	return self:GetScript("OnEnter")(self)
end

line = tooltip:AddLine(" ") -- blank line

line = tooltip:AddLine(" ")
tooltip:SetCell(line, 1, NORMAL_FONT_COLOR_CODE .. L.CLICK_SORT, "LEFT", 3)

line = tooltip:AddLine(" ")
tooltip:SetCell(line, 1, NORMAL_FONT_COLOR_CODE .. L.SHIFT_DOWN, "LEFT", 3)

tooltip:SmartAnchorTo(self)
tooltip:Show()

[myrroddin]

Release 1.0.3 is out with Phanx's changes and improvements. It is already available on Curse, and will be available here as soon as the moderators have a chance.

There are two shiny new screenshots, with the outdated ones removed, as while Feed Tillers looks similar to previous versions, there are a some marked differences.