#843 Tooltip Text in multiple columns when longer than the screen height

.gitignore

@@ -4,7 +4,6 @@
 Settings.xml
 *.cfg
 *.json
-TreeData/
 Builds/
 /Export/Tree/PassiveSkillGraph.psg
 /Export/Tree/passives
@@ -202,6 +201,7 @@ ClientBin/
 *.publishsettings
 node_modules/
 orleans.codegen.cs
+manifest-updated.xml
 
 # RIA/Silverlight projects
 Generated_Code/
@@ -238,6 +238,9 @@ FakesAssemblies/
 # Visual Studio 6 workspace options file
 *.opt
 
+# Pycharm files
+.idea
+
 # Visual Studio LightSwitch build output
 **/*.HTMLClient/GeneratedArtifacts
 **/*.DesktopClient/GeneratedArtifacts

CONTRIBUTING.md

@@ -3,16 +3,16 @@
 ## Reporting bugs
 
 #### Before creating an issue:
-* Check that the bug hasn't been reported in an existing issue.
+* Check that the bug hasn't been reported in an existing issue. View similar issues on the left of the submit button.
 * Make sure you are running the latest version of the program; click "Check for Update" at the bottom left corner.
 * If you've found an issue with offence or defence calculations, make sure you check the breakdown for that calculation in the Calcs tab to see how it is being performed, as this may help you find the cause.
 
 #### When creating an issue:
 * Please provide detailed instructions on how to reproduce the bug, if possible.
-* If the issue affects a specific build, please provide the build share code: In the Import/Export Build tab, click "Generate", then "Share with Pastebin" and add the link to your post.
+* Provide the build share code to a build that is affected by the bug, if possible. In the "Import/Export Build" tab, click "Generate", then "Share with Pastebin" and add the link to your post.
 
 ## Requesting features
-Feature requests are always welcome. Note that not all requests will recieve an immediate response.
+Feature requests are always welcome. Note that not all requests will receive an immediate response.
 
 #### Before submitting a feature request:
 * Check that the feature hasn't already been requested; look at all issues with titles that might be related to the feature.
@@ -24,33 +24,92 @@ Feature requests are always welcome. Note that not all requests will recieve an
 
 ## Contributing code
 
+#### Before submitting a pull request:
+* There is a [Discord](https://discordapp.com/) server for **active development** on the fork and members are happy to answer your questions there.
+  If you are interested in joining, send a private message to any of `Cinnabarit#1341`, `LocalIdentity#9871`, `nick_#8198` and we'll send you an invite.
+
 #### When submitting a pull request:
 * **Pull requests must be made against the 'dev' branch**, as all changes to the code are staged there before merging to 'master'.
 * Make sure that the changes have been thoroughly tested!
+* Make sure not to commit `./Data/2_6/ModCache.lua` or `./Data/3_0/ModCache.lua`. These are very large, automatically generated files that are updated in the repository for releases only.
+* There are many more files in the `./Data` directory that are automatically generated. To change these, instead change the scripts in the `./Export` directory.
 
 #### Setting up a development install
 
 The easiest way to make and test changes is by setting up a development install, in which the program runs directly from a local copy of the repository:
-1. Clone or download the repository; make sure you grab the dev branch. If you have [Git](https://git-scm.com/) installed, you can use this command: `git clone -b dev https://github.com/Openarl/PathOfBuilding.git`.
-2. Copy the 'TreeData' folder from your main installation into the repository; if you used the .exe to install then it will be in "%ProgramData%\Path of Building".
-3. Create a shortcut to the 'Path of Building.exe' in your main installation of the program.
-4. Add the path and filename of the repository's 'Launch.lua' as an argument to the shortcut; you should end up with something like: `"C:\Program Files (x86)\Path of Building\Path of Building.exe" "C:\Path of Building\Launch.lua"`.
+1. Install [Git](https://git-scm.com/)
+2. Open Git Bash
+3. `cd` into the directory you want to clone the repository to, for example:
+
+       cd ~ && mkdir GitHub && cd GitHub
+4. Clone the repository using this command:
+
+       git clone -b dev https://github.com/LocalIdentity/PathOfBuilding.git
+5. Create a shortcut to the 'Path of Building.exe' in your main installation of the program.
+6. Add the path to `./Launch.lua` as an argument to the shortcut. You should end up with something like: `"C:\Program Files (x86)\Path of Building\Path of Building.exe" "C:\Path of Building\Launch.lua"`.
 
 You can now use the shortcut to run the program from the repository. Running the program in this manner automatically enables 'Dev Mode', which has some handy debugging feature:
 * `F5` restarts the program in-place (this is what usually happens when an update is applied).
-* `Ctrl` + `~` toggles the console; ConPrintf can be used to output to it.
+* `Ctrl` + `~` toggles the console (Note that this does not work with all keyboard layouts. US layout is a safe bet though).
+* `ConPrintf()` can be used to output to the console. Search for "===" in the project files if you want to get rid of the default debugging strings.
 * Holding `Alt` adds additional debugging information to tooltips:
   * Items and passives show all internal modifiers that they are granting.
   * Stats that aren't parsed correctly will show any unrecognised parts of the stat description.
   * Passives also show node ID and node power values.
-  * Conditional options in the Configuration tab show the list of dependant modifiers.
+  * Conditional options in the Configuration tab show the list of dependent modifiers.
 * While in the Tree tab, holding `Alt` also highlights nodes that have unrecognised modifiers.
-* Holding `Ctrl` while launching the program will rebuild the `ModCache`
+* Holding `Ctrl` while launching the program will rebuild the mod cache.
 
 Note that the updates system is disabled in Dev Mode, so you must update manually.
 
-The repository also contains the system used to export data from the game's Content.ggpk file. This can be found in the Export folder.
-The data is exported using the scripts in Export/Scripts, which are run from within the .dat viewer.
-The viewer can be run using the same method as the main program: passing the path to Export/Launch.lua to Path of Building.exe.
-Once open, enter the path to your PoE installation's Content.ggpk file in the text box at the top left; if successful, you will see a list of the data tables in the .ggpk file.
-Double-clicking a script in the scripts list will run it, and the box to the right will show any messages from the script.
+#### Keeping your fork up to date
+
+Note: If you've configured a remote already, you can skip ahead to step 6.
+1. Open Git Bash.
+2. `cd` into the repository directory.
+3. Check your current remote repositories.
+
+       git remote -v
+4. Add a new remote repository and name it `upstream`.
+
+       git remote add upstream https://github.com/LocalIdentity/PathOfBuilding
+5. Verify that adding the remote worked by running the last command again.
+
+       git remote -v
+6. Fetch all branches and their commits from upstream.
+
+       git fetch upstream
+7. Check out your local `dev` branch if you haven't already.
+
+       git checkout dev
+8. Merge all changes from `upstream/dev` into your local `dev` branch.
+
+       git rebase upstream/dev
+9. Push your updated branch to GitHub.
+
+       git push -f origin dev
+
+#### Setting up a development environment
+
+If you want to use a text editor, [Visual Studio Code](https://code.visualstudio.com/) is recommended.
+If you want to use an IDE instead, [PyCharm Community](https://www.jetbrains.com/pycharm/) or [IntelliJ Idea Community](https://www.jetbrains.com/idea/) are recommended.
+They are all free and open source and support [EmmyLua](https://github.com/EmmyLua), a Lua plugin that comes with a language server, debugger and many pleasant features. It is recommended to use it over the built-in Lua plugins.
+
+To setup a debugger for PoB on an IDE with EmmyLua:
+* Create a new 'Debug Configuration' of type 'Emmy Debugger(NEW)'.
+* Select 'x86' version.
+* Select if you want the program to block (checkbox) until you attached the debugger (useful if you have to debug the startup process).
+* Copy the generated code snippet directly below `function launch:OnInit()` in `./Launch.lua`.
+* Start PoB and attach debugger.
+
+#### Exporting Data from a GGPK file
+
+The repository also contains the system used to export data from the game's Content.ggpk file. This can be found in the Export folder. The data is exported using the scripts in `./Export/Scripts`, which are run from within the `.dat` viewer.
+
+How to export data from a GGPK file:
+
+1. Create a shortcut to `Path of Building.exe` with the path to `./Export/Launch.lua` as first argument. You should end up with something like: `"C:\Program Files (x86)\Path of Building\Path of Building.exe" "C:\Path of Building\Export\Launch.lua"`.
+2. Run the shortcut, and the GGPK data viewer UI will appear. If you get an error, be sure you're using the latest release of Path of Building.
+3. Paste the path to `Content.ggpk` into the text box in the top left, and hit `Enter` to read the GGPK. If successful, you will see a list of the data tables in the GGPK file. Note: This will not work on the GGPK from the torrent file released before league launches, as it contains no `./Data` section.
+4. Click `Scripts >>` to show the list of available export scripts. Double-clicking a script will run it, and the box to the right will show any output from the script.
+5. If you run into any errors, update the code in `./Export` as necessary and try again.

Classes/CalcBreakdownControl.lua

@@ -181,17 +181,39 @@ function CalcBreakdownClass:AddBreakdownSection(sectionData)
 
 	if breakdown.slots and #breakdown.slots > 0 then
 		-- Slots table, used for armour/evasion/ES total breakdowns
-		local section = { 
-			type = "TABLE",
-			rowList = breakdown.slots,
-			colList = { 
+		local colList
+		local rowList
+		if (sectionData.gearOnly) then
+			-- Only show basic table for gear and base ES/Armour/Evasion value
+			colList = {
+				{ label = "Value", key = "base", right = true },
+				{ label = "Source", key = "source" },
+				{ label = "Name", key = "sourceLabel" },
+			}
+
+			rowList = {}
+			for _, row in pairs(breakdown.slots) do
+				if (row.item and row.item.armourData) then
+					table.insert(rowList, row)
+				end
+			end
+		else
+			colList = {
 				{ label = "Base", key = "base", right = true },
 				{ label = "Inc/red", key = "inc" },
 				{ label = "More/less", key = "more" },
 				{ label = "Total", key = "total", right = true },
 				{ label = "Source", key = "source" },
 				{ label = "Name", key = "sourceLabel" },
-			},
+			}
+
+			rowList = breakdown.slots
+		end
+
+		local section = { 
+			type = "TABLE",
+			rowList = rowList,
+			colList = colList,
 		}
 		t_insert(self.sectionList, section)
 		for _, row in pairs(section.rowList) do
@@ -271,7 +293,7 @@ function CalcBreakdownClass:AddModSection(sectionData, modList)
 		local types = { }
 		local typeList = { }
 		for i, row in ipairs(rowList) do
-			-- Find all the modifier types and source types that are present in the modifier lsit
+			-- Find all the modifier types and source types that are present in the modifier list
 			if not types[row.mod.type] then
 				types[row.mod.type] = true
 				t_insert(typeList, row.mod.type)
@@ -356,6 +378,8 @@ function CalcBreakdownClass:AddModSection(sectionData, modList)
 		elseif sourceType == "Skill" then
 			-- Extract skill name
 			row.sourceName = build.data.skills[row.mod.source:match("Skill:(.+)")].name
+		elseif sourceType == "Pantheon" then
+			row.sourceName = row.mod.source:match("Pantheon:(.+)")
 		end
 		if row.mod.flags ~= 0 or row.mod.keywordFlags ~= 0 then
 			-- Combine, sort and format modifier flags
@@ -373,23 +397,23 @@ function CalcBreakdownClass:AddModSection(sectionData, modList)
 		row.tags = nil
 		if row.mod[1] then
 			-- Format modifier tags
-			local baseVal = type(row.mod.value) == "number" and (self:FormatModBase(row.mod, row.mod.value) .. "")
+			local baseVal = type(row.mod.value) == "number" and (self:FormatModBase(row.mod, row.mod.value) .. " ")
 			for _, tag in ipairs(row.mod) do
 				local desc
 				if tag.type == "Condition" or tag.type == "ActorCondition" then
 					desc = (tag.actor and (tag.actor:sub(1,1):upper()..tag.actor:sub(2).." ") or "").."Condition: "..(tag.neg and "Not " or "")..self:FormatVarNameOrList(tag.var, tag.varList)
 				elseif tag.type == "Multiplier" then
-					local base = tag.base and (self:FormatModBase(row.mod, tag.base).."+ "..math.abs(row.mod.value).." ") or baseVal
+					local base = tag.base and (self:FormatModBase(row.mod, tag.base).." + "..math.abs(row.mod.value).." ") or baseVal
 					desc = base.."per "..(tag.div and (tag.div.." ") or "")..self:FormatVarNameOrList(tag.var, tag.varList)
 					baseVal = ""
 				elseif tag.type == "PerStat" then
-					local base = tag.base and (self:FormatModBase(row.mod, tag.base).."+ "..math.abs(row.mod.value).." ") or baseVal
+					local base = tag.base and (self:FormatModBase(row.mod, tag.base).." + "..math.abs(row.mod.value).." ") or baseVal
 					desc = base.."per "..(tag.div or 1).." "..self:FormatVarNameOrList(tag.stat, tag.statList)
 					baseVal = ""
 				elseif tag.type == "MultiplierThreshold" or tag.type == "StatThreshold" then
 					desc = "If "..self:FormatVarNameOrList(tag.var or tag.stat, tag.varList or tag.statList)..(tag.upper and " <= " or " >= ")..(tag.threshold or self:FormatModName(tag.thresholdVar or tag.thresholdStat))
 				elseif tag.type == "SkillName" then
-					desc = "Skill: "..tag.skillName
+					desc = "Skill: "..(tag.skillNameList and table.concat(tag.skillNameList, "/") or tag.skillName)
 				elseif tag.type == "SkillId" then
 					desc = "Skill: "..build.data.skills[tag.skillId].name
 				elseif tag.type == "SkillType" then
@@ -406,6 +430,8 @@ function CalcBreakdownClass:AddModSection(sectionData, modList)
 					desc = "When in slot #"..tag.num
 				elseif tag.type == "GlobalEffect" then
 					desc = self:FormatModName(tag.effectType)
+				elseif tag.type == "Limit" then
+					desc = "Limited to "..(tag.limitVar and self:FormatModName(tag.limitVar) or self:FormatModBase(row.mod, tag.limit))
 				else
 					desc = self:FormatModName(tag.type)
 				end
@@ -426,7 +452,7 @@ function CalcBreakdownClass:FormatVarNameOrList(var, varList)
 end
 
 function CalcBreakdownClass:FormatModBase(mod, base)
-	return mod.type == "BASE" and string.format("%+g ", math.abs(base)) or math.abs(base).."% "
+	return mod.type == "BASE" and string.format("%+g", math.abs(base)) or math.abs(base).."%"
 end
 
 function CalcBreakdownClass:FormatModValue(value, modType)
@@ -448,6 +474,12 @@ function CalcBreakdownClass:FormatModValue(value, modType)
 		return "Override: "..value
 	elseif modType == "FLAG" then
 		return value and "True" or "False"
+	elseif modType == "LIST" then
+		if value.mod then
+			return "Modifier: "..self:FormatModName(value.mod.name)
+		else
+			return "?"
+		end
 	else
 		return value		
 	end
@@ -456,7 +488,7 @@ end
 function CalcBreakdownClass:DrawBreakdownTable(viewPort, x, y, section)
 	local cursorX, cursorY = GetCursorPos()
 	if section.label then
-		-- Draw table lable if able
+		-- Draw table label if able
 		DrawString(x + 2, y, "LEFT", 16, "VAR", "^7"..section.label..":")
 		y = y + 16
 	end

Classes/CalcSectionControl.lua

@@ -156,23 +156,36 @@ function CalcSectionClass:FormatStr(str, actor, colData)
 			return self:FormatVal(actor.output[c] or 0, tonumber(p))
 		end
 	end)
-	str = str:gsub("{(%d+):mod:(%d+)}", function(p, n) 
-		local sectionData = colData[tonumber(n)]
-		local modCfg = (sectionData.cfg and actor.mainSkill[sectionData.cfg.."Cfg"]) or { }
-		if sectionData.modSource then
-			modCfg.source = sectionData.modSource
+	str = str:gsub("{(%d+):mod:([%d,]+)}", function(p, n)
+		local numList = { }
+		for num in n:gmatch("%d+") do
+			t_insert(numList, tonumber(num))
 		end
-		local modVal
-		local modStore = sectionData.cfg and actor.mainSkill.skillModList or actor.modDB
-		if type(sectionData.modName) == "table" then
-			modVal = modStore:Combine(sectionData.modType, modCfg, unpack(sectionData.modName))
-		else
-			modVal = modStore:Combine(sectionData.modType, modCfg, sectionData.modName)
+		local modType = colData[numList[1]].modType
+		local modTotal = modType == "MORE" and 1 or 0
+		for _, num in ipairs(numList) do
+			local sectionData = colData[num]
+			local modCfg = (sectionData.cfg and actor.mainSkill[sectionData.cfg.."Cfg"]) or { }
+			if sectionData.modSource then
+				modCfg.source = sectionData.modSource
+			end
+			local modVal
+			local modStore = (sectionData.enemy and actor.enemy.modDB) or (sectionData.cfg and actor.mainSkill.skillModList) or actor.modDB
+			if type(sectionData.modName) == "table" then
+				modVal = modStore:Combine(sectionData.modType, modCfg, unpack(sectionData.modName))
+			else
+				modVal = modStore:Combine(sectionData.modType, modCfg, sectionData.modName)
+			end
+			if modType == "MORE" then
+				modTotal = modTotal * modVal
+			else
+				modTotal = modTotal + modVal
+			end
 		end
-		if sectionData.modType == "MORE" then
-			modVal = (modVal - 1) * 100
+		if modType == "MORE" then
+			modTotal = (modTotal - 1) * 100
 		end
-		return self:FormatVal(modVal, tonumber(p)) 
+		return self:FormatVal(modTotal, tonumber(p)) 
 	end)
 	return str
 end