Feature: Crystal Nucleus Tracker, Profit-Per, and Filter

src/main/java/at/hannibal2/skyhanni/config/features/chat/CrystalNucleusConfig.kt

@@ -0,0 +1,49 @@
+package at.hannibal2.skyhanni.config.features.chat
+
+import at.hannibal2.skyhanni.config.FeatureToggle
+import com.google.gson.annotations.Expose
+import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorBoolean
+import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorDraggableList
+import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
+import java.util.*
+
+class CrystalNucleusConfig {
+    @Expose
+    @ConfigOption(
+        name = "Enabled",
+        desc = "Hide or compact messages relating to Crystal Nucleus runs in the Crystal Hollows.",
+    )
+    @ConfigEditorBoolean
+    @FeatureToggle
+    var enabled: Boolean = false
+
+    enum class CrystalNucleusMessageTypes(val displayName: String) {
+        RUN_COMPLETED("§5Run Completed Summary"),
+        CRYSTAL_COLLECTED("§aC§6r§dy§bs§et§aa§6l §7Collected"),
+        CRYSTAL_PLACED("§aC§6r§dy§bs§et§aa§6l §7Placed"),
+        NPC_DIVAN_KEEPERS("§e[NPC] §6Keepers §7(§2Mines of Divan§7)"),
+        NPC_PROF_ROBOT("§e[NPC] Professor Robot"),
+        NPC_KING_YOLKAR("§e[NPC] §6King Yolkar"),
+        NPC_GOBLIN_GUARDS("§c[GUARD]§7s (§6Goblin Den§7)"),
+        NON_TOOL_SCAVENGE("§7Non-Tool §cMetal Detector §7loot");
+
+        override fun toString() = displayName
+    }
+
+    @Expose
+    @ConfigOption(
+        name = "Modified Messages",
+        desc = "Messages that should be hidden or compacted.\n§cImportant information will still appear§7.",
+    )
+    @ConfigEditorDraggableList
+    var modifiedMessages: List<CrystalNucleusMessageTypes> = mutableListOf(
+        CrystalNucleusMessageTypes.CRYSTAL_COLLECTED,
+        CrystalNucleusMessageTypes.CRYSTAL_PLACED,
+        CrystalNucleusMessageTypes.RUN_COMPLETED,
+        CrystalNucleusMessageTypes.NPC_DIVAN_KEEPERS,
+        CrystalNucleusMessageTypes.NPC_PROF_ROBOT,
+        CrystalNucleusMessageTypes.NPC_KING_YOLKAR,
+        CrystalNucleusMessageTypes.NPC_GOBLIN_GUARDS,
+        CrystalNucleusMessageTypes.NON_TOOL_SCAVENGE,
+    )
+}

src/main/java/at/hannibal2/skyhanni/config/features/chat/FilterTypesConfig.kt

@@ -10,7 +10,12 @@ class FilterTypesConfig {
     @Expose
     @ConfigOption(name = "Powder Mining", desc = "")
     @Accordion
-    var powderMiningFilter: PowderMiningFilterConfig = PowderMiningFilterConfig()
+    var powderMining: PowderMiningConfig = PowderMiningConfig()
+
+    @Expose
+    @ConfigOption(name = "Crystal Nucleus", desc = "")
+    @Accordion
+    var crystalNucleus: CrystalNucleusConfig = CrystalNucleusConfig()
 
     @Expose
     @ConfigOption(name = "Stash Messages", desc = "")

src/main/java/at/hannibal2/skyhanni/config/features/chat/PowderMiningFilterConfig.kt → src/main/java/at/hannibal2/skyhanni/config/features/chat/PowderMiningConfig.kt

@@ -9,7 +9,7 @@ import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorDropdown
 import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorSlider
 import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
 
-class PowderMiningFilterConfig {
+class PowderMiningConfig {
     @Expose
     @ConfigOption(name = "Enabled", desc = "Hide messages while opening chests in the Crystal Hollows.")
     @ConfigEditorBoolean
@@ -24,7 +24,7 @@ class PowderMiningFilterConfig {
             "§c60000§7: §cHide all"
     )
     @ConfigEditorSlider(minValue = 0f, maxValue = 60000f, minStep = 500f)
-    var powderFilterThreshold: Int = 1000
+    var powderThreshold: Int = 1000
 
     @Expose
     @ConfigOption(
@@ -34,9 +34,9 @@ class PowderMiningFilterConfig {
             "§c20§7: §cHide all"
     )
     @ConfigEditorSlider(minValue = 0f, maxValue = 20f, minStep = 1f)
-    var essenceFilterThreshold: Int = 5
+    var essenceThreshold: Int = 5
 
-    enum class SimplePowderMiningRewardTypes(private val displayName: String) {
+    enum class SimplePowderMiningRewardTypes(val displayName: String) {
         ASCENSION_ROPE("§9Ascension Rope"),
         WISHING_COMPASS("§aWishing Compass"),
         OIL_BARREL("§aOil Barrel"),
@@ -68,9 +68,9 @@ class PowderMiningFilterConfig {
     @Expose
     @ConfigOption(name = "Goblin Egg", desc = "Hide Goblin Egg rewards that are below a certain rarity.")
     @ConfigEditorDropdown
-    var goblinEggs: GoblinEggFilterEntry = GoblinEggFilterEntry.YELLOW_UP
+    var goblinEggs: GoblinEggEntry = GoblinEggEntry.YELLOW_UP
 
-    enum class GoblinEggFilterEntry(private val displayName: String) {
+    enum class GoblinEggEntry(val displayName: String) {
         SHOW_ALL("Show all"),
         HIDE_ALL("Hide all"),
         GREEN_UP("Show §aGreen §7and up"),
@@ -81,9 +81,8 @@ class PowderMiningFilterConfig {
         override fun toString() = displayName
     }
 
-    // TODO rename to "gemstoneFilter" (addressed in #2285)
     @Expose
     @ConfigOption(name = "Gemstones", desc = "")
     @Accordion
-    var gemstoneFilterConfig: PowderMiningGemstoneFilterConfig = PowderMiningGemstoneFilterConfig()
+    var gemstone: PowderMiningGemstoneConfig = PowderMiningGemstoneConfig()
 }

src/main/java/at/hannibal2/skyhanni/config/features/chat/PowderMiningGemstoneFilterConfig.kt → src/main/java/at/hannibal2/skyhanni/config/features/chat/PowderMiningGemstoneConfig.kt

@@ -5,7 +5,7 @@ import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorBoolean
 import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorDropdown
 import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
 
-class PowderMiningGemstoneFilterConfig {
+class PowderMiningGemstoneConfig {
     @Expose
     @ConfigOption(name = "Stronger Tool Messages", desc = "Hide 'You need a stronger tool..' messages.")
     @ConfigEditorBoolean

src/main/java/at/hannibal2/skyhanni/config/features/mining/MiningConfig.java

@@ -11,6 +11,7 @@
 import at.hannibal2.skyhanni.config.features.mining.glacite.TunnelMapsConfig;
 import at.hannibal2.skyhanni.config.features.mining.nucleus.AreaWallsConfig;
 import at.hannibal2.skyhanni.config.features.mining.nucleus.CrystalHighlighterConfig;
+import at.hannibal2.skyhanni.config.features.mining.nucleus.CrystalNucleusTrackerConfig;
 import at.hannibal2.skyhanni.config.features.mining.nucleus.PowderTrackerConfig;
 import com.google.gson.annotations.Expose;
 import io.github.notenoughupdates.moulconfig.annotations.Accordion;
@@ -49,6 +50,11 @@ public class MiningConfig {
     @Accordion
     public AreaWallsConfig crystalHollowsAreaWalls = new AreaWallsConfig();
 
+    @Expose
+    @ConfigOption(name = "Crystal Nucleus Tracker", desc = "")
+    @Accordion
+    public CrystalNucleusTrackerConfig crystalNucleusTracker = new CrystalNucleusTrackerConfig();
+
     @Expose
     @ConfigOption(name = "Cold Overlay", desc = "")
     @Accordion

src/main/java/at/hannibal2/skyhanni/config/features/mining/nucleus/CrystalNucleusTrackerConfig.kt

@@ -0,0 +1,54 @@
+package at.hannibal2.skyhanni.config.features.mining.nucleus
+
+import at.hannibal2.skyhanni.config.FeatureToggle
+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.ConfigEditorDropdown
+import io.github.notenoughupdates.moulconfig.annotations.ConfigEditorSlider
+import io.github.notenoughupdates.moulconfig.annotations.ConfigLink
+import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
+import io.github.notenoughupdates.moulconfig.observer.Property
+
+class CrystalNucleusTrackerConfig {
+    @Expose
+    @ConfigOption(name = "Enabled", desc = "Enable the Crystal Nucleus Tracker overlay.")
+    @ConfigEditorBoolean
+    @FeatureToggle
+    var enabled: Boolean = false
+
+    @Expose
+    @ConfigLink(owner = CrystalNucleusTrackerConfig::class, field = "enabled")
+    var position: Position = Position(20, 20, false, true)
+
+    @Expose
+    @ConfigOption(name = "Show Outside of Nucleus", desc = "Show the tracker anywhere in the Crystal Hollows.")
+    @ConfigEditorBoolean
+    var showOutsideNucleus: Boolean = false
+
+    @Expose
+    @ConfigOption(name = "Profit Per", desc = "Show profit summary message for the completed nucleus run.")
+    @ConfigEditorBoolean
+    var profitPer: Boolean = true
+
+    @Expose
+    @ConfigOption(
+        name = "Profit Per Minimum",
+        desc = "Only show items above this coin amount in the summary message hover.",
+    )
+    @ConfigEditorSlider(minValue = 0f, maxValue = 1000000f, minStep = 5000f)
+    var profitPerMinimum: Int = 20000
+
+    @Expose
+    @ConfigOption(name = "Professor Usage", desc = "Determine how cost for Sapphire Crystal is calculated.")
+    @ConfigEditorDropdown
+    var professorUsage: Property<ProfessorUsageType> = Property.of(ProfessorUsageType.ROBOT_PARTS)
+
+    enum class ProfessorUsageType(private val displayName: String) {
+        ROBOT_PARTS("§9Robot Parts"),
+        PRECURSOR_APPARATUS("§5Precursor Apparatus"),
+        ;
+
+        override fun toString(): String = displayName
+    }
+}

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

@@ -37,8 +37,9 @@ import at.hannibal2.skyhanni.features.inventory.chocolatefactory.ChocolateFactor
 import at.hannibal2.skyhanni.features.inventory.experimentationtable.ExperimentsProfitTracker
 import at.hannibal2.skyhanni.features.inventory.wardrobe.WardrobeApi.WardrobeData
 import at.hannibal2.skyhanni.features.mining.MineshaftPityDisplay.PityData
+import at.hannibal2.skyhanni.features.mining.crystalhollows.CrystalNucleusTracker
 import at.hannibal2.skyhanni.features.mining.fossilexcavator.ExcavatorProfitTracker
-import at.hannibal2.skyhanni.features.mining.glacitemineshaft.CorpseTracker.BucketData
+import at.hannibal2.skyhanni.features.mining.glacitemineshaft.CorpseTracker
 import at.hannibal2.skyhanni.features.mining.powdertracker.PowderTracker
 import at.hannibal2.skyhanni.features.misc.DraconicSacrificeTracker
 import at.hannibal2.skyhanni.features.misc.EnchantedClockHelper
@@ -600,8 +601,11 @@ class ProfileSpecificStorage {
             var blocksBroken: MutableList<PityData> = mutableListOf()
 
             @Expose
-            var corpseProfitTracker: BucketData = BucketData()
+            var corpseProfitTracker: CorpseTracker.BucketData = CorpseTracker.BucketData()
         }
+
+        @Expose
+        var crystalNucleusTracker: CrystalNucleusTracker.Data = CrystalNucleusTracker.Data()
     }
 
     @Expose

src/main/java/at/hannibal2/skyhanni/events/mining/CrystalNucleusLootEvent.kt

@@ -0,0 +1,6 @@
+package at.hannibal2.skyhanni.events.mining
+
+import at.hannibal2.skyhanni.api.event.SkyHanniEvent
+import at.hannibal2.skyhanni.utils.NeuInternalName
+
+class CrystalNucleusLootEvent(val loot: Map<NeuInternalName, Int>) : SkyHanniEvent()

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

@@ -520,7 +520,8 @@ object ChatFilter {
     @HandleEvent
     fun onChat(event: SkyHanniChatEvent) {
         var blockReason = block(event.message)
-        if (blockReason == null && config.powderMiningFilter.enabled) blockReason = powderMiningBlock(event)
+        if (blockReason == null && config.powderMining.enabled) blockReason = powderMiningBlock(event)
+        if (blockReason == null && config.crystalNucleus.enabled) blockReason = crystalNucleusBlock(event)
 
         event.blockedReason = blockReason ?: return
     }
@@ -587,6 +588,20 @@ object ChatFilter {
         return powderMiningMatchResult
     }
 
+    /**
+     * Checks if the message is a blocked Crystal Nucleus Run message, as defined in CrystalNucleusChatFilter.
+     * Will conditionally modify/compact messages in some cases, or return a blocking code
+     * @param event The event to check
+     * @return Block reason if applicable
+     * @see block
+     */
+    private fun crystalNucleusBlock(event: SkyHanniChatEvent): String? {
+        val (blockCode, newMessage) = CrystalNucleusChatFilter.block(event.message)?.getPair() ?: Pair(null, null)
+        newMessage?.let { event.chatComponent = ChatComponentText(it) }
+        blockCode?.let { return it }
+        return null
+    }
+
     private var othersMsg: String? = null
 
     /**
@@ -651,5 +666,7 @@ object ChatFilter {
                 }
             }
         }
+        event.move(61, "chat.filterType.powderMiningFilter", "chat.filterType.powderMining")
+        event.move(61, "chat.filterType.gemstoneFilterConfig", "chat.filterType.powderMining.gemstone")
     }
 }