Merge remote-tracking branch 'upstream/beta' into stranded-npcs

# Conflicts:
#	src/main/java/at/hannibal2/skyhanni/SkyHanniMod.kt

.editorconfig

@@ -23,8 +23,10 @@ max_line_length = 120
 # Java files should not use wildcard imports
 ij_java_names_count_to_use_import_on_demand = 999
 ij_java_class_count_to_use_import_on_demand = 999
+ij_java_packages_to_use_import_on_demand =
 
 [*.kt]
 # Kotlin files should not use wildcard imports
 ij_kotlin_name_count_to_use_star_import = 999
 ij_kotlin_name_count_to_use_star_import_for_members = 999
+ij_kotlin_packages_to_use_import_on_demand =

.github/workflows/generate-constants.yaml

@@ -0,0 +1,62 @@
+# Read the Javadoc of RepoPatternDump for more info
+
+name: RepoPattern
+
+env:
+    data_repo: hannibal002/SkyHanni-REPO
+
+on:
+    push:
+    workflow_dispatch:
+
+permissions: { }
+
+jobs:
+    regexes:
+        runs-on: ubuntu-latest
+        name: "Generate regexes"
+        steps:
+            -   uses: actions/checkout@v3
+            -   name: Set up JDK 17
+                uses: actions/setup-java@v3
+                with:
+                    java-version: 17
+                    distribution: temurin
+                    cache: gradle
+            -   name: Setup gradle
+                uses: gradle/gradle-build-action@v2
+            -   name: Generate Repo Patterns using Gradle
+                run: |
+                    ./gradlew generateRepoPatterns --stacktrace
+            -   uses: actions/upload-artifact@v3
+                name: Upload generated repo regexes
+                with:
+                    name: Repo Regexes
+                    path: build/regexes/constants.json
+    publish-regexes:
+        runs-on: ubuntu-latest
+        needs: regexes
+        name: "Publish regexes"
+        if: ${{ 'push' == github.event_name && 'beta' == github.ref_name }}
+        steps:
+            -   uses: actions/checkout@v3
+                with:
+                    repository: ${{ env.data_repo }}
+                    branch: main
+            -   uses: actions/download-artifact@v3
+                name: Upload generated repo regexes
+                with:
+                    name: Repo Regexes
+            -   name: Commit generated regex
+                run: |
+                    mkdir -p constants/
+                    mv constants.json constants/regexes.json
+                    git config user.name 'github-actions[bot]'
+                    git config user.email '[email protected]'
+                    git add constants/regexes.json
+                    git commit -m "Update regexes based on https://github.com/hannibal002/Skyhanni/commit/$GITHUB_SHA"
+            -   name: Publish new repository
+                run: |
+                    git config --unset-all http.https://github.com/.extraheader
+                    git remote add restream https://user:${{secrets.REPO_PAT}}@github.com/${{env.data_repo}}
+                    git push restream HEAD:main

.github/workflows/label-merge-conflict.yml

@@ -4,7 +4,7 @@ on:
     push:
         branches: [ beta ]
     # So that the `dirtyLabel` is removed if conflicts are resolve
-    # We recommend `pull_request_target` so that github secrets are available.
+    # We recommend `pull_request_target` so that GitHub secrets are available.
     # In `pull_request` we wouldn't be able to change labels of fork PRs
     pull_request_target:
         types: [ opened, synchronize ]

.github/workflows/remove-labels-on-pr-close.yml

@@ -0,0 +1,16 @@
+# https://github.com/marketplace/actions/label-remover
+
+name: "Remove All Labels"
+
+on:
+    pull_request_target:
+        types: [closed]
+
+jobs:
+    remove_very_soon:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: rogerluan/[email protected]
+              with:
+                  github_token: ${{ secrets.github_token }}

CHANGELOG.md

@@ -13,7 +13,6 @@
 + Change how the pest spawn chat message should be formatted. - hannibal2
   + Unchanged, compact or hide the message entirely.
 + Show a Title when a pest spawns. - hannibal2
-+ Press a key to warp to the plot where the last pest has spawned. - hannibal2
 + Show the time since the last pest spawned in your garden. - hannibal2
   + Option to only show the time while holding vacuum in the hand.
 + Show the pests that are attracted when changing the selected material of the Sprayanator. - hannibal2
@@ -22,8 +21,11 @@
 + Show a display with all known pest locations. - hannibal2
   + Click to warp to the plot.
   + Option to only show the time while holding vacuum in the hand.
++ Mark the plots with pests on them in the world. - hannibal2
++ Press the key to warp to the nearest plot with pests on it. - hannibal2
++ Draw plot borders when holding the Sprayonator. - HiZe
 
-#### Other Features
+#### Fishing Features
 
 + Added Barn Fishing Timer to Jerry's Workshop and Crimson Isle. - martimavocado
 + Added Fishing Tracker and changed trackers in general. - hannibal2
@@ -37,21 +39,142 @@
   + Option to exclude hidden items in the total price calculation.
   + Option to change the display mode that gets shown on default: Total, Current or remember last.
 
-### Changes
+#### Winter Features
+
++ Added Unique Gifting Opportunities. - nea
+  + Highlight players who you haven't given gifts to yet.
+  + Only highlight ungifted players while holding a gift.
+  + Make use of armor stands to stop highlighting players. This is a bit inaccurate, but it can help with people you gifted before this feature was used.
++ Added Unique Gifted users counter. - hannibal2
+  + Show in a display how many unique players you have given gifts to in the winter 2023 event.
+  + Run command /opengenerowmenu to sync up.
+
+#### Bingo Features
+
++ Show the duration until the next hidden bingo goal tip gets revealed. - hannibal2
++ Added support for tips in hidden bingo card display. - hannibal2
++ Added support for 'found by' info in bingo card. - hannibal2
++ Added Bingo Goal Rank as stack size in Bingo Card. - Erymanthus
++ Added the option to only show tier 1 Minion Crafts in the Helper display when their items needed are fully collected. - hannibal2
++ Added the option to click in the bingo card viewer on goals to mark them as highlighted. - hannibal2
+  + If at least one goal is highlighted, non-highlighted goals will be hidden.
++ Send a chat message with the change of community goal percentages after opening the bingo card inventory. - hannibal2
+
+#### Inventory Features
+
++ Added bottle of Jyrre time overlay in stack size feature. - HiZe
++ Added show special edition number as stack size when below 1k. - hannibal2
+
+#### Minion Features
+
++ Shows how much skill experience you will get when picking up items from the minion storage. - Thunderblade73
+
+#### Chat Features
 
++ Hide the repeating fire sale reminder chat messages. - hannibal2
+
+
+#### Event Features
+
++ Added Waypoints for 2023 Lobby Presents. - walker
+
+### Changes
 
 #### Garden Changes
 
 + Added option to enable/disable the vacuum bag item number being capped to 40. - hannibal2
 + Automatic unlocking /shmouselock when teleporting in the garden. - hannibal2
 + Don't hide messages from Jacob. - alexia
   + This is a workaround for wrongly hidden Jakob messages.
++ Show the hint to open Configure Plot only if the pest display is incorrect. - hannibal2
++ Added the "plot" word to the sidebar again (only if there are no pests in garden). - hannibal2
++ Hide the Composter Overlay in composter inventory while the Estimated Item Value is visible. - hannibal2
++ Made the wording of "no pest spawned yet" message more clear. - hannibal2
++ Not only show the waypoint for infested plots, also show their waypoints in the world. - hannibal2
++ Use different colors in the tab list depending on the pest count. - alexia
++ Highlight the boosted crop contest in all Jacob's Contest displays. - alexia
++ Added Delicate 5 to visitor drop counter and visitor block refuse and highlighter. - hannibal2
++ Block visitor interaction for dedication cycling is now disabled by default. - hannibal2
++ Added an option to only warn for specific crop contests. - Obsidian
++ Added an option to show plot borders for a given number of seconds after holding a vacuum. - HiZe
++ Added command /shclearcontestdata to Reset Jacob's Contest Data. - martimavocado
+
+#### Fishing Changes
+
++ Show the fishing tracker for a couple of seconds after catching something even while moving. - hannibal2
+
+#### Winter Changes
+
++ Hiding Unique Gifted Players Highlighting for ironman and bingo while not on those modes. - Thunderblade73
+
+#### Chat Changes
+
++ Added fire sale messages in the hub to the chat message filter. - hannibal2
++ Added compact potion message support for splash messages and for Poisoned Candy I. - walker
++ Added "fire sale starting soon" message to fire sale chat hider. - hannibal2
+
+#### Bingo Changes
+
++ Option to remove the background difficulty color in the bingo card inventory when the goal is done. - hannibal2
++ Mark the background difficulty gray for unknown goals. - hannibal2
+  + This is no longer needed as all 20 hidden goals are known now, but we now have this support for the next extreme bingo with hidden goals.
++ Added the community goal percentage to the bingo card display. - hannibal2
++ Saving minion craft helper crafted tier 1 minions and bingo card goals per bingo session/month. - hannibal2
+
+#### Misc Changes
+
++ Titles sent by SkyHanni look better now. - Cad
++ Added support for show XP gained from wheat minion in hub. - Thunderblade73
 
 ### Fixes
 
 #### Garden Fixes
 
 + Fixed pest damage indicator not working for some pests. - hannibal2
++ Fixed pest kill detection. - hannibal2
++ Fixed /tp <plot name> not working with uppercase characters. - hannibal2
++ Fixed total equipment fortune in /ff. - alexia
++ Fixed Locust pest not getting detected in damage indicator. - hannibal2
++ Fixed Pest Spray Display showing outside the garden. - hannibal2
++ Fixed pest detection when more than 3 pests are spawned at once. - hannibal2
++ Fixed showing on the scoreboard  "garden outside" immediately after teleporting to a plot. - hannibal2
++ Fixed visitor timer counting down too fast sometimes. - hannibal2
++ Fixed Mooshroom cow Perk display not showing when maxed. - hannibal2
++ Show a text around the new year that the calendar is not loaded for the next Jacob Contest. - hannibal2
++ Fixed visitor reward item refuse inconsistencies. - hannibal2
++ Fixed wrong base 100ff calculations in the farming fortune needed display. - alexia
++ Fixed showing Sprayanator plot grid overlay outside garden. - HiZe
+
+#### Bingo Fixes
+
++ Hide the long hint line in the Bingo Goal Display. - hannibal2
++ Show community goals in the Bingo Display correctly. - hannibal2
++ Hide enchanted tools in Minion Craft Helper. - hannibal2
++ Opening the bingo card will no longer crash the game sometimes. Showing an error message instead. - hannibal2
+
+#### Minion Fixes
+
++ Fixed Minion XP display not showing sometimes. - Thunderblade73
++ Updating the Minion XP display when the minion picks up a new item while inside the inventory. - hannibal2
++ Fixed minion features disappear inside the minion inventory when picking up an item. - hannibal2
+
+#### Fishing Fixes
+
++ Fixed Water Hydra warning showing up multiple times. - Cad
+
+#### Misc Fixes
+
++ Fixed Item Tracker not ignoring manual sack movements. - hannibal2
++ Fixed showing yourself green with Unique Gifting Opportunities. - hannibal2
++ Fixed NPC messages getting detected as player messages. - CalMWolfs
++ Hide Scavenger 5 on an Ice Spray Wand and Replenish on an Advanced Gardening Hoe/Axe for the Estimated Item Value. - hannibal2
++ Fixed an error when the king talisman helper does not find the king in range. - hannibal2
++ Fixed control/modifier key logic on Apple devices. - walker
++ Fixed lag spikes when downloading updates. - nea
+
+#### Config Fixes
+
++ Fixed a typo in config. - walker
 
 ### Technical Details
 
@@ -60,6 +183,32 @@
 + Replaced SkyHanniMod.feature.garden with GardenAPI.config. - hannibal2
 + Added MessageSendToServerEvent. - hannibal2
 + Added GardenPlotAPI, support for detecting the current slot of the player. - hannibal2
++ Updated .editorconfig file to better support imports. - Thunderblade73
++ Migrate Integer to Enums in Config. - walker
++ Using a broken config no longer resets the config in dev env. - hannibal2
++ Auto-removing all labels of PRs on merging/closing. - hannibal2
++ Changed OwnInventoryItemUpdateEvent to be called synced to the main thread. - hannibal2
++ romanToDecimalIfNeeded -> romanToDecimalIfNecessary. - hannibal2
+  + For more context: https://chat.openai.com/share/502571b5-8851-4047-b343-3b1475ca8a88
++ Added the debug feature SkyHanni Event Counter. - hannibal2
++ Fix Consecutive Spaces in RegEx. - walker
++ No longer creating new regex pattern elements each time in DungeonDeathCounter. - walker
++ Changed DungeonChatFilter to use lists of patterns. - walker
++ Code cleanup in DungeonMilestoneDisplay. - walker
++ Code cleanup and removed .matchRegex() - walker
++ Misc pattern optimizations. - walker
++ Moving the bingo goal list into BingoAPI. - hannibal2
++ Created BingoGoalReachedEvent. - hannibal2
++ Created Matcher.groupOrNull. - walker
++ cleanPlayerName respects playerRankHider option now. - hannibal2
++ Replaced ItemWarnEntry with VisitorReward. This should fix some errors. - hannibal2
++ GardenNextJacobContest now uses SimpleTimeMark. SimpleTimeMark is storable in the config and comparable - hannibal2
++ No longer sending contest data to elite close to new year. - hannibal2
++ Added RepoPatterns. - nea
++ Use LorenzToolTipEvent over ItemTooltipEvent if possible. - hannibal2
++ Added an abstract error message on LorenzToolTipEvent error. - hannibal2
++ Added test command /shsendtitle - Cad
++ Saving bingo goal data into the config. - hannibal2
 
 ## Version 0.21.1
 

CONTRIBUTING.md

@@ -73,6 +73,8 @@ You can write in the description of the pr the wording for the changelog as well
 - Don't forget to add `@FeatureToggle` to new standalone features (not options to that feature) in the config.
 - 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()`, use `toPattern()` instead.
+- Please use Regex instead of String comparison when it is likely Hypixel will change the message in the future.
 
 ## Software Used in SkyHanni
 

DISCORD_FAQ.md

@@ -7,8 +7,8 @@ _Frequently Asked Questions_
 > To make the mod work, you need to use the latest version from <#1123201092193366027>.
 
 > **3: How can I resize the GUI?**
-> Do `/sh gui` to open the position editor. Then hover over a element and scroll your mouse wheel to change the size of a single gui element.
-> Do `/sh scale` to change the global gui scale of all elements at once.
+> Do `/sh gui` to open the position editor. Then hover over an element and scroll your mouse wheel to change the size of a single GUI element.
+> 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.
@@ -19,14 +19,19 @@ _Frequently Asked Questions_
 > **6: Will SkyHanni support Minecraft versions 1.19 or 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 should only take a couple of days, and we plan to discontinue support for 1.8.9 afterward since we won't support multiple versions at once.
+> 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.
 
-> **7: Does the barn fishing timer work on the Crimson Isle?**
-> No, the barn fishing timer is not supported in the Crimson Isle in Hypixel Skyblock because it would disrupt other fishers due to competition for the maximum sea creature cap, potentially leading to conflicts and stealing of sea creatures.
+> **7: My Jacob Contest Display crops are wrong, how do I fix this?**
+> 1. Close your minecraft.
+> 2. Delete ".minecraft\config\skyhanni\jacob_contests.json".
+> 3. Open minecraft.
 
-> **8: My Jacob Contest Display crops are wrong, how do I fix this?**
-> 1. Run the command `/shconfig reset config.storage.gardenJacobFarmingContestTimes`
-> 2. Restart the game
+> **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.
 
-*This FAQ was last updated on October 17th, 2023.
-If you believe there's something that should be added to this list, please tell us, so we can add it.*
+> **9: Why does my Item Tracker feature not track this item?**
+> Check if the item goes directly into your sacks. If it does, enable the sack pickup chat message from Hypixel.
+> You can use SkyHanni's own setting to still hide the message from chat.
+
+*This FAQ was last updated on December 08th, 2023.
+If you believe there's something that should be added to this list, please tell us, so we can add it.*