Merge branch 'beta' into total-powder-needed

.github/workflows/illegal-imports.txt

@@ -7,3 +7,4 @@ at/hannibal2/skyhanni/ scala.
 at/hannibal2/skyhanni/ jline.
 at/hannibal2/skyhanni/ io.github.moulberry.notenoughupdates.util.Constants
 at/hannibal2/skyhanni/ io.github.moulberry.notenoughupdates.events.SlotClickEvent
+at/hannibal2/skyhanni/ io.github.moulberry.notenoughupdates.events.ReplaceItemEvent

build.gradle.kts

@@ -15,7 +15,7 @@ plugins {
 }
 
 group = "at.hannibal2.skyhanni"
-version = "0.26.Beta.2"
+version = "0.26.Beta.4"
 
 val gitHash by lazy {
     val baos = ByteArrayOutputStream()

docs/CHANGELOG.md

@@ -17,15 +17,65 @@
 #### Garden Features
 
 + New "Craftable!" message when Visitor Items Needed are craftable. - Paloys (https://github.com/hannibal002/SkyHanni/pull/1891)
++ Added crop last farmed waypoint. - appable (https://github.com/hannibal002/SkyHanni/pull/1335)
+    + Accessible in the Crop Start Locations section.
 
-#### ChatFeatures
+#### Dungeon Features
+
++ Added Croesus Limit Warning. - saga (https://github.com/hannibal002/SkyHanni/pull/1908)
+    + Sends a warning when you are close to the Croesus Chest Limit.
+
+#### Command Features
+
++ Option to toggle limbo time in detailed /playtime. - HiZe (https://github.com/hannibal002/SkyHanni/pull/1863)
+
+#### Chat Features
 
 + Added new chat filters. - Mikecraft1224 (https://github.com/hannibal002/SkyHanni/pull/1750)
     + Filters for rare dungeon chest rewards and sacrifice messages from other players.
 
+#### Event Features
+
++ Chat reminder to check Hoppity Shop each year. - appable (https://github.com/hannibal002/SkyHanni/pull/1843)
++ Highlight rabbits that have requirements in the Hoppity's Collection menu. - HiZe (https://github.com/hannibal002/SkyHanni/pull/1874)
+    + Green: Requirement met.
+    + Red: Requirement not met.
++ Mark duplicate egg locations in red for unlocking some of the new rabbits. - appable (https://github.com/hannibal002/SkyHanni/pull/1929)
+    + Option to always mark nearby duplicate egg locations.
++ Added "Collected Locations" line to the Unclaimed Eggs Display. - appable (https://github.com/hannibal002/SkyHanni/pull/1929)
+    + This may be inaccurate if you've already collected eggs on an island.
++ Show total amount of chocolate spent in the Chocolate Shop. - sayomaki (https://github.com/hannibal002/SkyHanni/pull/1921)
+
+#### Mining Features
+
++ Configurable cold amount for the ascension rope message in Glacite Mines. - nopo (https://github.com/hannibal002/SkyHanni/pull/1905)
++ Added HOTM perks level and Enable Display. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1059)
+
+#### Inventory Features
+
++ Warning when outbid on an auction. - seraid (https://github.com/hannibal002/SkyHanni/pull/1818)
++ Added option to show time held in lore for Jyrre Bottles and Cacao Truffles. - Obsidian (https://github.com/hannibal002/SkyHanni/pull/1916)
++ Added Dark Cacao Truffle hours held as stack size. - Obsidian (https://github.com/hannibal002/SkyHanni/pull/1916)
++ Added ULTRA RARE Book Notification when doing the Experiment Table. - raven (https://github.com/hannibal002/SkyHanni/pull/1738)
+
+#### Fishing Features
+
++ Added Trophy Fishing Display. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1754)
+    + Similar to Skytils, but with more options.
+    + Option to sort by item rarity, total amount, rarity amount, the highest rarity, or name alphabetically.
+    + Option to change what information is displayed (rarity, name, icon, total caught).
+    + Option to show only missing trophies.
+    + Option to highlight new catches in green.
+    + Options for when to show the display: always in Crimson Isle, in inventory, with rod in hand, or on keybind press.
+    + Option to show only when wearing a full hunter armor set.
+    + Options to show checkmarks or crosses instead of numbers.
+    + Hover over a trophy fish to see the percentage caught and how to gain progress.
+
 #### Misc Features
 
 + Click on breakdown display in /playtimedetailed to copy the stats into the clipboard. - seraid (https://github.com/hannibal002/SkyHanni/pull/1807)
++ Added Editable Hotbar. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1903)
+    + Allows for moving and scaling in the SkyHanni GUI editor.
 
 ### Improvements
 
@@ -36,22 +86,46 @@
 #### Garden Improvements
 
 + Added `/shtpinfested` command to teleport to nearest infested plot. - Empa (https://github.com/hannibal002/SkyHanni/pull/1763)
++ Warp to Infested Plot warps to garden home when no pests are found. - saga (https://github.com/hannibal002/SkyHanni/pull/1910)
+    + Affects both hotkey and command.
 
 #### Hoppity Event Improvements
 
 + Renamed "Unfound Eggs" to "Unclaimed Eggs" for the Hoppity event. - Luna (https://github.com/hannibal002/SkyHanni/pull/1876)
 + Added Compact Hoppity Chat option. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1748)
++ Hoppity Collection Stats are now persistent. - appable (https://github.com/hannibal002/SkyHanni/pull/1836)
+    + No longer reset on profile swap or game restart.
++ Merged duplicate times in compacted Hoppity's messages. - DavidArthurCole (https://github.com/hannibal002/SkyHanni/pull/1887)
++ Option to show Hoppity Eggs timer outside of SkyBlock. - maxime-bodifee (https://github.com/hannibal002/SkyHanni/pull/1926)
 
 #### Mining Improvements
 
 + Highlight Treasure Hoarders during Treasure Hoarder Puncher commissions. - Luna (https://github.com/hannibal002/SkyHanni/pull/1852)
++ Added Mining Event Icons. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1305)
 
 #### Commands Improvements
 
 + Updated /shcommands. - ThatGravyBoat (https://github.com/hannibal002/SkyHanni/pull/1720)
     + Now has pages for better navigation.
     + Improved visual appearance.
 
+#### Dungeon Improvements
+
++ Changed reminders to show at the end of a dungeon run. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1917)
+    + E.g. Composter empty, Hoppity Eggs ready, New Year Cake, etc.
+
+#### Chat Improvements
+
++ Added Pet Rarity to Oringo Abiphone messages. - Empa (https://github.com/hannibal002/SkyHanni/pull/1862)
+
+#### Inventory Improvements
+
++ Adjusted and added Rabbit Uncle & Dog Keybinds. - raven (https://github.com/hannibal002/SkyHanni/pull/1907)
+
+#### Fishing Improvements
+
++ Added option to show the name of the sea creature in the title notification. - Empa (https://github.com/hannibal002/SkyHanni/pull/1858)
+
 #### Misc Improvements
 
 + Added a toggle for 24-hour time. - seraid (https://github.com/hannibal002/SkyHanni/pull/1804)
@@ -66,15 +140,20 @@
 
 + Fixed Tunnel Maps GUI position not saving. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1882)
 + Fixed Glacite Walkers not being highlighted during commissions. - Luna (https://github.com/hannibal002/SkyHanni/pull/1850)
++ Fixed warping to Base in Glacite Tunnels when pressing the keybind while inside any GUI. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1911)
++ Fixed Custom Scoreboard error in Mineshaft. - j10a1n15 (https://github.com/hannibal002/SkyHanni/pull/1909)
 
 #### Garden Fixes
 
 + Fixed farming contests showing in the election GUI. - CalMWolfs (https://github.com/hannibal002/SkyHanni/pull/1871)
 + Fixed wrong icon for the rat crop type in Stereo Harmony display. - raven (https://github.com/hannibal002/SkyHanni/pull/1849)
 
-#### Chocolate Factory Fixes
+#### Chocolate Factory & Hoppity Hunt Fixes
 
 + Fixed some Chocolate Factory issues caused by a Hypixel update. - CalMWolfs (https://github.com/hannibal002/SkyHanni/pull/1860)
++ Fixed a bug where the chocolate factory leaderboard position was not showing when the position had many digits. - sayomaki (https://github.com/hannibal002/SkyHanni/pull/1918)
++ Fixed compact chat sometimes breaking when obtaining legendary or higher tier rabbits. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1923)
++ Fixed Sigma Rabbit bonuses not counting in collection stats display. - appable (https://github.com/hannibal002/SkyHanni/pull/1925)
 
 #### Custom Scoreboard Fixes
 
@@ -89,10 +168,23 @@
 
 + Fixed a typo in Tunnels Maps. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1883)
 
+#### Commands Fixes
+
++ Fixed typo in /shclearkismet command. - fahr-plan (https://github.com/hannibal002/SkyHanni/pull/1912)
++ Fixed 'viewrecipe' lowercase not working. - Obsidian + hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1939)
+
+#### Fishing Fixes
+
++ Fixed Thunder and Jawbus not being highlighted by Highlight Rare Sea Creatures. - Empa (https://github.com/hannibal002/SkyHanni/pull/1858)
+
 #### Performance Fixes
 
 + Fixed small memory leaks when staying in one island for extended periods. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1890)
 
+#### Misc Fixes
+
++ Fixed LorenzToolTipEvent triggering when not actually hovering over an item. - CalMWolfs (https://github.com/hannibal002/SkyHanni/pull/1920)
+
 ### Technical Details
 
 + Use more simple time mark. - CalMWolfs (https://github.com/hannibal002/SkyHanni/pull/1777)

docs/DISCORD_FAQ.md

@@ -52,6 +52,13 @@ _Frequently Asked Questions_
 >  - To reset a tracker, use the in-game command `/shcommands <tracker type>`.
 >  - Execute the obtained command to reset the tracker.
 
+> **12: Why can I still see the normal Scoreboard when using Custom Scoreboard?**
+> Most of the time, this is a mod conflict.
+> If you are using [Sidebar Mod](https://github.com/Alexdoru/SidebarMod), please remove this mod.
+> If you are using [VanillaHUD](https://modrinth.com/mod/vanillahud), please disable its Scoreboard by clicking on the blue bar below "Scoreboard" in the OneConfig Menu.
+> If you are using [Apec](https://github.com/BananaFructa/Apec/) and want to remove their Scoreboard, you need to remove Apec since they don't have an option to disable their Scoreboard.
+> If you don't use any of these mods, make sure the option to "Hide Vanilla Scoreboard" is actually enabled.
 
-*This FAQ was last updated on April 22nd, 2024.
+
+*This FAQ was last updated on May 27th, 2024.
 If you believe there's something that should be added to this list, please tell us, so we can add it.*

docs/FEATURES.md

@@ -54,7 +54,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 - Powder Mining messages hider
 - Winter gift messages hider
 - Many other messages (Not separated into own categories yet)
-+ Added new chat filters. - Mikecraft1224 (https://github.com/hannibal002/SkyHanni/pull/1750)
++ More chat filters. - Mikecraft1224 (https://github.com/hannibal002/SkyHanni/pull/1750)
     + Filters for rare dungeon chest rewards and sacrifice messages from other players.
 
 </details>
@@ -86,6 +86,8 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Hide the golden fairy that follows the healer in dungeon.
 + Catacombs class level color in party finder inventory.
 + Visual highlight chests that have not yet been opened in the Croesus inventory.
++ Croesus Limit Warning. - saga (https://github.com/hannibal002/SkyHanni/pull/1908)
+    + Sends a warning when you are close to the Croesus Chest Limit.
 + Outline Dungeon Teammates. - Cad
 + Dungeon Colored Class Level. - hannibal2
     + Color class levels in the tab list. (Also hide rank colors and emblems because who needs that in dungeons anyway?)
@@ -141,6 +143,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Highlight depleted Bonzo's Masks in your inventory.
 + Highlight stuff that is missing in the SkyBlock level guide inventory.
 + **Auction Highlighter** - Highlight own items that are sold in green and that are expired in red.
++ Warning when outbid on an auction. - seraid (https://github.com/hannibal002/SkyHanni/pull/1818)
 + Highlight your own lowest BIN auctions that are outbid. - hannibal2
 + **Unclaimed Rewards** - Highlight contests with unclaimed rewards in the jacob inventory.
 + **Contest Time** - Show the real time format to the farming contest description.
@@ -328,6 +331,16 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
     + Option to hide Totem Particles.
     + Option to show the effective area of a totem.
     + Option to get reminded when a totem is about to expire.
++ Trophy Fishing Display. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1754)
+    + Similar to Skytils, but with more options.
+    + Option to sort by item rarity, total amount, rarity amount, the highest rarity, or name alphabetically.
+    + Option to change what information is displayed (rarity, name, icon, total caught).
+    + Option to show only missing trophies.
+    + Option to highlight new catches in green.
+    + Options for when to show the display: always in Crimson Isle, in inventory, with rod in hand, or on keybind press.
+    + Option to show only when wearing a full hunter armor set.
+    + Options to show checkmarks or crosses instead of numbers.
+    + Hover over a trophy fish to see the percentage caught and how to gain progress.
 
 </details>
 <details open><summary>
@@ -596,6 +609,8 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
     + Show the start waypoint for your farm with the currently holding tool.
     + Auto-detects the start of the farm when farming for the first time
     + Option to manually set the waypoint with /shcropstartlocation
++ Crop last farmed waypoint. - appable (https://github.com/hannibal002/SkyHanni/pull/1335)
+    + Accessible in the Crop Start Locations section.
 + Jacob Contest Stats Summary
     + Showing Blocks per Second and total Blocks clicked after a farming contest in chat
 + **Contest Time Needed**
@@ -808,6 +823,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
     + Track Fossil Dust and use it for profit calculation.
 + Mining Notifications. - martimavocado (https://github.com/hannibal002/SkyHanni/pull/1429)
     + Mining events, including Mineshaft spawning, Suspicious Scrap drops, and Cold going above a threshold.
++ Configurable cold amount for the ascension rope message in Glacite Mines. - nopo (https://github.com/hannibal002/SkyHanni/pull/1905)
 + Profit Per Excavation. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1439)
     + Show profit/loss in chat after each excavation.
     + Also include breakdown information on hover.
@@ -825,6 +841,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Profit Per Corpse. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1734)
     + Displays profit/loss in chat after looting a corpse in the Mineshaft.
     + Includes a breakdown of information on hover.
++ HOTM perks level and Enable Display. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1059)
 
 </details>
 <details open><summary>
@@ -855,6 +872,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Jyrre Timer for Bottle of Jyrre. - walker
     + A timer showing the remaining duration of your intelligence boost.
     + Option to show the timer when inactive rather than removing it.
++ Option to show time held in lore for Jyrre Bottles and Cacao Truffles. - Obsidian (https://github.com/hannibal002/SkyHanni/pull/1916)
 + New Year Cake Reminder. - hannibal2
 + Easter Egg Hunt 2024 waypoints. - Erymanthus + walker (https://github.com/hannibal002/SkyHanni/pull/1193)
 
@@ -889,6 +907,15 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Ability to adjust the opacity of players near shared and guessed egg waypoints. - RobotHanzo (https://github.com/hannibal002/SkyHanni/pull/1582)
 + Time until the next Hoppity event in chat message for egg locator. - seraid (https://github.com/hannibal002/SkyHanni/pull/1625)
 + Warning before the Time Tower in the Chocolate Factory ends. - seraid (https://github.com/hannibal002/SkyHanni/pull/1816)
++ Chat reminder to check Hoppity Shop each year. - appable (https://github.com/hannibal002/SkyHanni/pull/1843)
++ Highlight rabbits that have requirements in the Hoppity's Collection menu. - HiZe (https://github.com/hannibal002/SkyHanni/pull/1874)
+    + Green: Requirement met.
+    + Red: Requirement not met.
++ Mark duplicate egg locations in red for unlocking some of the new rabbits. - appable (https://github.com/hannibal002/SkyHanni/pull/1929)
+    + Option to always mark nearby duplicate egg locations.
++ Mark duplicate egg locations in red for unlocking some of the new rabbits. - appable (https://github.com/hannibal002/SkyHanni/pull/1929)
+    + Option to always mark nearby duplicate egg locations.
++ Show total amount of chocolate spent in the Chocolate Shop. - sayomaki (https://github.com/hannibal002/SkyHanni/pull/1921)
 
 </details>
 <details open><summary>
@@ -1036,6 +1063,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + **/sendcoords** - dragon99z
     + Sending, detecting and rendering.
 + Dungeon Potion level as item stack size - HiZe
++ Dark Cacao Truffle hours held as stack size. - Obsidian (https://github.com/hannibal002/SkyHanni/pull/1916)
 + **Ender Node Tracker** - pretz
     + Tracks items and profit obtained from collecting ender nodes and killing normal endermen.
 + **Harp Keybinds** - NetheriteMiner
@@ -1144,6 +1172,7 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
   martimavocado (https://github.com/hannibal002/SkyHanni/pull/848)
     + Support for `/playtime` and  `/pt` while in Limbo.
     + Added your playtime to Hypixel's `/playtimedetailed`.
++ Option to toggle limbo time in detailed /playtime. - HiZe (https://github.com/hannibal002/SkyHanni/pull/1863)
 + Click on breakdown display in /playtimedetailed to copy the stats into the clipboard. - seraid (https://github.com/hannibal002/SkyHanni/pull/1807)
 + Custom Scoreboard - j10a1n15 (https://github.com/hannibal002/SkyHanni/pull/893)
     + Customizable; New, never seen before lines like the current mayor with perks, your party, and more!
@@ -1175,6 +1204,9 @@ Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
 + Simple Ferocity Display. - hannibal2 (https://github.com/hannibal002/SkyHanni/pull/1765)
     + Shows the Ferocity stat as a single GUI element.
     + Requires the Tab List widget to be enabled and Ferocity to be selected to work.
++ Editable Hotbar. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1903)
+    + Allows for moving and scaling in the SkyHanni GUI editor.
++ ULTRA RARE Book Notification when doing the Experiment Table. - raven (https://github.com/hannibal002/SkyHanni/pull/1738)
 
 </details>
 <details open><summary>