Feature: Croesus Profit Overlay

src/main/java/at/hannibal2/skyhanni/config/features/combat/InstanceChestProfitConfig.kt

@@ -10,6 +10,7 @@ import io.github.notenoughupdates.moulconfig.annotations.ConfigLink
 import io.github.notenoughupdates.moulconfig.annotations.ConfigOption
 
 class InstanceChestProfitConfig {
+    // TODO since this feature toggle no longer enables the whole category, it should be renamed
     @Expose
     @ConfigOption(name = "Instance Chest Profit", desc = "Display chest profit for dungeons and kuudra.")
     @ConfigEditorBoolean
@@ -27,4 +28,23 @@ class InstanceChestProfitConfig {
     @Expose
     @ConfigLink(owner = InstanceChestProfitConfig::class, field = "enabled")
     val position: Position = Position(107, 141)
+
+    @Expose
+    @ConfigOption(name = "Croesus Chest Price Overlay", desc = "Display each chests' profit for Dungeons and Kuudra.")
+    @ConfigEditorBoolean
+    @FeatureToggle
+    var croesusEnabled: Boolean = false
+
+    @Expose
+    @ConfigOption(
+        name = "Croesus Chest Highlight",
+        desc = "Highlights most profitable chest for Dungeons and Kuudra.\n §4THIS RELIES ON CROESUS OVERLAY.",
+    )
+    @ConfigEditorBoolean
+    @FeatureToggle
+    var croesusHighlight: Boolean = true
+
+    @Expose
+    @ConfigLink(owner = InstanceChestProfitConfig::class, field = "croesusEnabled")
+    val croesusPosition: Position = Position(107, 141)
 }

src/main/java/at/hannibal2/skyhanni/features/combat/InstanceChestProfit.kt

@@ -1,8 +1,10 @@
 package at.hannibal2.skyhanni.features.combat
 
 import at.hannibal2.skyhanni.SkyHanniMod
+import at.hannibal2.skyhanni.api.enoughupdates.ItemResolutionQuery
 import at.hannibal2.skyhanni.api.event.HandleEvent
 import at.hannibal2.skyhanni.data.ProfileStorageData
+import at.hannibal2.skyhanni.events.GuiContainerEvent
 import at.hannibal2.skyhanni.events.GuiRenderEvent
 import at.hannibal2.skyhanni.events.InventoryCloseEvent
 import at.hannibal2.skyhanni.events.InventoryFullyOpenedEvent
@@ -11,19 +13,27 @@
 import at.hannibal2.skyhanni.features.nether.kuudra.KuudraApi
 import at.hannibal2.skyhanni.skyhannimodule.SkyHanniModule
 import at.hannibal2.skyhanni.utils.ItemPriceUtils.formatCoin
-import at.hannibal2.skyhanni.utils.ItemPriceUtils.getPriceOrNull
+import at.hannibal2.skyhanni.utils.ItemPriceUtils.getPrice
 import at.hannibal2.skyhanni.utils.ItemPriceUtils.getRawCraftCostOrNull
+import at.hannibal2.skyhanni.utils.ItemUtils
 import at.hannibal2.skyhanni.utils.ItemUtils.getInternalName
 import at.hannibal2.skyhanni.utils.ItemUtils.getInternalNameOrNull
 import at.hannibal2.skyhanni.utils.ItemUtils.getLore
 import at.hannibal2.skyhanni.utils.ItemUtils.repoItemName
+import at.hannibal2.skyhanni.utils.LorenzColor
 import at.hannibal2.skyhanni.utils.LorenzRarity
 import at.hannibal2.skyhanni.utils.NeuInternalName
+import at.hannibal2.skyhanni.utils.NeuInternalName.Companion.MISSING_ITEM
+import at.hannibal2.skyhanni.utils.NeuInternalName.Companion.toInternalName
 import at.hannibal2.skyhanni.utils.NumberUtil.formatInt
 import at.hannibal2.skyhanni.utils.PetUtils
+import at.hannibal2.skyhanni.utils.RegexUtils.groupOrNull
 import at.hannibal2.skyhanni.utils.RegexUtils.matchMatcher
+import at.hannibal2.skyhanni.utils.RegexUtils.matches
+import at.hannibal2.skyhanni.utils.RenderUtils.highlight
 import at.hannibal2.skyhanni.utils.RenderUtils.renderRenderable
 import at.hannibal2.skyhanni.utils.collection.CollectionUtils.addOrPut
+import at.hannibal2.skyhanni.utils.collection.CollectionUtils.toSingletonListOrEmpty
 import at.hannibal2.skyhanni.utils.renderables.Renderable
 import at.hannibal2.skyhanni.utils.renderables.container.table.TableRenderable.Companion.table
 import at.hannibal2.skyhanni.utils.renderables.primitives.emptyText
@@ -81,11 +91,89 @@
         "§.\\w+ Kuudra Key",
     )
 
+    /**
+     * REGEX-TEST: Master Catacombs - Floor II
+     * REGEX-TEST: Catacombs - Floor V
+     * REGEX-TEST: Kuudra - Infernal
+     */
+    private val runNameCroesus by patternGroup.pattern(
+        "runname",
+        ".*Catacombs - Flo.*|Kuudra - .*",
+    )
+
+    /**
+     * REGEX-TEST: §6Paid Chest
+     * REGEX-TEST: §6Paid
+     * REGEX-TEST: §fFree Chest
+     * REGEX-TEST: §fFree
+     */
+    /* Dungeon chests are just the chest Type for example just 'Emerald', Kuudra CURRENTLY has them as Free Chest/Paid Chest in the same UI
+    if the Croesus main UI shows just Paid/Free this regex pattern should be removable mainly
+    if the Croesus UI starts showing like "Emerald Chest" as the Chest Name the Regex should include all the cata chest names too then. */
+    private val chestFutureProofing by patternGroup.pattern(
+        "kuudrachest",
+        "§.(?<chestname>Free|Paid)(?: Chest)?",
+    )
+
+    /**
+     * REGEX-TEST: §61,000,000 Coins
+     * REGEX-TEST: §aFREE
+     * REGEX-TEST: §6250,000 Coins
+     */
+    private val chestCostCroesus by patternGroup.pattern(
+        "croesuscost",
+        "§6(?<amount>.*) Coins|§aFREE",
+    )
+
+    /**
+     * REGEX-TEST: §aAlready opened!'
+     */
+    private val alreadyOpened by patternGroup.pattern(
+        "alreadyopened",
+        "§aAlready opened!",
+    )
+
+    /**
+     * REGEX-TEST: §d§lUltimate Wise I§f
+     * REGEX-TEST: §d§lCombo I§f
+     */
+    private val bookColorFixer by patternGroup.pattern(
+        "bookcolorfix",
+        "(?<item>.+)(?:§.)+",
+    )
+
     private val config get() = SkyHanniMod.feature.combat.instanceChestProfit
 
+    // TODO replace those three "in chest" booleans with inventory detectors
     private var inDungeonChest = false
     private var inKuudraChest = false
-    private var display: Renderable? = null
+    private var inCroesusRunMenu = false
+    private var chestDisplay: Renderable? = null
+    private var croesusDisplay: Renderable? = null
+    private val croesusDisplayList = mutableListOf<List<Renderable>>()
+    private var slotToHighlight = Pair(-1, 0.0)
+
+    enum class CroesusChestType(val stackChestName: String) {
+        WOOD("§fWood"),
+        GOLD("§6Gold"),
+        DIAMOND("§bDiamond"),
+        EMERALD("§2Emerald"),
+        OBSIDIAN("§5Obsidian"),
+        BEDROCK("§8Bedrock"),
+        FREE("§fFree"),
+        PAID("§6Paid"),
+        ;
+
+        companion object {
+            fun getByStackName(stackName: String): CroesusChestType? {
+                var newStackName = stackName
+                chestFutureProofing.matchMatcher(stackName) {
+                    newStackName = group("chestname")
+                }
+                return entries.firstOrNull { it.stackChestName == newStackName }
+            }
+        }
+    }
 
     @HandleEvent
     fun onInventoryOpen(event: InventoryFullyOpenedEvent) {
@@ -101,38 +189,132 @@
                 inKuudraChest = true
             }
 
+            runNameCroesus.matches(name) -> inCroesusRunMenu = true
+
             else -> return
         }
+        inCroesusRunMenu = true
+
+        event.inventoryItems.forEach {
+            val chestType = CroesusChestType.getByStackName(it.value.displayName)
+            if (chestType != null) parseCroesusChest(it.value, chestType, it.key)
+        }
+
+        createCroesusDisplay()
 
         createDisplay(event.inventoryItems)
     }
 
+    @HandleEvent(priority = HandleEvent.LOWEST, onlyOnSkyblock = true)
+    fun onBackgroundDrawn(event: GuiContainerEvent.BackgroundDrawnEvent) {
+        if (inCroesusRunMenu && slotToHighlight.first != -1 && config.croesusHighlight) {
+            event.container.inventorySlots[slotToHighlight.first].highlight(LorenzColor.GREEN)
+        }
+    }
+
     @HandleEvent(InventoryCloseEvent::class)
     fun onInventoryClose() {
         inDungeonChest = false
         inKuudraChest = false
+        inCroesusRunMenu = false
+        croesusDisplayList.clear()
+        slotToHighlight = Pair(-1, 0.0)
+        croesusDisplay = null
+    }
+
+    private fun parseCroesusChest(itemStack: ItemStack?, chestType: CroesusChestType, slot: Int) {
+        val chestList = mutableListOf<NeuInternalName>()
+        val chestTipsRenderables = mutableListOf<Renderable>()
+        chestTipsRenderables.add(Renderable.text("${chestType.stackChestName}:"))
+        var totalPrice = 0.0
+        var cost = 0.0
+        itemStack?.getLore()?.forEach { loreLine ->
+            if (alreadyOpened.matches(loreLine)) return
+            var itemPrice: Double
+            var itemName = ItemUtils.readBookType(loreLine) ?: loreLine
+            var itemInternalName = NeuInternalName.fromItemName(itemName)
+            bookColorFixer.matchMatcher(itemName) {
+                itemName = ItemResolutionQuery.resolveEnchantmentByName(group("item")) ?: itemName
+                itemInternalName = itemName.toInternalName()
+            }
+            if (itemInternalName != MISSING_ITEM) {
+                itemPrice = itemInternalName.getPrice(config.priceSource)
+                essencePattern.matchMatcher(loreLine) {
+                    itemPrice = getEssence(group("name"), group("count").toInt())
+                }
+                if (dungeonChestKey.matches(loreLine)) {
+                    cost += itemInternalName.getPrice(config.priceSource).times(-1)
+                    itemPrice = -1.0
+                }
+                if (itemPrice != -1.0) {
+                    chestTipsRenderables.add(Renderable.text(" ${itemInternalName.repoItemName}: ${itemPrice.formatCoin()} "))
+                    totalPrice += itemPrice
+                    chestList.add(itemInternalName)
+                }
+                kuudraChestKey.matchMatcher(loreLine) {
+                    cost += itemInternalName.getRawCraftCostOrNull(config.priceSource)?.times(-1) ?: 0.0
+                }
+            }
+            chestCostCroesus.matchMatcher(loreLine) {
+                cost += groupOrNull("amount")?.formatInt()?.toDouble()?.times(-1) ?: 0.0
+            }
+        }
+        val preCostPrice = totalPrice
+        totalPrice += cost
+        if (slotToHighlight.second < totalPrice) slotToHighlight = Pair(slot, totalPrice)
+        chestTipsRenderables.add(Renderable.text("Cost: ${cost.formatCoin()}"))
+        chestTipsRenderables.add(Renderable.text("Profit: ${totalPrice.formatCoin()} §f(Pre Cost Profit ${preCostPrice.formatCoin()}§f)"))
+        croesusDisplayList.add(createCroesusSingleChestDisplay(chestType, totalPrice, chestTipsRenderables))
+        chestList.clear()
+    }
+
+    private fun createCroesusSingleChestDisplay(
+        chestType: CroesusChestType,
+        totalValue: Double,
+        contents: MutableList<Renderable>,
+    ): List<Renderable> = Renderable.hoverTips(
+        Renderable.text("${chestType.stackChestName}: ${totalValue.formatCoin()}"),
+        contents,
+    ).toSingletonListOrEmpty()
+
+    private fun createCroesusDisplay() {
+        val newDisplay = buildList {
+            add(listOf(Renderable.text("§6§lCroesus Profit Overlay")))
+            croesusDisplayList.forEach {
+                add(it)
+            }
+        }
+        croesusDisplay = Renderable.table(newDisplay, ySpacing = 1)
     }
 
+    private fun getEssence(name: String, rawCount: Int): Double {
+        val count = if (name == "Crimson") rawCount * (1 + getKuudraEssenceBonus())
+        else rawCount.toDouble()
+        return count * (NeuInternalName.fromItemName(name).getPrice(config.priceSource))
+    }
+
+    private fun getAttribute(attributeName: String): Double = attributeShardPattern.matchMatcher(attributeName) {
+        val name = group("name")
+        val count = group("count").toInt()
+        count * (NeuInternalName.fromItemName(name).getPrice(config.priceSource))
+    } ?: 0.0
+
     private fun createDisplay(items: Map<Int, ItemStack>) {
-        val itemsWithCost: MutableMap<String, Double> = mutableMapOf()
-        items.forEach {
-            if (it.value.getInternalNameOrNull() != null) {
-                val cost = EstimatedItemValueCalculator.getTotalPrice(it.value)
-                if (cost != null) itemsWithCost.addOrPut(it.value.getInternalName().repoItemName, cost)
+        val itemsWithCost = mutableMapOf<String, Double>()
+        for (item in items.values) {
+            if (item.getInternalNameOrNull() != null) {
+                val cost = EstimatedItemValueCalculator.getTotalPrice(item)
+                if (cost != null) itemsWithCost.addOrPut(item.repoItemName, cost)
             }
-            attributeShardPattern.matchMatcher(it.value.displayName) {
-                val name = group("name")
-                val count = group("count").toInt()
-                val price = count * (NeuInternalName.fromItemName(name).getPriceOrNull(config.priceSource) ?: 0.0)
-                itemsWithCost.addOrPut(it.value.displayName, price)
+            val name = item.displayName
+            if (attributeShardPattern.matches(name)) {
+                val price = getAttribute(name)
+                itemsWithCost.addOrPut(name, price)
             }
-            essencePattern.matchMatcher(it.value.displayName) {
-                val name = group("name")
-                val rawCount = group("count").toInt()
-                val count = if (name == "Crimson") rawCount * (1 + getKuudraEssenceBonus())
-                else rawCount.toDouble()
-                val price = count * (NeuInternalName.fromItemName(name).getPriceOrNull(config.priceSource) ?: 0.0)
-                itemsWithCost.addOrPut(it.value.displayName, price)
+            essencePattern.matchMatcher(name) {
+                val price = getEssence(group("name"), group("count").toInt())
+                // TODO remove if check, getEssence should return null if no price is found
+                if (price != 0.0) itemsWithCost.addOrPut(name, price)
             }
         }
 
@@ -144,7 +326,7 @@
             }
             dungeonChestKey.matchMatcher(it) {
                 val name = NeuInternalName.fromItemName(it)
-                itemsWithCost.put(it, name.getPriceOrNull(config.priceSource)?.times(-1) ?: 0.0)
+                itemsWithCost.put(it, name.getPrice(config.priceSource).times(-1))
             }
             kuudraChestKey.matchMatcher(it) {
                 val name = NeuInternalName.fromItemName(it)
@@ -189,11 +371,11 @@
             add(listOf(Renderable.text("$color§lProfit"), Renderable.text("$color ${total.formatCoin()}")))
         }
 
-        display = Renderable.table(newDisplay, ySpacing = 1)
+        chestDisplay = Renderable.table(newDisplay, ySpacing = 1)
     }
 
-    private fun getKuudraEssenceBonus(): Double {
-        return ProfileStorageData.petProfiles?.pets?.filter { PetUtils.getPetProperName(it.fauxInternalName) == "KUUDRA" }
+    private fun getKuudraEssenceBonus(): Double =
+        ProfileStorageData.petProfiles?.pets?.filter { PetUtils.getPetProperName(it.fauxInternalName) == "KUUDRA" }
             ?.maxByOrNull { it.rarity.id }
             ?.let {
                 when (it.rarity) {
@@ -202,12 +384,20 @@
                     else -> 0.0
                 }
             } ?: 0.0
-    }
 
     @HandleEvent(GuiRenderEvent::class)
     fun onRenderOverlay() {
-        if (!config.enabled || (!inDungeonChest && !inKuudraChest)) return
-
-        config.position.renderRenderable(display, posLabel = "Instance Chest Profit")
+        if (config.enabled && (inDungeonChest || inKuudraChest)) {
+            config.position.renderRenderable(
+                chestDisplay,
+                posLabel = "Instance Chest Profit",
+            )
+        }
+        if (config.croesusEnabled && inCroesusRunMenu) {
+            config.croesusPosition.renderRenderable(
+                croesusDisplay,
+                posLabel = "Croesus Chest Profit",
+            )
+        }
     }
 }

src/main/java/at/hannibal2/skyhanni/features/mining/crystalhollows/CrystalNucleusApi.kt

@@ -130,7 +130,7 @@ object CrystalNucleusApi {
         if (itemName.contains(" Powder")) return null
         // Books are not directly added to the loot map, but are checked for later.
         if (itemName.startsWith("§fEnchanted")) {
-            val bookType = ItemUtils.readBookType(itemName)
+            val bookType = ItemUtils.readBookTypeStrippedColor(itemName)
             return when (bookType) {
                 "Lapidary I" -> LAPIDARY_I_BOOK_ITEM to 1
                 "Fortune IV" -> FORTUNE_IV_BOOK_ITEM to 1

src/main/java/at/hannibal2/skyhanni/features/mining/fossilexcavator/FossilExcavatorApi.kt

@@ -110,7 +110,7 @@ object FossilExcavatorApi {
             ItemUtils.readItemAmount(group("item"))
         } ?: return
 
-        ItemUtils.readBookType(pair.first)?.let {
+        ItemUtils.readBookTypeStrippedColor(pair.first)?.let {
             pair = it to pair.second
         }
         loot.add(pair)

src/main/java/at/hannibal2/skyhanni/features/mining/glacitemineshaft/CorpseApi.kt

@@ -77,7 +77,7 @@ object CorpseApi {
         } ?: return
 
         if (pair.first.startsWith("§fEnchanted Book (")) {
-            val book = ItemUtils.readBookType(pair.first) ?: return
+            val book = ItemUtils.readBookTypeStrippedColor(pair.first) ?: return
             pair = book to pair.second
         }
         loot.add(pair)