Support Spectres and Companions, and overhaul Spectre Library (PathOfBuildingCommunity#936)

* initial spectres

* library shows up, and some spectres+skills added

* Tarnished Scarab

* Two more spectres and some skill changes

* Blood Priest and Priestess

* Drudge Osseodon

* Diretusk Boar

* Terracotta Soldier

* Fettered Monstrosity

* Filthy First-born

* experienceMultiplier for Spectre Reservation

* Faridun Spearwoman

* Better Reservation calcs for spectre

* Crabs

* Export Monster Type

* Show Spirit Cost in the spectre library window

* Add monster type to library

* Serpent Shaman and enable spectre curses

* Initial support for Companion and small calc change for reservedFlat

* Add separate beast library

* tooltip shows companion reservation now

* Initial import of Companion/Spectre gems

* Put reservation calcs into exporter

* Imports spectres to spectre list

* import changes and sets current minion to imported one

* Update Spectre/Companion tooltip reservations, and dynamically update gem names

* Update gem names according to selected spectre - mostly

* Moved spectre skills to Spectre.lua

* Sync minion dropdown between calc tab and left bar

* Gem name updates, and dropdowns for minion are in sync

* Companion uses beast list now

* Prowling Shade and potential crash fix

* Replace sub prefix check with match

* Clean up gem tooltip code + fix display issue

Cleans up the code for displaying the reservation
Fixes an issue where the gem name didn't update on opening a saved build

* Tooltip fix for companion

* Cultist Archer, Witch, Daggerdancer

* Spectre life fix and "Show minion stats" refixed

* Fix minion ES and life calcs

* Add Tons of Spectres for import, no skills yet

* Export list of spectres with unique names

* Remove a few spectres and update exporter

* Initial Spectre Library UI Update

* Export monster category images

* Show Monster Images on checkboxes in Spectre Library

* removed test mob

* Spec stuff for Spawn Locations

* Most Spectre Spawn Locations shown in tooltip

* Prettied up library and actually committed tooltip this time

* Preparation for popular spectre list, and some small fixes

* Fix bug on importing build with broken greyed gem

* Recommended Spectres/Beasts button, and removed some spectres

* fix UI more

* sorting name change, forgot

* Spectre build list also shows minion stats if selected

* Fix space indentation

* Some skills and fixes/revert

* Add skillName partialMatch to fix config for spectre curses

* More skills, basic imports as spectre skills are BUUUSTED on db

* More skills, and export minion movement speed for library

* Many skills, spectreList changes, code cleanup, and spectre removals

* Every monster has at least 1 skill now, lots of broken skills to still import though

* More Spec stuff, which lets us grab which Maps some monsters spawn in

* Spawn Locations shown in library, and world Areas imported

* Spec stuff and fixes/cleanup

* Tooltip stuff and sort spawn locations

* Spawn location changes and small fixes

* more worldarea stuff, and random spec.lua

* Tiny fix and spectre change from 0.2.1

* fix comment on top of exporter file

* Fix rounding error for a few monsters

* Update Spec

* Fix act location when act is > 5

With there only being 3 unique acts that are duplicated atm, GGG is using different values internally for the second set of duplicated acts which messes with the tooltips for the spawn location in PoB

* Add comment and remove line

---------

Co-authored-by: LocalIdentity <localidentity2@gmail.com>

Author: Blitz54

src/Classes/CalcsTab.lua

@@ -104,18 +104,36 @@ local CalcsTabClass = newClass("CalcsTab", "UndoHandler", "ControlHost", "Contro
 			control = new("DropDownControl", nil, {0, 0, 160, 16}, nil, function(index, value)
 				local mainSocketGroup = self.build.skillsTab.socketGroupList[self.input.skill_number]
 				local srcInstance = mainSocketGroup.displaySkillListCalcs[mainSocketGroup.mainActiveSkillCalcs].activeEffect.srcInstance
+				-- Synchronize DropDownControl between CalcActiveSkill and skillMinionCalcs
 				if value.itemSetId then
 					srcInstance.skillMinionItemSetCalcs = value.itemSetId
+					srcInstance.skillMinionItemSet = value.itemSetId
+					if srcInstance.nameSpec:match("^Spectre:") then
+						srcInstance.nameSpec = "Spectre: ".. value.label
+					elseif srcInstance.nameSpec:match("^Companion:") then
+						srcInstance.nameSpec = "Companion: ".. value.label
+					end
 				else
 					srcInstance.skillMinionCalcs = value.minionId
+					srcInstance.skillMinion = value.minionId
+					if srcInstance.nameSpec:match("^Spectre:") then
+						srcInstance.nameSpec = "Spectre: ".. value.label
+					elseif srcInstance.nameSpec:match("^Companion:") then
+						srcInstance.nameSpec = "Companion: ".. value.label
+					end
 				end
 				self:AddUndoState()
 				self.build.buildFlag = true
 			end)
 		} },
 		{ label = "Spectre Library", flag = "spectre", { controlName = "mainSkillMinionLibrary",
 			control = new("ButtonControl", nil, {0, 0, 100, 16}, "Manage Spectres...", function()
-				self.build:OpenSpectreLibrary()
+				self.build:OpenSpectreLibrary("spectre")
+			end)
+		} },
+		{ label = "Beast Library", flag = "summonBeast", { controlName = "mainSkillBeastLibrary",
+			control = new("ButtonControl", nil, {0, 0, 100, 16}, "Manage Beasts...", function()
+			self.build:OpenSpectreLibrary("beast")
 			end)
 		} },
 		{ label = "Minion Skill", flag = "haveMinion", { controlName = "mainSkillMinionSkill",

src/Classes/GemSelectControl.lua

@@ -529,7 +529,11 @@ function GemSelectClass:AddGemTooltip(gemInstance)
 	local grantedEffect = gemInstance.gemData.grantedEffect
 	local additionalEffects = gemInstance.gemData.additionalGrantedEffects
 
-	self.tooltip:AddLine(20, colorCodes.GEM .. grantedEffect.name)
+	if grantedEffect.name:match("^Spectre:") or grantedEffect.name:match("^Companion:") then
+		self.tooltip:AddLine(20, colorCodes.GEM .. (gemInstance.displayEffect and gemInstance.displayEffect.nameSpec or gemInstance.gemData.name))	
+	else
+		self.tooltip:AddLine(20, colorCodes.GEM .. grantedEffect.name)
+	end
 	self.tooltip:AddSeparator(10)
 	self.tooltip:AddLine(18, colorCodes.NORMAL .. gemInstance.gemData.gemType)
 	if gemInstance.gemData.tagString ~= "" then
@@ -592,9 +596,19 @@ function GemSelectClass:AddGrantedEffectInfo(gemInstance, grantedEffect, addReq)
 			self.tooltip:AddLine(16, string)
 		end
 	else
+		if gemInstance.skillMinion then
+			if gemInstance.nameSpec:match("^Spectre:") then
+				grantedEffectLevel.spiritReservationFlat = data.spectres[gemInstance.skillMinion].spectreReservation
+			elseif gemInstance.nameSpec:match("^Companion:") then
+				grantedEffectLevel.spiritReservationPercent = data.spectres[gemInstance.skillMinion].companionReservation
+			end
+		end
 		if grantedEffectLevel.spiritReservationFlat then
 			self.tooltip:AddLine(16, string.format("^x7F7F7FReservation: ^7%d Spirit", grantedEffectLevel.spiritReservationFlat))
 		end
+		if grantedEffectLevel.spiritReservationPercent then
+			self.tooltip:AddLine(16, string.format("^x7F7F7FReservation: ^7%.1f%% Spirit", grantedEffectLevel.spiritReservationPercent))
+		end
 		local cost
 		for _, res in ipairs(self.costs) do
 			if grantedEffectLevel.cost and grantedEffectLevel.cost[res.Resource] then

src/Classes/ImportTab.lua

@@ -691,12 +691,47 @@ function ImportTabClass:ImportItemsAndSkills(charData)
 	local funcGetGemInstance = function(skillData)
 		local typeLine = sanitiseText(skillData.typeLine) .. (skillData.support and " Support" or "")
 		local gemId = self.build.data.gemForBaseName[typeLine:lower()]
+		
+		if typeLine:match("^Spectre:") then
+			gemId = "Metadata/Items/Gems/SkillGemSummonSpectre"
+		end		
+		if typeLine:match("^Companion:") then
+			gemId = "Metadata/Items/Gems/SkillGemSummonBeast"
+		end
 
 		if gemId then
 			local gemInstance = { level = 20, quality = 0, enabled = true, enableGlobal1 = true, enableGlobal2 = true, count = 1,  gemId = gemId }
-			gemInstance.nameSpec = self.build.data.gems[gemId].name
 			gemInstance.support = skillData.support
 
+			local spectreList = data.spectres
+			if typeLine:sub(1, 8) == "Spectre:" then
+				local spectreName = typeLine:sub(10) -- gets monster name after "Spectre: "
+				for id, spectre in pairs(spectreList) do
+					if spectre.name == spectreName then
+						if not isValueInArray(self.build.spectreList, id) then
+							t_insert(self.build.spectreList, id)
+						end
+						gemInstance.skillMinion = id -- Sets imported minion in dropdown on left
+						gemInstance.skillMinionCalcs = id-- Sets imported minion in dropdown in calcs tab
+						break
+					end
+				end
+			end
+			if typeLine:sub(1, 10) == "Companion:" then
+				local companionName = typeLine:sub(12)
+				for id, spectre in pairs(spectreList) do
+					if spectre.name == companionName then
+						if not isValueInArray(self.build.beastList, id) then
+							t_insert(self.build.beastList, id)
+						end
+						gemInstance.skillMinion = id
+						gemInstance.skillMinionCalcs = id
+						break
+					end
+				end
+			end
+
+			gemInstance.nameSpec = self.build.data.gems[gemId].name
 			for _, property in pairs(skillData.properties) do
 				if property.name == "Level" then
 					gemInstance.level = tonumber(property.values[1][1]:match("%d+"))

src/Classes/MinionListControl.lua

@@ -7,22 +7,23 @@ local ipairs = ipairs
 local t_insert = table.insert
 local t_remove = table.remove
 local s_format = string.format
+local m_max = math.max
 
-local MinionListClass = newClass("MinionListControl", "ListControl", function(self, anchor, rect, data, list, dest)
+local MinionListClass = newClass("MinionListControl", "ListControl", function(self, anchor, rect, data, list, dest, label)
 	self.ListControl(anchor, rect, 16, "VERTICAL", not dest, list)
 	self.data = data
 	self.dest = dest
 	if dest then
 		self.dragTargetList = { dest }
-		self.label = "^7Available Spectres:"
+		self.label = label or "^7Available Spectres:"
 		self.controls.add = new("ButtonControl", {"BOTTOMRIGHT",self,"TOPRIGHT"}, {0, -2, 60, 18}, "Add", function()
 			self:AddSel()
 		end)
 		self.controls.add.enabled = function()
 			return self.selValue ~= nil and not isValueInArray(dest.list, self.selValue)
 		end
 	else
-		self.label = "^7Spectres in Build:"
+		self.label = label or "^7Spectres in Build:"
 		self.controls.delete = new("ButtonControl", {"BOTTOMRIGHT",self,"TOPRIGHT"}, {0, -2, 60, 18}, "Remove", function()
 			self:OnSelDelete(self.selIndex, self.selValue)
 		end)
@@ -49,6 +50,10 @@ function MinionListClass:AddValueTooltip(tooltip, index, minionId)
 	if tooltip:CheckForUpdate(minionId) then
 		local minion = self.data.minions[minionId]
 		tooltip:AddLine(18, "^7"..minion.name)
+		tooltip:AddSeparator(10)
+		tooltip:AddLine(14, s_format("^7Spectre Reservation: %s%d", colorCodes.SPIRIT, tostring(minion.spectreReservation)))
+		tooltip:AddLine(14, s_format("^7Companion Reservation: %s%s%%", colorCodes.SPIRIT, tostring(minion.companionReservation)))
+		tooltip:AddLine(14, "^7Category: "..minion.monsterCategory)
 		tooltip:AddLine(14, s_format("^7Life Multiplier: x%.2f", minion.life))
 		if minion.energyShield then
 			tooltip:AddLine(14, s_format("^7Energy Shield: %d%% of base Life", minion.energyShield * 100))
@@ -59,20 +64,35 @@ function MinionListClass:AddValueTooltip(tooltip, index, minionId)
 		if minion.evasion then
 			tooltip:AddLine(14, s_format("^7Evasion Multiplier: x%.2f", 1 + minion.evasion))
 		end
-		tooltip:AddLine(14, s_format("^7Resistances: %s%d^7/%s%d^7/%s%d^7/%s%d", 
+		tooltip:AddLine(14, s_format("^7Resistances: %s%d ^7/ %s%d ^7/ %s%d ^7/ %s%d",
 			colorCodes.FIRE, minion.fireResist, 
 			colorCodes.COLD, minion.coldResist, 
 			colorCodes.LIGHTNING, minion.lightningResist, 
 			colorCodes.CHAOS, minion.chaosResist
 		))
 		tooltip:AddLine(14, s_format("^7Base Damage: x%.2f", minion.damage))
 		tooltip:AddLine(14, s_format("^7Base Attack Speed: %.2f", 1 / minion.attackTime))
-
+		tooltip:AddLine(14, s_format("^7Base Movement Speed: %.2f", minion.baseMovementSpeed / 10))
 		for _, skillId in ipairs(minion.skillList) do
 			if self.data.skills[skillId] then
 				tooltip:AddLine(14, "^7Skill: "..self.data.skills[skillId].name)
 			end
 		end
+		tooltip:AddSeparator(10)
+		if #minion.spawnLocation > 0 then
+			local coloredLocations = {}
+			for _, location in ipairs(minion.spawnLocation) do -- Print (Map) or (Act 7) in white, and map name in green. 
+				local mainText, bracket = location:match("^(.-)%s*(%b())%s*$")
+				table.insert(coloredLocations, bracket and (colorCodes.RELIC .. mainText .. " " .. "^7" .. bracket) or (colorCodes.RELIC .. location))
+			end
+			for i, spawn in ipairs(coloredLocations) do
+				if i == 1 then
+					tooltip:AddLine(14, s_format("^7Spawn: %s", spawn))
+				else
+					tooltip:AddLine(14, s_format("^7%s%s", "            ", spawn)) -- Indented so all locations line up vertically in tooltip
+				end
+			end
+		end
 	end
 end
 
@@ -101,3 +121,66 @@ function MinionListClass:OnSelDelete(index, minionId)
 		self.selValue = nil
 	end
 end
+
+local SpawnListClass = newClass("SpawnListControl", "ListControl", function(self, anchor, rect, data, list, label)
+	self.ListControl(anchor, rect, 16, "VERTICAL", false)
+	self.data = data
+	self.label = label or "^7Available Items:"
+end)
+
+function SpawnListClass:GetRowValue(column, index, spawnLocation)
+		return spawnLocation
+end
+function SpawnListClass:AddValueTooltip(tooltip, index, value)
+	if tooltip:CheckForUpdate(value) then
+		local foundArea = nil
+		for _, area in pairs(data.worldAreas) do
+			if area.name == value and #area .monsterVarieties > 0 then
+				foundArea = area
+				break
+			end
+		end
+		if foundArea then
+			tooltip:AddLine(18, foundArea.name)
+			if foundArea.description and foundArea.description ~= "" then
+				tooltip:AddLine(14, colorCodes.CURRENCY .. '"' .. foundArea.description .. '"')
+			end
+			if foundArea.bossVarieties and #foundArea.bossVarieties > 0 then
+				tooltip:AddLine(14, colorCodes.UNIQUE.. "Bosses: ^7" .. table.concat(foundArea.bossVarieties, ", "))
+			end
+			tooltip:AddLine(14, "^7Area Level: "..foundArea.level)
+			local biomeNameMap = {
+				water_biome = "Water",
+				mountain_biome = "Mountain",
+				grass_biome = "Grass",
+				forest_biome = "Forest",
+				swamp_biome = "Swamp",
+				desert_biome = "Desert",
+				faridun_city = "Faridun City",
+				ezomyte_city = "Ezomyte City",
+				vaal_city = "Vaal City",
+			}
+			if #foundArea.tags > 0 then
+				local biomeNameList = {}
+				for _, tag in ipairs(foundArea.tags) do
+					local biomeName = biomeNameMap[tag]
+					if biomeName then
+						table.insert(biomeNameList, biomeName)
+					end
+				end
+				if #biomeNameList > 0 then
+					tooltip:AddLine(14, "^7Biome: " .. table.concat(biomeNameList, ", "))
+				end
+			end
+			tooltip:AddSeparator(10)
+			tooltip:AddLine(14, "^7Spectres:")
+			for _, monsterName in ipairs(foundArea.monsterVarieties) do
+				tooltip:AddLine(14, " - " .. monsterName)
+			end
+		elseif value == "Found in Maps" then
+			-- no tooltip
+		else
+			tooltip:AddLine(18, "^7World area not found: " .. tostring(value))
+		end
+	end
+end

src/Classes/MinionSearchListControl.lua

@@ -8,24 +8,44 @@ local t_insert = table.insert
 local t_remove = table.remove
 local s_format = string.format
 
-local MinionSearchListClass = newClass("MinionSearchListControl", "MinionListControl", function(self, anchor, rect, data, list, dest)
-	self.MinionListControl(anchor, rect, data, list, dest)	
+local MinionSearchListClass = newClass("MinionSearchListControl", "MinionListControl", function(self, anchor, rect, data, list, dest, label)
+	self.MinionListControl(anchor, rect, data, list, dest, label)
+	self:sortSourceList()
 	self.unfilteredList = copyTable(list)
 	self.isMutable = false
 
-	self.controls.searchText = new("EditControl", {"BOTTOMLEFT",self,"TOPLEFT"}, {0, -2, 128, 18}, "", "Search", "%c", 100, function(buf)
+	self.controls.searchText = new("EditControl", {"BOTTOMLEFT",self,"TOPLEFT"}, {0, -2, 148, 18}, "", "Search", "%c", 100, function(buf)
 		self:ListFilterChanged(buf, self.controls.searchModeDropDown.selIndex)
+		self:sortSourceList()
 	end, nil, nil, true)	
 
 	self.controls.searchModeDropDown = new("DropDownControl", {"LEFT",self.controls.searchText,"RIGHT"}, {2, 0, 60, 18}, { "Names", "Skills", "Both"}, function(index, value)
 		self:ListFilterChanged(self.controls.searchText.buf, index)
+		self:sortSourceList()
+	end)
+	self.controls.sortModeDropDown = new("DropDownControl", {"BOTTOMRIGHT", self.controls.searchModeDropDown, "TOPRIGHT"}, {0, -2, self.width, 18}, {
+		"Sort by Names",
+		"Sort by Life + ES",
+		"Sort by Life",
+		"Sort by Energy Shield",
+		"Sort by Attack Speed",
+		"Sort by Companion Reservation",
+		"Sort by Spectre Reservation",
+		"Sort by Fire Resistance",
+		"Sort by Cold Resistance",
+		"Sort by Lightning Resistance",
+		"Sort by Chaos Resistance",
+		"Sort by Total Resistance",
+		"Sort by Movement Speed",
+	}, function(index, value)
+			self:sortSourceList()
 	end)
 
-	self.labelPositionOffset = {0, -20}
+	self.labelPositionOffset = {0, -40}
 	if dest then
-		self.controls.add.y = self.controls.add.y - 20
+		self.controls.add.y = self.controls.add.y - 40
 	else
-		self.controls.delete.y = self.controls.add.y - 20
+		self.controls.delete.y = self.controls.add.y - 40
 	end
 
 end)
@@ -65,3 +85,53 @@ function MinionSearchListClass:ListFilterChanged(buf, filterMode)
 		self.list = self.unfilteredList
 	end
 end
+
+function MinionSearchListClass:sortSourceList()
+	local sortFields = {
+		[1] = { field = "name", asc = true },
+		[2] = { field = "totalHitPoints", asc = false },
+		[3] = { field = "life", asc = false },
+		[4] = { field = "energyShield", asc = false },
+		[5] = { field = "attackTime", asc = true },
+		[6] = { field = "companionReservation", asc = true },
+		[7] = { field = "spectreReservation", asc = true },
+		[8] = { field = "fireResist", asc = false },
+		[9] = { field = "coldResist", asc = false },
+		[10] = { field = "lightningResist", asc = false },
+		[11] = { field = "chaosResist", asc = false },
+		[12] = { field = "totalResist", asc = false },
+		[13] = { field = "baseMovementSpeed", asc = false },
+	}
+	local sortModeIndex = self.controls.sortModeDropDown and self.controls.sortModeDropDown.selIndex or 1
+	local sortOption = sortFields[sortModeIndex]
+	if sortOption then
+		table.sort(self.list, function(a, b)
+			local minionA = self.data.minions[a]
+			local minionB = self.data.minions[b]
+			local valueA = minionA[sortOption.field]
+			local valueB = minionB[sortOption.field]
+			if sortOption.field == "life" then
+				valueA = minionA.life * (1 - (minionA.energyShield or 0))
+				valueB = minionB.life * (1 - (minionB.energyShield or 0))
+			elseif sortOption.field == "totalHitPoints" then
+				valueA = minionA.life
+				valueB = minionB.life
+			elseif sortOption.field == "energyShield" then
+				valueA = (minionA.energyShield or 0) * minionA.life
+				valueB = (minionB.energyShield or 0) * minionB.life
+			elseif sortOption.field == "totalResist" then
+				valueA = (minionA.fireResist or 0) + (minionA.coldResist or 0) + (minionA.lightningResist or 0) + (minionA.chaosResist or 0)
+				valueB = (minionB.fireResist or 0) + (minionB.coldResist or 0) + (minionB.lightningResist or 0) + (minionB.chaosResist or 0)
+			end
+			if valueA == valueB then
+				return minionA.name < minionB.name
+			else
+				if sortOption.asc then
+					return valueA < valueB
+				else
+					return valueA > valueB
+				end
+			end
+		end)
+	end
+end

src/Classes/ModStore.lua

@@ -698,13 +698,14 @@ function ModStoreClass:EvalMod(mod, cfg)
 				matchName = matchName:lower()
 				if tag.skillNameList then
 					for _, name in pairs(tag.skillNameList) do
-						if name:lower() == matchName then
+						local nameLower = name:lower()
+						if (tag.partialMatch and matchName:find(nameLower, 1, true)) or (not tag.partialMatch and nameLower == matchName) then
 							match = true
 							break
 						end
 					end
 				else
-					match = (tag.skillName and tag.skillName:lower() == matchName)
+					match = (tag.partialMatch and matchName:find(tag.skillName:lower(), 1, true) ~= nil) or (tag.skillName:lower() == matchName)
 				end
 			end
 			if tag.neg then