Add tree for Legacy of Phrecia (#8494)

* Add Legacy of Phrecia trees

* Support import/export of tree links

* Remove debugging lines

* Remove temporary jewels

* Restore English Harbinger node names

* Fixup PoEPlanner import

* Have tree conversion respect new alternate version

* Change ascendancy names in the dropdown when the tree version changes

* Identify imported tree version based on ascendancy name

* Update class name colors in the import tab

Author: Wires77

RELEASE.md

@@ -50,7 +50,7 @@ Steps:
     * `skills-3.jpg`
     * `skills-disabled-3.jpg`.
 5. Run `./fix_ascendancy_positions.py`.
-6. Open `./src/GameVersions.lua` and update `treeVersionList` and `treeVersions`
+6. Open `./src/GameVersions.lua` and update `treeVersionList`, `treeVersions`, and `poePlannerVersions`.  The latter can be found via https://cdn.poeplanner.com/json/versions.json
    according to the file's format. This is important, otherwise the JSON data converter
    won't trigger.
 7. Restart Path of Building Community. This should result in a new file `tree.lua`.

src/Classes/ImportTab.lua

@@ -523,19 +523,25 @@ function ImportTabClass:BuildCharacterList(league)
 				classColor = colorCodes[charClass:upper()]
 
 				if classColor == nil then
-					if (charClass == "Elementalist" or charClass == "Necromancer" or charClass == "Occultist") then
+					if (charClass == "Elementalist" or charClass == "Necromancer" or charClass == "Occultist" or
+						charClass == "Harbinger" or charClass == "Herald" or charClass == "Bog Shaman") then
 						classColor = colorCodes["WITCH"]
-					elseif (charClass == "Guardian" or charClass == "Inquisitor" or charClass == "Hierophant") then
+					elseif (charClass == "Guardian" or charClass == "Inquisitor" or charClass == "Hierophant" or
+						charClass == "Architect of Chaos" or charClass == "Polytheist" or charClass == "Puppeteer") then
 						classColor = colorCodes["TEMPLAR"]
-					elseif (charClass == "Assassin" or charClass == "Trickster" or charClass == "Saboteur") then
+					elseif (charClass == "Assassin" or charClass == "Trickster" or charClass == "Saboteur" or
+						charClass == "Surfcaster" or charClass == "Servant of Arakaali" or charClass == "Blind Prophet") then
 						classColor = colorCodes["SHADOW"]
-					elseif (charClass == "Gladiator" or charClass == "Slayer" or charClass == "Champion") then
+					elseif (charClass == "Gladiator" or charClass == "Slayer" or charClass == "Champion" or
+						charClass == "Gambler" or charClass == "Paladin" or charClass == "Aristocrat") then
 						classColor = colorCodes["DUELIST"]
-					elseif (charClass == "Raider" or charClass == "Pathfinder" or charClass == "Deadeye" or charClass == "Warden") then
+					elseif (charClass == "Raider" or charClass == "Pathfinder" or charClass == "Deadeye" or charClass == "Warden" or
+						charClass == "Daughter of Oshabi" or charClass == "Whisperer" or charClass == "Wildspeaker") then
 						classColor = colorCodes["RANGER"]
-					elseif (charClass == "Juggernaut" or charClass == "Berserker" or charClass == "Chieftain") then
+					elseif (charClass == "Juggernaut" or charClass == "Berserker" or charClass == "Chieftain" or
+						charClass == "Antiquarian" or charClass == "Behemoth" or charClass == "Ancestral Commander") then
 						classColor = colorCodes["MARAUDER"]
-					elseif (charClass == "Ascendant") then
+					elseif (charClass == "Ascendant" or charClass == "Scavenger") then
 						classColor = colorCodes["SCION"]
 					end
 				end
@@ -676,7 +682,31 @@ function ImportTabClass:ImportPassiveTreeAndJewels(json, charData)
 	self.build.itemsTab:PopulateSlots()
 	self.build.itemsTab:AddUndoState()
 
-	self.build.spec:ImportFromNodeList(charPassiveData.character, charPassiveData.ascendancy, charPassiveData.alternate_ascendancy or 0, charPassiveData.hashes, charPassiveData.skill_overrides, charPassiveData.mastery_effects or {}, latestTreeVersion .. (charData.league:match("Ruthless") and "_ruthless" or ""))
+	-- Alternate trees don't have an identifier, so we're forced to look up something that is unique to that tree
+	-- Hopefully this changes, because it's totally unmaintainable
+	local function isAscendancyInTree(className, treeVersion)
+		local classes = main.tree[treeVersion].classes
+		for _, class in pairs(classes) do
+			if class.name == className then
+				return true
+			end
+			for i = 0, #class.classes do
+				local ascendClass = class.classes[i]
+				if ascendClass.name == className then
+					return true
+				end
+			end
+		end
+	end
+
+	self.build.spec:ImportFromNodeList(charPassiveData.character, 
+		charPassiveData.ascendancy, 
+		charPassiveData.alternate_ascendancy or 0, 
+		charPassiveData.hashes, 
+		charPassiveData.skill_overrides, 
+		charPassiveData.mastery_effects or {}, 
+		latestTreeVersion .. (charData.league:match("Ruthless") and "_ruthless" or "") .. (isAscendancyInTree(charData.class, latestTreeVersion) and "" or "_alternate")
+	)
 	self.build.spec:AddUndoState()
 	self.build.characterLevel = charData.level
 	self.build.characterLevelAutoMode = false

src/Classes/PassiveSpec.lua

@@ -356,56 +356,70 @@ function PassiveSpecClass:DecodePoePlannerURL(url, return_tree_version_only)
 		return bytes:byte(start) + bytes:byte(start + 1) * 256
 	end
 
-	local function translatePoepToGggTreeVersion(minor)
-		-- Translates internal tree version to GGG version.
-		-- Limit poeplanner tree imports to recent versions.
-		tree_versions = { -- poeplanner ID: GGG version
-			[31] = 24, [29] = 23, [27] = 22, [26] = 21, [25] = 20, [24] = 19, [23] = 18,
-			}
-		if tree_versions[minor] then
-			return tree_versions[minor]
-		else
-			return -1
-		end
-	end
-
 	local b = common.base64.decode(url:gsub("^.+/",""):gsub("-","+"):gsub("_","/"))
 	if not b or #b < 15 then
 		return "Invalid tree link (unrecognised format)."
 	end
 	-- Quick debug for when we change tree versions. Print the first 20 or so bytes
 	-- s = ""
 	-- for i = 1, 20 do
-		-- s = s..i..":"..string.format('%02X ', b:byte(i))
+	-- 	s = s..i..":"..string.format('%02X ', b:byte(i))
 	-- end
 	-- print(s)
 
-	-- 4-7 is tree version.version
-	major_version = byteToInt(b,4)
-	minor_version = translatePoepToGggTreeVersion(byteToInt(b,6))
+	--[[
+	PoEPlanner URL format:
+		serializationVersion: u16
+		buildType: u8 (either normal or royale)
+		isPoE2: u8
+		treeBuild: TreeBuild
+		equipmentBuild: EquipmentBuild
+		skillBuild: SkillBuild
+		buildConfig: BuildConfig
+		compressedNotesLength: u16
+		compressedNotesBytes: []u8 (gzip)
+
+		TreeBuild: 
+		treeSerializationVersion: u16
+		treeVersion: u16
+		character: u8
+		ascendancy: u8
+		banditChoice: u8
+		nodeCount: u16
+		nodeHashes: []u16
+		clusterNodeCount: u16
+		clusterNodeHashes: []u16
+		ascendancyNodeCount: u16
+		ascendancyNodeHashes: []u16
+		selectedMasteryEffectCount: u16
+		selectedMasteryEffects: {masteryID: u16, effectID: u16}
+		selectedAttributeChoiceCount: u16
+		selectedAttributeChoices: {nodeHash: u16, choice: u8} (for choice: 0: none, 1: str, 2: dex, 3: int)
+	]]
+
 	-- If we only want the tree version, exit now
-	if minor_version < 0 then
+	if not poePlannerVersions[byteToInt(b, 7)] then
 		return "Invalid tree version found in link."
 	end
 	if return_tree_version_only then
-		return major_version.."_"..minor_version
+		return poePlannerVersions[byteToInt(b, 7)]
 	end
 
-	-- 8 is Class, 9 is Ascendancy
-	local classId = b:byte(8)
-	local ascendClassId = b:byte(9)
+	-- 9 is Class, 10 is Ascendancy
+	local classId = b:byte(9)
+	local ascendClassId = b:byte(10)
 	-- print("classId, ascendClassId", classId, ascendClassId)
 
-	-- 9 is Bandit
+	-- 11 is Bandit
 	-- bandit = b[9]
 	-- print("bandit", bandit, bandit_list[bandit])
 
 	self:ResetNodes()
 	self:SelectClass(classId)
 	self:SelectAscendClass(ascendClassId)
 
-	-- 11 is node count
-	idx = 11
+	-- 12-13 is node count
+	idx = 12
 	local nodesCount = byteToInt(b, idx)
 	local nodesEnd = idx + 2 + (nodesCount * 2)
 	local nodes = b:sub(idx  + 2, nodesEnd - 1)

src/Classes/TreeTab.lua

@@ -447,6 +447,7 @@ function TreeTabClass:SetActiveSpec(specId)
 	self.build.spec = curSpec
 	self.build.buildFlag = true
 	self.build.spec:SetWindowTitleWithBuildClass()
+	self.build:UpdateClassDropdowns(curSpec.treeVersion)
 	for _, slot in pairs(self.build.itemsTab.slots) do
 		if slot.nodeId then
 			if prevSpec then
@@ -483,10 +484,11 @@ function TreeTabClass:SetCompareSpec(specId)
 	self.compareSpec = curSpec
 end
 
-function TreeTabClass:ConvertToVersion(version, remove, success, ignoreRuthlessCheck)
-	if not ignoreRuthlessCheck and self.build.spec.treeVersion:match("ruthless") and not version:match("ruthless") then
-		if isValueInTable(treeVersionList, version.."_ruthless") then
-			version = version.."_ruthless"
+function TreeTabClass:ConvertToVersion(version, remove, success, ignoreTreeSubType)
+	local treeSubTypeCapture = self.build.spec.treeVersion:match("(_%l+_?%l*)")
+	if not ignoreTreeSubType and treeSubTypeCapture and not version:match(treeSubTypeCapture) then
+		if isValueInTable(treeVersionList, version..treeSubTypeCapture) then
+			version = version..treeSubTypeCapture
 		end
 	end
 	local newSpec = new("PassiveSpec", self.build, version)
@@ -543,16 +545,16 @@ function TreeTabClass:OpenSpecManagePopup()
 	})
 end
 
-function TreeTabClass:OpenVersionConvertPopup(version, ignoreRuthlessCheck)
+function TreeTabClass:OpenVersionConvertPopup(version, ignoreTreeSubType)
 	local controls = { }
 	controls.warningLabel = new("LabelControl", nil, {0, 20, 0, 16}, "^7Warning: some or all of the passives may be de-allocated due to changes in the tree.\n\n" ..
 		"Convert will replace your current tree.\nCopy + Convert will backup your current tree.\n")
 	controls.convert = new("ButtonControl", nil, {-125, 105, 100, 20}, "Convert", function()
-		self:ConvertToVersion(version, true, false, ignoreRuthlessCheck)
+		self:ConvertToVersion(version, true, false, ignoreTreeSubType)
 		main:ClosePopup()
 	end)
 	controls.convertCopy = new("ButtonControl", nil, {0, 105, 125, 20}, "Copy + Convert", function()
-		self:ConvertToVersion(version, false, false, ignoreRuthlessCheck)
+		self:ConvertToVersion(version, false, false, ignoreTreeSubType)
 		main:ClosePopup()
 	end)
 	controls.cancel = new("ButtonControl", nil, {125, 105, 100, 20}, "Cancel", function()
@@ -620,20 +622,20 @@ function TreeTabClass:OpenImportPopup()
 			main:ClosePopup()
 		end
 	end
-	local function validateTreeVersion(isRuthless, major, minor)
+	local function validateTreeVersion(alternateType, major, minor)
 		-- Take the Major and Minor version numbers and confirm it is a valid tree version. The point release is also passed in but it is not used
 		-- Return: the passed in tree version as text or latestTreeVersion
 		if major and minor then
 			--need leading 0 here
 			local newTreeVersionNum = tonumber(string.format("%d.%02d", major, minor))
 			if newTreeVersionNum >= treeVersions[defaultTreeVersion].num and newTreeVersionNum <= treeVersions[latestTreeVersion].num then
 				-- no leading 0 here
-				return string.format("%s_%s", major, minor) .. (isRuthless and "_ruthless" or "")
+				return string.format("%s_%s", major, minor) .. (alternateType and ("_" .. alternateType:gsub("-", "_")) or "")
 			else
 				print(string.format("Version '%d_%02d' is out of bounds", major, minor))
 			end
 		end
-		return latestTreeVersion .. (isRuthless and "_ruthless" or "")
+		return latestTreeVersion .. (alternateType and ("_" .. alternateType:gsub("-", "_")) or "")
 	end
 
 	controls.nameLabel = new("LabelControl", nil, {-180, 20, 0, 16}, "Enter name for this passive tree:")
@@ -679,21 +681,23 @@ function TreeTabClass:OpenImportPopup()
 						controls.import.enabled = true
 						return
 					else
-						decodeTreeLink(treeLink, validateTreeVersion(treeLink:match("tree/ruthless"), treeLink:match(versionLookup)))
+						decodeTreeLink(treeLink, validateTreeVersion(treeLink:match("tree/(%w+%-?%w*)"), treeLink:match(versionLookup)))
 					end
 				end)
 			end
 		elseif treeLink:match("poeplanner.com/") then
 			decodePoePlannerTreeLink(treeLink:gsub("/%?v=.+#","/"))
 		elseif treeLink:match("poeskilltree.com/") then
-			local oldStyleVersionLookup = "/%?v=([0-9]+)%.([0-9]+)%.([0-9]+)%-?r?u?t?h?l?e?s?s?#"
+			local oldStyleVersionLookup = "/%?v=([0-9]+)%.([0-9]+)%.([0-9]+)%-?%w?%-?%w?#"
 			-- Strip the version from the tree : https://poeskilltree.com/?v=3.6.0#AAAABAMAABEtfIOFMo6-ksHfsOvu -> https://poeskilltree.com/AAAABAMAABEtfIOFMo6-ksHfsOvu
-			decodeTreeLink(treeLink:gsub("/%?v=.+#","/"), validateTreeVersion(treeLink:match("-ruthless#"), treeLink:match(oldStyleVersionLookup)))
+			decodeTreeLink(treeLink:gsub("/%?v=.+#","/"), validateTreeVersion(treeLink:match("%-(%w+%-?%w*)#"), treeLink:match(oldStyleVersionLookup)))
 		else
 			-- EG: https://www.pathofexile.com/passive-skill-tree/3.15.0/AAAABgMADI6-HwKSwQQHLJwtH9-wTLNfKoP3ES3r5AAA
 			-- EG: https://www.pathofexile.com/fullscreen-passive-skill-tree/3.15.0/AAAABgMADAQHES0fAiycLR9Ms18qg_eOvpLB37Dr5AAA
 			-- EG: https://www.pathofexile.com/passive-skill-tree/ruthless/AAAABgAAAAAA (Ruthless doesn't have versions)
-			decodeTreeLink(treeLink, validateTreeVersion(treeLink:match("tree/ruthless"), treeLink:match(versionLookup)))
+			-- EG: https://www.pathofexile.com/passive-skill-tree/ruthless-alternate/AAAABgAAAAAA
+			-- EG: https://www.pathofexile.com/passive-skill-tree/alternate/AAAABgAAAAAA
+			decodeTreeLink(treeLink, validateTreeVersion(treeLink:match("tree/(%w+%-?%w*)"), treeLink:match(versionLookup)))
 		end
 	end)
 	controls.import.enabled = false