Add a Help section (#4629)

* add toggle on about page for a help file

* add more sections

* add more shortcuts, and a method to filter lines to dev branch only

* add slider hotkeys

* Add basic indent support to help

(removed github link in help text since it wasn't clickable or selectable)

* Update help.txt

Co-authored-by: QuickStick <31533893+QuickStick123@users.noreply.github.com>

* Update help.txt

* Formatting

---------

Co-authored-by: Nightblade <Nightblade@users.noreply.github.com>
Co-authored-by: QuickStick <31533893+QuickStick123@users.noreply.github.com>
Co-authored-by: LocalIdentity <31035929+LocalIdentity@users.noreply.github.com>
Co-authored-by: LocalIdentity <localidentity2@gmail.com>

Author: 5 people

help.txt

@@ -0,0 +1,81 @@
+---[Help File][1]
+
+This file contains a list of shortcuts, and other misc things PoB has
+
+---[Contents][2]
+
+1. Intro
+2. Contents
+3. FAQ
+4. Hotkeys
+5. Other
+6. Timeless Jewels
+
+---[FAQ][3]
+
+---[Hotkeys][4]
+
+General Shortcuts:
+
+Ctrl + 1	Jump to tree tab
+Ctrl + 2	Jump to skills tab
+Ctrl + 3	Jump to items tab
+Ctrl + 4	Jump to calcs tab
+Ctrl + 5	Jump to config tab
+Ctrl + 6	Jump to notes tab
+Ctrl + I	Jump to import tab
+Ctrl + A	Select all
+Ctrl + C	Copy
+Ctrl + F	Show find / search box (e.g. unique item / tree)
+Ctrl + N	New build (in build selection menu)
+Ctrl + S	Save build to file
+Ctrl + U	Check for update
+Ctrl + V or RMB	Paste
+Ctrl + W or Mouse 4	Close Build (gives save prompt if unsaved)
+Ctrl + X	Cut
+Ctrl + Y	Redo
+Ctrl + Z	Undo
+Ctrl + BSP / DEL	Faster text delete
+Ctrl + + /-/0	Zoom in / Out / Reset
+F1	Open item/gem/etc in poewiki.net
+F2	Rename item, set, etc.
+E	On an equipped item will open it on the edit menu on the right.
+Ctrl + LMB	Enable / disable gems
+Ctrl + RMB	Enable / disable gems from Full DPS
+Mouse 4/5	Undo / Redo path respectively (in build selection menu)
+Shift	While scrolling on a slider makes it 5 times faster
+Ctrl	While scrolling on a slider makes it 5 times slower
+
+When creating an item either through item creator or adding an item pressing ctrl will add it to the first slot and ctrl+shift will add it to the second slot e.g. offhand for a weapon.
+
+Passive Tree Shortcuts:
+
+Ctrl	Hide tooltips while held
+P	Toggle node power
+Ctrl + D	Toggle stat diff display
+PgUp/PgDn/MWheel	Zoom in / out (hold with shift to increase amount of zoom x 3)
+Ctrl + LMB	Zoom in on mouse cursor position
+Hold Shift	Enable "path trace mode" (nodes highlighted will be added to a path which will be allocated when the final node is clicked on the tree)
+
+Developer Use
+
+General Shortcuts:
+
+Ctrl + `	Toggle console (console supports most standard editing shortcuts)
+Pause	Toggle profiling
+DEV[ ]
+DEV[Developer Mode Shortcuts:]
+DEV[ ]
+DEV[Ctrl	Rebuild mod cache (hold key during reload / refresh)]
+DEV[Ctrl + Shift	Allow tree download]
+DEV[Alt	Show advanced mod breakdown / passing]
+DEV[F5	Restart]
+DEV[F6	Run garbage collector]
+DEV[Shift	Copy export xml to clipboard (hold key during export)]
+
+---[Other Notable Things][5]
+
+Adding ^ and then a number or hex code before text will change the colour of the text, eg ^^77 will make all text white
+
+---[Timeless Jewels][6]
+

src/Modules/Main.lua

@@ -918,6 +918,28 @@ function main:OpenAboutPopup()
 			end
 		end
 	end
+	local helpList = { }
+	local helpName = launch.devMode and "../help.txt" or "help.txt"
+	local helpFile = io.open(helpName, "r")
+	if helpFile then
+		helpFile:close()
+		for line in io.lines(helpName) do
+			local title, titleIndex = line:match("^---%[(.+)%]%[(.+)%]$")
+			if title then
+				if #helpList > 0 then
+					t_insert(helpList, { height = 10 })
+				end
+				t_insert(helpList, { height = 18, "^7"..title.." ("..titleIndex..")" })
+			else
+				local dev = line:match("^DEV%[(.+)%]$")
+				if not ( dev and not launch.devMode ) then
+					line = (dev or line)
+					local outdent, indent = line:match("(.*)\t+(.*)")
+					t_insert(helpList, { height = 12, "^7"..(outdent or line), "^7"..(indent or "") })
+				end
+			end
+		end
+	end
 	local controls = { }
 	controls.close = new("ButtonControl", {"TOPRIGHT",nil,"TOPRIGHT"}, -10, 10, 50, 20, "Close", function()
 		self:ClosePopup()
@@ -927,8 +949,13 @@ function main:OpenAboutPopup()
 	controls.github = new("ButtonControl", nil, 0, 62, 438, 18, "^7GitHub page: ^x4040FFhttps://github.com/PathOfBuildingCommunity/PathOfBuilding", function(control)
 		OpenURL("https://github.com/PathOfBuildingCommunity/PathOfBuilding")
 	end)
-	controls.verLabel = new("LabelControl", { "TOPLEFT", nil, "TOPLEFT" }, 10, 82, 0, 18, "^7Version history:")
-	controls.changelog = new("TextListControl", nil, 0, 100, 630, 390, nil, changeList)
+	controls.verLabel = new("ButtonControl", { "TOPLEFT", nil, "TOPLEFT" }, 10, 85, 100, 18, "^7Version history:", function()
+		controls.changelog.list = changeList
+	end)
+	controls.helpLabel = new("ButtonControl", { "TOPLEFT", nil, "TOPLEFT" }, 600, 85, 40, 18, "^7Help:", function()
+		controls.changelog.list = helpList
+	end)
+	controls.changelog = new("TextListControl", nil, 0, 103, 630, 387, {{ x = 1, align = "LEFT" }, { x = 110, align = "LEFT" }}, changeList)
 	self:OpenPopup(650, 500, "About", controls)
 end