From 2db2e98519f7cc511f58dd9c3c7bda2539bd0256 Mon Sep 17 00:00:00 2001 From: Regisle <49933620+Regisle@users.noreply.github.com> Date: Wed, 14 Aug 2024 18:46:43 +0930 Subject: [PATCH] Explain Exporting Timeless jewels in RELEASE.md and dev help txt (#8161) * Explain Exporting Timeless jewels in RELEASE.md and dev help txt * update explanation for PRing the other repo --- RELEASE.md | 31 +++++++++++++++++++++++++++++++ help.txt | 6 ++++++ 2 files changed, 37 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index 1f3ae62f..af7cb847 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -56,6 +56,37 @@ Steps: 7. Restart Path of Building Community. This should result in a new file `tree.lua`. 8. Remove `data.json` and `sprites.json` from the new directory. Do not commit these files. +## Timeless Jewel updates + +The Timeless jewels determine what effect they have on a node based on the "Look up Tables" in \src\Data\TimelessJewelData +The LuTs for the Timeless jewels come from https://github.com/Regisle/TimelessJewelData +More information can be found there. + +The LuTs PoB uses are slightly different due to historical reasons, and so they can be generated using the generator from there. + + +------------------------------------------------------------------------------------------------------- +Steps to Generate Timeless Jewel LuTs for PoB: +1. Clone repo from https://github.com/Regisle/TimelessJewelData/tree/Generator +2. Open DatafileGenerator.sln in Visual Studio +3. Grab new data.json tree file +4. Grab new AlternatePassiveAdditions.json and AlternatePassiveSkills.json from https://snosme.github.io/poe-dat-viewer/ and clicking on 'Export data' in the top right +5. Run following commands in the Visual Studio command prompt order, adjusting for file location + dotnet run --project DataFileGenerator + E:\PoB Dev Work\TimelessJewelData\AlternatePassiveAdditions.json + E:\PoB Dev Work\TimelessJewelData\AlternatePassiveSkills.json + E:\PoB Dev Work\GGG Skill Tree\data.json + E:\PoB Dev Work\PathOfBuildingCommunity\src\Data\TimelessJewelData +6. Choose Compressed +7. Replace updated Files in \src\Data\TimelessJewelData + +Alt tab out and back in to make right click paste work +------------------------------------------------------------------------------------------------------- + +If updated this way making a PR to https://github.com/Regisle/TimelessJewelData with the files in the format it uses is appreciated. +To do this follow steps 1-5 the same and choose the other option for step 6. + + ## Installer creation Path of Building Community offers both installable and standalone releases. They're diff --git a/help.txt b/help.txt index c004ca32..b7281731 100644 --- a/help.txt +++ b/help.txt @@ -81,6 +81,12 @@ Adding ^ and then a number or hex code before text will change the colour of the ---[Timeless Jewels] +DEV[Developer Information:] +DEV[The Timeless jewels determine what effect they have on a node based on the "Look up Tables" in \src\Data\TimelessJewelData] +DEV[The LuTs for the timeless jewels come from https://github.com/Regisle/TimelessJewelData] +DEV[ ] +DEV[These can be generated if that repo is out of date (see RELEASE.md)] +DEV[ ] Timeless jewels modify nodes in a radius based on their seed, the same seed will apply the same changes to the same small/notable nodes so that is the number you look for. The Conqueror (name on the jewel) only affects the keystone. Path of Building has an inbuilt tool in the tree tab to search through seeds to find stats that would be good for your build.