Merge branch 'beta' into fork/hotm-commission-calculator

# Conflicts:
#	DISCORD_FAQ.md

CHANGELOG.md

@@ -12,12 +12,24 @@
 + Added Atmospheric Filter Display. - Erymanthus
     + This display shows the currently active buff as a GUI element.
     + For an optimal experience, please have the Atmospheric Filter accessory active.
++ Added Sensitivity Reducer. - martimavocado
+    + Lowers mouse sensitivity while in the garden.
+    + Either when pressing a keybind or holding a farming tool in hand.
+    + Changes by how much the sensitivity is lowered by.
+    + Show a GUI element while the feature is enabled.
+    + Option to only allow this feature while on ground and/or on barn plot.
 
 #### Fishing Features
 
 + Added Sea Creature Tracker. - hannibal2
     + Allows to only show single variants, e.g. water or lava or winter.
 
+#### Mining Features
+
++ Added Deep Caverns Parkour. - hannibal2
+    + Shows a parkour to the bottom of Deep Caverns and to Rhys.
++ Blocks the mining ability when on a private island. - Thunderblade73
+
 #### Dungeon Features
 
 + Hide particles and damage splashes during the terracotta phase in dungeons F6 and M6. - hannibal2
@@ -31,6 +43,10 @@
 + Added Dojo Rank Display. - HiZe
     + Display your rank, score, actual belt and points needed for the next belt in the Challenges inventory on the
       Crimson Isles.
++ Crimson Isle Volcano Geyser features. - MrFast
+    + Stops the white geyser smoke particles from rendering if your bobber is near the geyser.
+    + Draws a box around the effective area of the geyser.
+    + Change the color of the box around the geyser.
 
 #### Inventory Features
 
@@ -41,6 +57,8 @@
 + Show pet items XP Share and Tier Boost as small icons next to the pet in an inventory. - Thunderblade73
 + Added Shift Click Brewing. - Thunderblade73
     + Makes normal clicks to shift clicks in Brewing Stand inventory.
++ Low Quiver Notification. - CarsCupcake
+    + This will notify you via title if your quiver is low on arrows according to chat message.
 
 #### Item Features
 
@@ -93,6 +111,10 @@
 + Made blocks per second calculation more accurate immediately after starting to farm. - hannibal2
 + Warn to open visitor inventory again after partially serving Spaceman. - alexia
 + Updating the Garden Optimal Speed Display and Warning immediately when changing the setting. - hannibal2
++ Added auto mouse-unlocking on plot teleport in garden. - martimavocado
++ Improve items in sacks display in Visitor Shopping List wording and color. - alexia
++ Hide Garden Composter reminder while participating in a Farming Contest. - hannibal2
++ Improve Exportable Carrots/Expired Pumpkin tooltip in /ff. - alexia
 
 #### Rift Changes
 
@@ -109,6 +131,7 @@
 + Smarter check if the player is fishing for all fishing related displays. - hannibal2
 + Hide Sea Creature Tracker when wearing full Trophy Hunter armor. - martimavocado
 + Disabled Fishing Profit/SC Tracker in Kuudra. - CalMWolfs
++ Moved Sulphur Skitter Box from Crimson Isle to Fishing -> Trophy Fishing. - hannibal2
 
 #### Mining Changes
 
@@ -118,6 +141,10 @@
 
 + Show the guide text when hovering over the missing bingo goal list. - hannibal2
 
+#### Crimson Isle Changes
+
++ Added option to hide tasks after they've been completed in Crimson Isle Reputation Helper. - martimavocado
+
 #### Inventory Changes
 
 + Removed flawless gemstones from sack display. - CalMWolfs
@@ -140,6 +167,7 @@
 #### Diana Changes
 
 + Changed the Griffin Burrow Guess text to a centered title instead of an odd line that goes down. - hannibal2
++ Removed unnecessary error messages in Diana Burrow detection. - hannibal2
 
 #### Chat Changes
 
@@ -158,12 +186,21 @@
 
 + Using a better title for Area Boss features. - hannibal2
 
+#### Slayer Changes
+
++ Adding Soul Of The Alpha support to the Area Mini Boss features respawn timer and highlight. - martimavocado
+
 #### Misc Changes
 
 + Tia Relay Helper: Suggest /togglemusic. - alexia
 + Added option to ignore Everything Chroma in the chat. - VixidDev
 + Added Item Ability Cooldown support for Talbot's Theodolite (the Farming Island Trapper tracker thing). - Erymanthus
 + Fewer election API updates, fewer election API errors. - CalMWolfs
++ SkyHanni's own /wiki command logic now works better in SkyBlock Level guide and allows changing weather to use
+  official Hypixel Wiki or the older Fandom Wiki. - Obsidian
++ Added option to hide the already existing F3 SkyBlock Area Debug Feature. - Obsidian
+    + This feature shows the current area in SkyBlock while f3 is open.
++ Hovering on cheap items in an Item Tracker now shows the hidden items. - Mikecraft1224
 
 ### Fixes
 
@@ -181,6 +218,13 @@
 + Fixed rarity error for items thrown around when using Sprayanator. - hannibal2
 + Added cooldown to Garden Warp Commands. - Empa
 + Fixed the detection of Anita and Jacob visitors. - hannibal2
++ Fixed the pets menu detection for /ff. - martimavocado
++ Fixed Anita and Jacob workaround working outside of garden. - CalMWolfs
++ Fixed opening visitor Milestones menu not loading visitor amount for /ff. - martimavocado
++ Fixed Sensitivity Reducer still working when switching from the garden to the hub. - martimavocado
++ Fixed a rare farming weight API error. - CalMWolfs
++ Fixed mouse rotation unlocks after doing /warp garden with Sensitivity Reducer on. - martimavocado
++ Fixed wording of composter fuel warning. - alexia
 
 #### Combat Fixes
 
@@ -220,6 +264,7 @@
 + Fixed Mining Chat Filter not hiding gemstone messages. - CalMWolfs
 + Fixed names for the Crystal Hollows Mining Areas feature. - alexia
 + Fixed detection of gold and diamond essence gain chat message when powder mining. - CalMWolfs
++ Fixed powder mining start/end detection in Powder Tracker. - CalMWolfs
 
 #### Rift Fixes
 
@@ -230,6 +275,8 @@
 + Fixed Reindrake mob, Frosty NPC and frosty the snow blaster shop counting as sea creatures in the barn fishing
   timer. - hannibal2
 + Fixed trophy fish chat message detection. - Empa
++ Fixed Sheep pet triggering Geyser Box and fixed particles being permanently hidden after throwing bobber at it once. - Empa
++ Fixed fishing profit tracker stops working when trophy fishing for 10 minutes. - hannibal2
 
 #### Invenory Fixes
 
@@ -240,6 +287,14 @@
 + Fixed rune price calculation in Chest Value. - hannibal2
 + Fixed Power Stone Guide Highlight shows in other inventories when exiting via command. - hannibal2
 + Added options to hide Helmet Skins, Armor Dyes or Runes from Estimated Item Value Calculation. - hannibal2
++ Fixed Divine Gift and Flash enchants showing the wrong/no price in EstimatedItemValue. - jani
++ Fixed showing the Piece of Wizard Portal earned duplicate. - Thunderblade73
++ Fixed shift-click NPC sell not working for menus with different sizes and full inventories. - Thunderblade73
++ Fixed an error with the shift-click NPC sell feature. - Thunderblade73
++ Ignore Shift-Click NPC Sell when right-clicking a sack. - Thunderblade73
++ Fixed pet level stack size - Thunderblade73
++ Fixed enchantment names and pet names in the chest value feature. - hannibal2
++ Fixed pet names in item profit trackers. - hannibal2
 
 #### Bingo Fixes
 
@@ -259,6 +314,7 @@
 + Fixed render overlapping problem with chat, SkyHanni GUIs and title. - Thunderblade73
 + Fixed GUI positions moving into the bottom-right corner when leaving the GUI position editor while pressing the mouse
   button on next reopen. - hannibal2
++ Fixed parts of Compact Tab List being uncoloured. - CalMWolfs
 
 #### Winter Fixes
 
@@ -275,6 +331,9 @@
 + Fixed NPC typos in config. - absterge
 + Fixed rare error in Harp Features. - Thunderblade73
 + Fixed some getItemStack errors. - CalMWolfs
++ Fixed Minion XP calculation not working when having different mouse settings. - Thunderblade73
++ Fixed /gfs tab complete. - martimavocado
++ Fixed /warp is command replace. - hannibal2
 
 ### Technical Changes
 
@@ -326,6 +385,31 @@
 + Using NEUInternalName in the Reputation Helper Quest. - CalMWolfs
 + Limit RAM to 4 GB in the developement enviroment. - CalMWolfs
     + This is just the default and can be changed if needed.
++ Made /shupdaterepo better. - CalMWolfs
++ Added alignment support to Renderable. - Thunderblade73
++ Added support for dynamic Y size in Renderables. - Thunderblade73
++ Added outgoing chat log to /shchathistory. - nea
++ Added sending mining events to Soopy's API to test for new Mining Event feature. - CalMWolfs
++ Added /shcopybossbar to copy bossbar - Erymanthus
++ Splitting many utils functions from LorenzUtils up into other classes: ChatUtils, CollectionUtils, ConditionalUtils. - Thunderblade73
++ A ton of code cleanup, mainly on imports. - Thunderblade73 & hannibal2
++ Added mod identification for outgoing mod calls and show this data in /shchathistory. - nea
++ Sensitivity Reducer changes: clearer error message, using ChatUtils and wrong values in debug data. - martimavocado
++ Bumped NEU to version 2.1.1 pre-5. - CalMWolfs
++ Fixed an NPE in ReflectionUtils.shPackageName. - Thunderblade73
++ Cleaned up string pluralization methods. - alexia
++ Moved many regex patterns in the repo and code cleanup. - CalMWolfs
++ Improved purse pattern. - j10a1n15
++ Added cache to item stack → neu internal name. - hannibal2
++ Added cache to internal name → item name. - hannibal2
++ Added debug option to show SkyHanni item name in item lore. - hannibal2
++ Created ActionBarUpdateEvent and used it. - CalMWolfs
++ Added Rounded Rectangles Renderable. - VixidDev
++ Added progress Bar Renderable. - Thunderblade73
++ Added Horizontal Container Renderable. - Thunderblade73
++ Added GetFromSackAPI. - Thunderblade73
++ Improved Packet Test. - Thunderblade73
++ Increases the feature set of the packet test and improves usability.
 
 ## Version 0.22
 

CONTRIBUTING.md

@@ -77,7 +77,7 @@ format like "- #821" to illustrate the dependency.
 - Do not use `e.printStackTrace()`, use `CopyErrorCommand.logError(e, "explanation for users")` instead.
 - Do not use `MinecraftForge.EVENT_BUS.post(event)`, use `event.postAndCatch()` instead.
 - Do not use `toRegex()` or `toPattern()`, use `RepoPattern` instead.
-    - See [RepoPattern.kt](https://github.com/walkerselby/SkyHanni/blob/beta/src/main/java/at/hannibal2/skyhanni/utils/repopatterns/RepoPattern.kt)
+    - See [RepoPattern.kt](https://github.com/hannibal002/SkyHanni/blob/beta/src/main/java/at/hannibal2/skyhanni/utils/repopatterns/RepoPattern.kt)
 for more information and usages.
     - The pattern variables are named in the scheme `variableNamePattern`
 - Please use Regex instead of String comparison when it is likely Hypixel will change the message in the future.

DISCORD_FAQ.md

@@ -1,7 +1,7 @@
 _Frequently Asked Questions_
 
 > **1: How do I open the SkyHanni Menu?**
-> Use the command `/sh`
+> Use the command `/sh`.
 
 > **2: Why does SkyHanni tell me to update NotEnoughUpdates (NEU) even if I already have the latest version?**
 > To make the mod work, you need to use the latest version from <#1123201092193366027>.
@@ -11,46 +11,49 @@ _Frequently Asked Questions_
 > Do `/sh scale` to change the global GUI scale of all elements at once.
 
 > **4: My Garden Crop Milestones are not accurate. What should I do?**
-> To sync your Crop Milestones with SkyHanni, open /cropmilestones once.
+> To sync your Crop Milestones with SkyHanni, open `/cropmilestones` once.
 
 > **5: How can I move GUIs like Coins/Copper in SkyMart?**
 > Use the command `/sh open hotkey` to set a hotkey, and press it inside the GUI you want to move.
 
-> **6: Will SkyHanni support Minecraft versions 1.19 or 1.20? (Foraging Update)**
+> **6: Will SkyHanni support Minecraft versions 1.20? (Foraging Update)**
 > The Foraging update isn't expected to release for several months.
-> Thus, we'll wait for other mods in the community to update for Minecraft versions 1.19 or 1.20.
-> Switching from 1.8.9 to 1.19 will take some time, and we plan to discontinue support for 1.8.9 afterward since we won't support multiple versions at once.
+> Thus, we'll wait for other mods in the community to update for Minecraft version 1.20.
+> Switching from 1.8.9 to 1.20 will take some time, and we plan to discontinue support for 1.8.9 afterward since we won't support multiple versions at once.
 
 > **7: My Jacob Contest Display crops are wrong, how do I fix this?**
-> Run the command `/shclearcontestdata` to clear the Jacob contenst data.
+> Run the command `/shclearcontestdata` to clear the Jacob contest data.
 
 > **8: How can I get bigger crop hit boxes?**
-> Use [Patcher](<https://sk1er.club/mods/patcher>) to have 1.12 hit boxes in 1.8.9.
+> Use [Patcher](<https://sk1er.club/mods/patcher>) to have 1.12 hitboxes in 1.8.9.
 
 > **9: Why does my Item Tracker feature not track this item?**
-> 1. Check if the item goes directly into your sacks.
+> 1. Check if the item goes directly into your sacks. 
 > 2. If it does, enable the sack pickup chat message from Hypixel:
-> 3. Go to `hypixel settings --> personal -> chat feedback` and enable `sack notifications`
-> 4. If you want the [Sacks] messages to be hidden, do `/sh sacks hider` and enable that
+>  - Go to `Hypixel Settings --> Personal -> Chat Feedback` and enable `Sack Notifications`.
+> 3. If you want the [Sacks] messages to be hidden, do `/sh sacks hider` and enable that.
 
 > **10: How do I remove SkyHanni GUI elements?**
-> 1. Type `/sh gui`
-> 2. Hover over the UI element
-> 3. See the element name in the top center of screen
-> 4. Search for that element with /sh name
-> 5. Disable this feature
-
+> 1. Type `/sh gui`.
+> 2. Hover over the UI element.
+> 3. See the element name in the top center of screen.
+> 4. Search for that element with `/sh <name>`.
+> 5. Disable this feature.
+  
 > **11: How do I reset a SkyHanni tracker?**
-> 1. Do you want to **view only the current session**?
-> 2. Open the inventory (Press E) and hover over the display.
-> 3. Then click on [session].
-> 1. Do you want to **remove one specific item** from the tracker?
-> 2. Open the inventory (Press E) and hover over the display.
-> 3. Then shift-click on an item in the list to remove it.
-> 1. Do you want to reset the total stats of a tracker?
-> 2. To reset a tracker, use the in-game command /shcommands <tracker type>.
-> 3. Execute the obtained command to reset the tracker.
-
-
-*This FAQ was last updated on February 5th, 2024.
+> 1. Do you want to **view only the current session**? 
+>  - Open the inventory (Press E) and hover over the display. 
+>  - Then click on `[This Session]`.
+> 2. Do you want to **reset the current session**?
+>  - Open the inventory (Press E) and hover over the display.
+>  - Then click on `Reset Session!`.
+> 3. Do you want to **remove one specific item** from the tracker?
+>  - Open the inventory (Press E) and hover over the display.
+>  - Then shift-click on an item in the list to remove it.
+> 4. Do you want to reset the total stats of a tracker?
+>  - To reset a tracker, use the in-game command `/shcommands <tracker type>`.
+>  - Execute the obtained command to reset the tracker.
+
+
+*This FAQ was last updated on February 20th, 2024.
 If you believe there's something that should be added to this list, please tell us, so we can add it.*

FEATURES.md

@@ -147,6 +147,8 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Show pet items XP Share and Tier Boost as small icons next to the pet in an inventory. - Thunderblade73
 + Shift Click Brewing. - Thunderblade73
     + Makes normal clicks to shift clicks in Brewing Stand inventory.
++ Low Quiver Notification. - CarsCupcake
+    + This will notify you via title if your quiver is low on arrows according to chat message.
 
 </details>
 <details open><summary>
@@ -595,6 +597,12 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Atmospheric Filter Display. - Erymanthus
     + This display shows the currently active buff as a GUI element.
     + For an optimal experience, please have the Atmospheric Filter accessory active.
++ Sensitivity Reducer. - martimavocado
+    + Lowers mouse sensitivity while in the garden.
+    + Either when pressing a keybind or holding a farming tool in hand.
+    + Changes by how much the sensitivity is lowered by.
+    + Show a GUI element while the feature is enabled.
+    + Option to only allow this feature while on ground and/or on barn plot.
 
 </details>
 <details open><summary>
@@ -688,6 +696,8 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
     + Fully customizable: change what items or stats to show.
     + Has support for the maxed Great Explorer perk.
     + Option to hide while not grinding powder.
++ Added Deep Caverns Parkour. - hannibal2
+    + Shows a parkour to the bottom of Deep Caverns and to Rhys.
 
 </details>
 <details open><summary>
@@ -950,6 +960,11 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
     + Support for the Hypixel command /p kick /pk to add a reason. The reason will be sent in party chat before
       kicking the player.
 + Color the month names on the scoreboard. - J10a1n15
++ Blocks the mining ability when on a private island. - Thunderblade73
++ Crimson Isle Volcano Geyser features. - MrFast
+    + Stops the white geyser smoke particles from rendering if your bobber is near the geyser.
+    + Draws a box around the effective area of the geyser.
+    + Change the color of the box around the geyser.
 
 </details>
 <details open><summary>

INSTALLING.md

@@ -53,7 +53,7 @@ channel [#neu-updates](https://discord.com/channels/997079228510117908/112320109
 <details>
 <summary>5. Download SkyHanni</summary>
 
-SkyHanni has 2 update circles: [Full Release](https://github.com/hannibal002/SkyHanni/releases/latest)
+SkyHanni has two different update circles: [Full Release](https://github.com/hannibal002/SkyHanni/releases/latest)
 and [Beta](https://github.com/hannibal002/SkyHanni/releases).
 
 In general, it is recommended to use the **Full Release**.
@@ -130,4 +130,4 @@ settings.
 
 </details>
 
-<h1>And finally, don't forget to <i><b>never run a file that is sent to you in dms</b></i></h1>
+<h2>And finally, don't forget to <i><b>never run a file that is sent to you in dms</b></i></h2>

build.gradle.kts

@@ -14,7 +14,7 @@ plugins {
 }
 
 group = "at.hannibal2.skyhanni"
-version = "0.23.Beta.16"
+version = "0.23.Beta.21"
 
 val gitHash by lazy {
     val baos = ByteArrayOutputStream()
@@ -103,7 +103,7 @@ dependencies {
         exclude(module = "unspecified")
         isTransitive = false
     }
-    devenvMod("com.github.NotEnoughUpdates:NotEnoughUpdates:v2.1.1-pre4:all") {
+    devenvMod("com.github.NotEnoughUpdates:NotEnoughUpdates:v2.1.1-pre5:all") {
         exclude(module = "unspecified")
         isTransitive = false
     }
@@ -114,7 +114,7 @@ dependencies {
     implementation(libs.hotswapagentforge)
 
 //    testImplementation(kotlin("test"))
-    testImplementation("com.github.NotEnoughUpdates:NotEnoughUpdates:v2.1.1-pre4:all") {
+    testImplementation("com.github.NotEnoughUpdates:NotEnoughUpdates:v2.1.1-pre5:all") {
         exclude(module = "unspecified")
         isTransitive = false
     }