Feature: Gift Profit Tracker

src/main/java/at/hannibal2/skyhanni/config/features/event/EventConfig.java

@@ -3,6 +3,7 @@
 import at.hannibal2.skyhanni.config.features.event.bingo.BingoConfig;
 import at.hannibal2.skyhanni.config.features.event.carnival.CarnivalConfig;
 import at.hannibal2.skyhanni.config.features.event.diana.DianaConfig;
+import at.hannibal2.skyhanni.config.features.event.gifting.GiftingConfig;
 import at.hannibal2.skyhanni.config.features.event.hoppity.HoppityEggsConfig;
 import at.hannibal2.skyhanni.config.features.event.waypoints.LobbyWaypointsConfig;
 import at.hannibal2.skyhanni.config.features.event.winter.WinterConfig;
@@ -25,6 +26,10 @@ public class EventConfig {
     @Expose
     public WinterConfig winter = new WinterConfig();
 
+    @Category(name = "Gifting", desc = "Giving and receiving gifts")
+    @Expose
+    public GiftingConfig gifting = new GiftingConfig();
+
     @Expose
     @Category(name = "Hoppity Eggs", desc = "Features for the Hoppity event that happens every SkyBlock spring.")
     public HoppityEggsConfig hoppityEggs = new HoppityEggsConfig();

src/main/java/at/hannibal2/skyhanni/config/features/event/gifting/GiftTrackerConfig.kt

@@ -0,0 +1,32 @@
+package at.hannibal2.skyhanni.config.features.event.gifting
+
+import at.hannibal2.skyhanni.config.core.config.Position
+import com.google.gson.annotations.Expose
+import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorBoolean
+import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorInfoText
+import io.github.notenoughupdates.moulconfig.annotations.ConfigLink
+import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
+
+class GiftTrackerConfig {
+    @Expose
+    @ConfigOption(name = "Enabled", desc = "Enable the gift profit tracker.")
+    @ConfigEditorBoolean
+    var enabled: Boolean = false
+
+    @ConfigOption(
+        name = "§cNote",
+        desc = "§cDue to the complexities of gifts leaving and re-entering the inventory or stash, gift usage is not auto-tracked. " +
+            "§cUse §e/shaddusedgifts §cto manually add gifts used."
+    )
+    @ConfigEditorInfoText
+    var note: String = ""
+
+    @Expose
+    @ConfigOption(name = "Holding Gift", desc = "Only show the tracker while holding a gift.")
+    @ConfigEditorBoolean
+    var holdingGift: Boolean = false
+
+    @Expose
+    @ConfigLink(owner = GiftTrackerConfig::class, field = "enabled")
+    var position: Position = Position(-274, 0)
+}

src/main/java/at/hannibal2/skyhanni/config/features/event/gifting/GiftingConfig.kt

@@ -0,0 +1,24 @@
+package at.hannibal2.skyhanni.config.features.event.gifting
+
+import at.hannibal2.skyhanni.config.features.event.winter.GiftingOpportunitiesConfig
+import at.hannibal2.skyhanni.config.features.event.winter.UniqueGiftConfig
+import com.google.gson.annotations.Expose
+import io.github.notenoughupdates.moulconfig.annotations.Accordion
+import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
+
+class GiftingConfig {
+    @Expose
+    @ConfigOption(name = "Gift Profit Tracker", desc = "")
+    @Accordion
+    var giftProfitTracker: GiftTrackerConfig = GiftTrackerConfig()
+
+    @Expose
+    @ConfigOption(name = "Unique Gifting Opportunities", desc = "Highlight players who you haven't given gifts to yet.")
+    @Accordion
+    var giftingOpportunities: GiftingOpportunitiesConfig = GiftingOpportunitiesConfig()
+
+    @Expose
+    @ConfigOption(name = "Unique Gift Counter", desc = "Keep track of how many unique players you have given gifts to.")
+    @Accordion
+    var uniqueGiftCounter: UniqueGiftConfig = UniqueGiftConfig()
+}

src/main/java/at/hannibal2/skyhanni/config/features/event/winter/WinterConfig.java

@@ -15,16 +15,6 @@ public class WinterConfig {
     @Accordion
     public FrozenTreasureConfig frozenTreasureTracker = new FrozenTreasureConfig();
 
-    @Accordion
-    @Expose
-    @ConfigOption(name = "Unique Gifting Opportunities", desc = "Highlight players who you haven't given gifts to yet.")
-    public GiftingOpportunitiesConfig giftingOpportunities = new GiftingOpportunitiesConfig();
-
-    @Accordion
-    @Expose
-    @ConfigOption(name = "Unique Gift Counter", desc = "Keep track of how many unique players you have given gifts to.")
-    public UniqueGiftConfig uniqueGiftCounter = new UniqueGiftConfig();
-
     @Accordion
     @Expose
     @ConfigOption(name = "Refined Bottle of Jyrre Timer", desc = "")

src/main/java/at/hannibal2/skyhanni/config/storage/ProfileSpecificStorage.kt

@@ -33,6 +33,7 @@ import at.hannibal2.skyhanni.features.garden.fortuneguide.FarmingItems
 import at.hannibal2.skyhanni.features.garden.pests.PestProfitTracker
 import at.hannibal2.skyhanni.features.garden.pests.VinylType
 import at.hannibal2.skyhanni.features.garden.visitor.VisitorReward
+import at.hannibal2.skyhanni.features.gifting.GiftProfitTracker
 import at.hannibal2.skyhanni.features.inventory.chocolatefactory.ChocolateFactoryStrayTracker
 import at.hannibal2.skyhanni.features.inventory.experimentationtable.ExperimentsProfitTracker
 import at.hannibal2.skyhanni.features.inventory.wardrobe.WardrobeApi.WardrobeData
@@ -172,6 +173,9 @@ class ProfileSpecificStorage {
     @Expose
     var frozenTreasureTracker: FrozenTreasureTracker.Data = FrozenTreasureTracker.Data()
 
+    @Expose
+    var giftProfitTracker: GiftProfitTracker.Data = GiftProfitTracker.Data()
+
     // -- hoppity
     @Expose
     var chocolateFactory: ChocolateFactoryStorage = ChocolateFactoryStorage()

src/main/java/at/hannibal2/skyhanni/features/chat/ChatFilter.kt

@@ -10,6 +10,7 @@ import at.hannibal2.skyhanni.features.chat.PowderMiningChatFilter.genericMiningR
 import at.hannibal2.skyhanni.features.dungeon.DungeonApi
 import at.hannibal2.skyhanni.features.garden.GardenApi
 import at.hannibal2.skyhanni.features.garden.pests.PestApi
+import at.hannibal2.skyhanni.features.gifting.GiftProfitTracker
 import at.hannibal2.skyhanni.skyhannimodule.SkyHanniModule
 import at.hannibal2.skyhanni.utils.LorenzUtils
 import at.hannibal2.skyhanni.utils.RegexUtils.groupOrEmpty
@@ -313,37 +314,19 @@ object ChatFilter {
     )
 
     // Winter Gift
-    private val winterGiftPatterns = listOf(
-        // winter gifts useless
-        "§f§lCOMMON! §r§3.* XP §r§egift with §r.*§r§e!".toPattern(),
-        "(§f§lCOMMON|§9§lRARE)! §r.* XP Boost .* Potion §r.*§r§e!".toPattern(),
-        "(§f§lCOMMON|§9§lRARE)! §r§6.* coins §r§egift with §r.*§r§e!".toPattern(),
-
-        // enchanted book
-        "§9§lRARE! §r§9Scavenger IV §r§egift with §r.*§r§e!".toPattern(),
-        "§9§lRARE! §r§9Looting IV §r§egift with §r.*§r§e!".toPattern(),
-        "§9§lRARE! §r§9Luck VI §r§egift with §r.*§r§e!".toPattern(),
-
-        // minion skin
-        "§e§lSWEET! §r§f(Grinch|Santa|Gingerbread Man) Minion Skin §r§egift with §r.*§r§e!".toPattern(),
-
-        // rune
-        "§9§lRARE! §r§f◆ Ice Rune §r§egift with §r.*§r§e!".toPattern(),
-
-        // furniture
-        "§e§lSWEET! §r§fTall Holiday Tree §r§egift with §r.*§r§e!".toPattern(),
-        "§e§lSWEET! §r§fNutcracker §r§egift with §r.*§r§e!".toPattern(),
-        "§e§lSWEET! §r§fPresent Stack §r§egift with §r.*§r§e!".toPattern(),
-
-        "§e§lSWEET! §r§9(Winter|Battle) Disc §r§egift with §r.*§r§e!".toPattern(),
-
-        // winter gifts a bit useful
-        "§e§lSWEET! §r§9Winter Sack §r§egift with §r.*§r§e!".toPattern(),
-        "§e§lSWEET! §r§5Snow Suit .* §r§egift with §r.*§r§e!".toPattern(),
-
-        // winter gifts not your gifts
-        "§cThis gift is for §r.*§r§c, sorry!".toPattern(),
-    )
+    private val winterGiftPatterns = buildList {
+        GiftProfitTracker.run {
+            listOf(
+                xpGainedPattern,
+                coinsGainedPattern,
+                northStarsPattern,
+                boostPotionPattern,
+                enchantmentBookPattern,
+                genericRewardPattern
+            ).forEach { add(it) }
+        }
+        addAll(GiftProfitTracker.spamPatterns)
+    }
 
     private val fireSalePattern by RepoPattern.pattern(
         "chat.firesale",

src/main/java/at/hannibal2/skyhanni/features/gifting/GiftApi.kt

@@ -0,0 +1,40 @@
+package at.hannibal2.skyhanni.features.gifting
+
+import at.hannibal2.skyhanni.api.event.HandleEvent
+import at.hannibal2.skyhanni.events.ItemInHandChangeEvent
+import at.hannibal2.skyhanni.events.minecraft.WorldChangeEvent
+import at.hannibal2.skyhanni.skyhannimodule.SkyHanniModule
+import at.hannibal2.skyhanni.utils.InventoryUtils
+import at.hannibal2.skyhanni.utils.LorenzUtils
+import at.hannibal2.skyhanni.utils.RegexUtils.matches
+import at.hannibal2.skyhanni.utils.repopatterns.RepoPattern
+
+@SkyHanniModule
+object GiftApi {
+
+    private val patternGroup = RepoPattern.group("event.winter.giftapi")
+
+    /**
+     * REGEX-TEST: WHITE_GIFT
+     * REGEX-TEST: RED_GIFT
+     * REGEX-TEST: GREEN_GIFT
+     */
+    private val giftNamePattern by patternGroup.pattern(
+        "giftname",
+        "(?:WHITE|RED|GREEN)_GIFT\$",
+    )
+
+    private var holdingGift = false
+
+    fun isHoldingGift() = LorenzUtils.inSkyBlock && holdingGift
+
+    @HandleEvent
+    fun onWorldChange(event: WorldChangeEvent) {
+        holdingGift = false
+    }
+
+    @HandleEvent(onlyOnSkyblock = true)
+    fun onItemInHandChange(event: ItemInHandChangeEvent) {
+        holdingGift = giftNamePattern.matches(InventoryUtils.itemInHandId.asString())
+    }
+}