Merge branch 'dev'

Author: LocalIdentity

.github/ISSUE_TEMPLATE/accuracy_bug_report.yaml

@@ -1,12 +1,13 @@
 name: Accuracy bug report
-description: Create a bug report to help us fix incorrect wordings
+description: Create a bug report to help us fix incorrect wording in Path of Building for PoE2.
 labels: ["bug:accuracy"]
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for reporting an issue.
-        Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required.
+        Thank you for reporting an issue with PoB-**PoE2**.  
+        [Issues with PoB-PoE1 go here.](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues)
+        Please try to fill in as much of the form below as you're able to. Fields marked with an asterisk (*) are required.
   - type: checkboxes
     id: version
     attributes:
@@ -56,9 +57,9 @@ body:
   - type: textarea
     id: build_code
     attributes:
-      label: Character build code
+      label: PoB for PoE2 build code
       description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster.
-      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build.
+      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a PoB build.
       render: shell
     validations:
       required: false

.github/ISSUE_TEMPLATE/application_bug_report.yaml

@@ -1,12 +1,13 @@
 name: Application bug report
-description: Create a bug report to help us fix an issue in Path of Building
+description: Create a bug report to help us fix an issue in Path of Building for PoE2.
 labels: [bug]
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for reporting an issue.
-        Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required.
+        Thank you for reporting an issue with PoB-**PoE2**.
+        [Issues with PoB-PoE1 go here.](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues).
+        Please try to fill in as much of the form below as you're able to. Fields marked with an asterisk (*) are required.
   - type: checkboxes
     id: version
     attributes:
@@ -65,9 +66,9 @@ body:
   - type: textarea
     id: build_code
     attributes:
-      label: Character build code
+      label: PoB for PoE2 build code
       description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster.
-      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build.
+      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a PoB build.
       render: shell
     validations:
       required: false

.github/ISSUE_TEMPLATE/behaviour_bug_report.yaml

@@ -1,12 +1,13 @@
 name: Behaviour bug report
-description: Create a bug report to help us fix incorrect behaviour or logic
+description: Create a bug report to help us fix incorrect behaviour or logic in Path of Building for PoE2.
 labels: ["bug:behaviour"]
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for reporting an issue.
-        Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required.
+        Thank you for reporting an issue with PoB-**PoE2**.
+        [Issues with PoB-PoE1 go here.](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues).
+        Please try to fill in as much of the form below as you're able to. Fields marked with an asterisk (*) are required.
   - type: checkboxes
     id: version
     attributes:
@@ -71,9 +72,9 @@ body:
   - type: textarea
     id: build_code
     attributes:
-      label: Character build code
+      label: PoB for PoE2 build code
       description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster.
-      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build.
+      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a PoB build.
       render: shell
     validations:
       required: true

.github/ISSUE_TEMPLATE/calculation_bug_report.yaml

@@ -1,12 +1,13 @@
 name: Calculation bug report
-description: Create a bug report to help us fix incorrect calculations
+description: Create a bug report to help us fix incorrect calculations in Path of Building for PoE2.
 labels: ["bug:calculation"]
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for reporting an issue.
-        Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required.
+        Thank you for reporting an issue with PoB-**PoE2**.  
+        [Issues with PoB-PoE1 go here.](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues)
+        Please try to fill in as much of the form below as you're able to. Fields marked with an asterisk (*) are required.
   - type: checkboxes
     id: version
     attributes:
@@ -71,9 +72,9 @@ body:
   - type: textarea
     id: build_code
     attributes:
-      label: Character build code
+      label: PoB for PoE2 build code
       description: Always provide a build code that exhibits the bug you want to report, even if it is not specific to a particular build. This helps us greatly to reproduce bugs faster.
-      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a shared build.
+      placeholder: This can be either a code copied from the "Import/Export Build" tab or a link to a PoB build.
       render: shell
     validations:
       required: true

.github/ISSUE_TEMPLATE/crash_report.yaml

@@ -1,12 +1,13 @@
 name: Crash report
-description: Create a crash report to help us fix critical issues
+description: Create a crash report to help us fix critical issues in Path of Building for PoE2.
 labels: [bug, crash]
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for reporting a crash or severe graphical issue.
-        Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required.
+        Thank you for reporting a crash or severe graphical issue in PoB-**PoE2**.
+        [Issues with PoB-PoE1 go here.](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues)
+        Please try to fill in as much of the form below as you're able to. Fields marked with an asterisk (*) are required.
   - type: checkboxes
     id: version
     attributes:
@@ -70,10 +71,10 @@ body:
   - type: textarea
     id: build_code
     attributes:
-      label: Character build code
+      label: PoB for PoE2 build code
       description: Provide a build code if the crash/graphical issue is caused by a certain build.
       placeholder: |
-        This can be either a code copied from the "Import/Export Build" tab or a link to a shared build. 
+        This can be either a code copied from the "Import/Export Build" tab or a link to a PoB build. 
         In the case where Path of Building crashes/doesn't work on startup or when you open a build.
         Go to your builds folder (default %userprofile%/Documents/Path of Building/Builds) and copy the problematic build's .xml contents into a pastebin and supply the link.
       render: shell

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,12 +1,13 @@
 name: Feature request
-description: Suggest an idea for this project
+description: Suggest an idea for Path of Building for PoE2.
 labels: [enhancement]
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for suggesting a feature.
-        Please try to fill in as much of the form below as you're able to. Some of the fields marked with an asterisk (*) are required.
+        Thank you for suggesting a feature for PoB-**PoE2**.
+        [Feature requests for PoB-PoE1 go here.](https://github.com/PathOfBuildingCommunity/PathOfBuilding/issues).
+        Please try to fill in as much of the form below as you're able to. Fields marked with an asterisk (*) are required.
   - type: checkboxes
     id: duplicates
     attributes:

.github/workflows/update-simple-graphic.yml

@@ -0,0 +1,29 @@
+name: Update SimpleGraphic DLLs
+on:
+    repository_dispatch:
+        types: [update-simple-graphic]
+jobs:
+    update:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                ref: 'dev'
+            - name: Download DLLs
+              uses: robinraju/release-downloader@v1
+              with:
+                repository: ${{ github.repository_owner }}/PathOfBuilding-SimpleGraphic
+                tag: ${{ github.event.client_payload.tag }}
+                fileName: SimpleGraphicDLLs-x64-windows.tar
+                extract: true
+                out-file-path: runtime
+            - name: Create Pull Request
+              uses: peter-evans/create-pull-request@v5
+              with:
+                title: Update to SimpleGraphic ${{ github.event.client_payload.tag }}
+                branch: simple-graphic-${{ github.event.client_payload.tag }}
+                body: |
+                    Update DLLs to SimpleGraphic-${{ github.event.client_payload.tag }} from ${{ github.event.client_payload.release_link }}
+                commit-message: Update DLLs to SimpleGraphic-${{ github.event.client_payload.tag }}
+              

CHANGELOG.md

@@ -23,7 +23,7 @@
 * Please provide detailed instructions on how to reproduce the bug, if possible.
 * Provide a build share code for a build that is affected by the bug, if possible.
   In the "Import/Export Build" tab, click "Generate", then "Share" and add the link to your post. 
-  
+
 Build share codes allow us to reproduce bugs much more quickly. 
 
 ## Requesting features
@@ -48,7 +48,7 @@ Feature requests are always welcome. Note that not all requests will receive an
 ### When submitting a pull request:
 * **Pull requests must be created 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!
-* If you're updating mod parsing logic, make sure to reload PoB with `Ctrl` + `F5` to regenerate `./src/Data/ModCache.lua`. This is a very large, automatically generated file that can be used to verify your changes didn't affect any other mods inadvertently.
+* If you're updating mod parsing logic, make sure to reload PoB with `Ctrl` + `F5` to regenerate `./src/Data/ModCache.lua`. This is a very large, automatically generated file that can be used to verify your changes didn't affect any other mods inadvertently. Make sure to commit `./src/Data/ModCache.lua` if your changes cause it to differ.
 * There are many more files in the `./src/Data` directory that are automatically generated. This is indicated by the header 
   `-- This file is automatically generated, do not edit!`. To change these, instead change the scripts in the `./src/Export` directory and rerun the exporter.
   For your PR, please include all relevant changes to both the scripts and data files.
@@ -66,7 +66,7 @@ The easiest way to make and test changes is by setting up a development installa
 
        cd PathOfBuilding-PoE2
 
-3. Start Path of Building from the repository by running `./runtime/Path{space}of{space}Building.exe`.
+3. Start Path of Building from the repository by running `./runtime/Path{space}of{space}Building-PoE2.exe`.
 
 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).
@@ -158,7 +158,7 @@ To do this in VSCode find the Java installation folder on your computer as displ
 -- This is the path to emmy_core.dll. The ?.dll at the end is intentional.
 package.cpath = package.cpath .. ";C:/Users/someuser/.vscode/extensions/tangzx.emmylua-0.5.19/debugger/emmy/windows/x64/?.dll"
 local dbg = require("emmy_core")
--- This port must match the Visual Studio Code configuration. Default is 9966.
+-- This port must match the IDE configuration. Default is 9966.
 dbg.tcpListen("localhost", 9966)
 -- Uncomment the next line if you want Path of Building to block until the debugger is attached
 --dbg.waitIDE()
@@ -196,38 +196,39 @@ Files in /Data /Export and /TreeData can be massive and cause the emmyLua langua
 6. Attach the debugger
 
 #### Miscellaneous tips
+
 If you're on windows, consider downloading [git for windows](https://git-scm.com/downloads) and installing git bash. Git bash comes with a variety of typical linux tools such as grep that can make navigating the code base much easier.
 
 If you're using linux you can run the ./runtime/Path{space}of{space}Building.exe executable with wine. You will need to provide a valid wine path to the emmy lua debugger directory.
 
+```bash
+# winepath -w ~/.vscode/extensions/tangzx.emmylua-0.8.20-linux-x64/debugger/emmy/windows/x64/
+Z:\home\dev\.vscode\extensions\tangzx.emmylua-0.8.20-linux-x64\debugger\emmy\windows\x64\
+```
 
 ## Testing
 
-PoB uses the [Busted](https://olivinelabs.com/busted/) framework to run its tests.  Tests are stored under `spec/System` and run automatically when a PR is modified.
+PoB uses the [Busted](https://olivinelabs.com/busted/) framework to run its tests. Tests are stored under `spec/System` and run automatically when a PR is modified.
 More tests can be added to this folder to test specific functionality, or new test builds can be added to ensure nothing changed that wasn't intended. 
 
 ### Running tests
-1. Install [LuaRocks](https://luarocks.org/)
-2. Run `luarocks install busted`
-3. Run `busted --lua=luajit` from the command line.  You may need to add `luajit` to your PATH
-
-Docker alternative:
 
 1. Install [Docker](https://www.docker.com/get-started)
-2. Run `docker-compose up -d` from the command line
-3. View last results in `spec/test_results.log`
+2. Run `docker-compose up` from the command line
+3. Review the results in the terminal
 
-### Creating new test builds or fixing an existing build
+Please try to include tests for your new features in your pull request. Additionally, if your pr breaks a test that should be passing please update it accordingly.
 
-Sometimes a change will be made that intends to change the stats garnered by PoB, which will break our tests.
-1. Add the new build XML (if applicable) to the `TestBuilds` folder
-2. Run `busted --lua=luajit -r generate` to generate a LUA file that contains the current stats of that build
-3. Run `busted --lua=luajit` and the tests should pass
-
-Docker alternative:
-
-1. Add the new build XML (if applicable) to the `TestBuilds` folder
-2. Run `docker-compose up -d` to generate a LUA file that contains the current stats of that build and run the tests
+### Debugging tests
+When running tests with a docker container it is possible to use emmylua for debugging. Paste in the following right under `function launch:OnInit()` in `./src/Launch.lua`:
+```lua
+package.cpath = package.cpath .. ";/usr/local/bin/?.so"
+local dbg = require("emmy_core")
+-- This port must match the IDE Code configuration. Default is 9966.
+dbg.tcpListen("localhost", 9966)
+dbg.waitIDE()
+```
+After running `docker-compose up` the code will wait at the `dbg.waitIDE()` line until a debugger is attached. This will allow stepping through any code that is internal to POB but will not work for busted related code. Note that this only works for unit tests described above.
 
 ## Path of Building development tutorials
 
@@ -236,6 +237,8 @@ Docker alternative:
 * [How skills work in Path of Building](docs/addingSkills.md)
 
 ## Exporting GGPK data from Path of Exile
+> [!WARNING]   
+> This will not work on files from the torrent that is released before league launches, as it contains no `Data` section.
 
 Note: This tutorial assumes that you are already familiar with the GGPK and its structure. [poe-tool-dev/ggpk.discussion](https://github.com/poe-tool-dev/ggpk.discussion/wiki)
 is a good starting point.
@@ -244,6 +247,9 @@ The `./src/Data` folder contains generated files which are created using the scr
 If you change any logic/configuration in `./src/Export`, you will need to regenerate the appropriate `./src/Data` files. You can do so by running the `./src/Export` scripts using the `.dat` viewer at `./src/Export/Launch.lua`:
 
 ### Obtain an Oodle extractor
+> [!TIP]   
+> Binaries are usually available at https://github.com/zao/ooz/releases.
+
 Note: For this tutorial, you will need a working installation of [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/)
 as well as some familiarity with build tools such as [CMake](https://cmake.org).
 1. In Visual Studio, clone the following repository using this command:
@@ -252,13 +258,25 @@ as well as some familiarity with build tools such as [CMake](https://cmake.org).
 2. Configure CMake.
 3. Build `bun_extract_file.exe`, `libbun.dll` and `libooz.dll`.
 
-### Set up the exporter   
-1. Copy `bun_extract_file.exe`, `libbun.dll` and `libooz.dll` to `./src/Export/ggpk/`.
-2. Create a shortcut to `./runtime/Path{space}of{space}Building.exe` with the path to `./src/Export/Launch.lua` as first argument. You should end up with something like: `"<path to repo>\runtime\Path{space}of{space}Building.exe" "<path to repo>\src\Export\Launch.lua"`.
-3. 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 Community.
-4. Paste the path to `Content.ggpk` (or, for Steam users, `C:\Program Files (x86)\Steam\steamapps\common\Path of Exile`) 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.
-5. 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.
-6. If you run into any errors, update the code in `./src/Export` as necessary and try again.
+### Set up the exporter
+1. Copy `bun_extract_file.exe`, `libbun.dll` and `libooz.dll` to `.\src\Export\ggpk\`.
+2. Create a shortcut to `.\runtime\Path{space}of{space}Building.exe` with the path to `.\src\Export\Launch.lua` as the first argument. You should end up with something like: 
+
+       "<path to repo>\runtime\Path{space}of{space}Building.exe" "<path to repo>\src\Export\Launch.lua"
+3. Run the shortcut.  "Dat View", the GGPK data viewer UI, should appear.  If you get an error, be sure you're using the latest release of Path of Building Community.
+4. Click `Edit Sources...` to display the "New DAT Source" popup.  Click `New` and enter a name.
+5. Paste the full path to `Content.ggpk` into the "Source from GGPK/Steam PoE path" box and hit `Enter`.  For the stand-alone client, the path must include the file-name.  (Do not put anything in the "Source from DAT files" box unless you have already manually unpacked the relevant files.)  
+
+   Example input for the stand-alone client:
+
+       C:\Path of Exile 2\Content.ggpk
+   Example input for Steam:
+
+       C:\Program Files (x86)\Steam\steamapps\common\Path of Exile 2  
+
+   If successful, you should see some cmd windows pop up as the files are unpacked, and then a list of the data tables in the GGPK file should appear.  
+6. 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.
+7. If you run into any errors, update the code in `./src/Export` as necessary and try again.
 
 ## Using the inbuilt profiler
 The profiler is found at https://github.com/charlesmallah/lua-profiler and is written entirely in lua under a MIT license.