Feature: Flowstate helper

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

@@ -0,0 +1,44 @@
+package at.hannibal2.skyhanni.config.features.mining;
+
+import at.hannibal2.skyhanni.config.FeatureToggle;
+import at.hannibal2.skyhanni.config.core.config.Position;
+import at.hannibal2.skyhanni.features.mining.FlowstateHelper;
+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.ConfigEditorSlider;
+import io.github.notenoughupdates.moulconfig.annotations.ConfigLink;
+import io.github.notenoughupdates.moulconfig.annotations.ConfigOption;
+
+import java.util.List;
+
+public class FlowstateHelperConfig {
+    @Expose
+    @ConfigOption(name = "Enabled", desc = "Shows stats for the Flowstate enchantment.")
+    @ConfigEditorBoolean
+    @FeatureToggle
+    public boolean enabled = false;
+
+    @Expose
+    @ConfigOption(name = "Appearance", desc = "Drag text to change the appearance.")
+    @ConfigEditorDraggableList()
+    public List<FlowstateHelper.GUIElements> appearance = FlowstateHelper.GUIElements.defaultOption;
+
+    @Expose
+    @ConfigOption(name = "Colorful Timer", desc = "Makes the timer's color dynamic.")
+    @ConfigEditorBoolean
+    public boolean colorfulTimer = false;
+
+    @Expose
+    @ConfigOption(name = "Autohide", desc = "Automatically hides the GUI after a certain time idle, in seconds.")
+    @ConfigEditorSlider(
+        minValue = -1,
+        maxValue = 30,
+        minStep = 1
+    )
+    public int autoHide = 5;
+
+    @Expose
+    @ConfigLink(owner = FlowstateHelperConfig.class, field = "enabled")
+    public Position position = new Position(-110 , 9);
+}

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

@@ -73,6 +73,11 @@ public class MiningConfig {
     @Accordion
     public MineshaftPityDisplayConfig mineshaftPityDisplay = new MineshaftPityDisplayConfig();
 
+    @Expose
+    @ConfigOption(name = "Flowstate Helper", desc = "")
+    @Accordion
+    public FlowstateHelperConfig flowstateHelper = new FlowstateHelperConfig();
+
     @Expose
     @ConfigOption(name = "Highlight Commission Mobs", desc = "Highlight mobs that are part of active commissions.")
     @ConfigEditorBoolean

src/main/java/at/hannibal2/skyhanni/features/mining/FlowstateHelper.kt

@@ -0,0 +1,180 @@
+package at.hannibal2.skyhanni.features.mining
+
+import at.hannibal2.skyhanni.SkyHanniMod
+import at.hannibal2.skyhanni.api.event.HandleEvent
+import at.hannibal2.skyhanni.data.MiningAPI
+import at.hannibal2.skyhanni.events.GuiRenderEvent
+import at.hannibal2.skyhanni.events.IslandChangeEvent
+import at.hannibal2.skyhanni.events.ItemInHandChangeEvent
+import at.hannibal2.skyhanni.events.LorenzTickEvent
+import at.hannibal2.skyhanni.events.mining.OreMinedEvent
+import at.hannibal2.skyhanni.skyhannimodule.SkyHanniModule
+import at.hannibal2.skyhanni.utils.InventoryUtils
+import at.hannibal2.skyhanni.utils.RenderUtils.renderRenderables
+import at.hannibal2.skyhanni.utils.SimpleTimeMark
+import at.hannibal2.skyhanni.utils.SimpleTimeMark.Companion.fromNow
+import at.hannibal2.skyhanni.utils.SkyBlockItemModifierUtils.getEnchantments
+import at.hannibal2.skyhanni.utils.TimeUnit
+import at.hannibal2.skyhanni.utils.TimeUtils.format
+import at.hannibal2.skyhanni.utils.renderables.Renderable
+import at.hannibal2.skyhanni.utils.repopatterns.RepoPattern
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent
+import kotlin.time.Duration
+import kotlin.time.Duration.Companion.seconds
+
+@SkyHanniModule
+object FlowstateHelper {
+    private val config get() = SkyHanniMod.feature.mining.flowstateHelper
+    private var streakEndTimer = SimpleTimeMark.farPast()
+    private var blockBreakStreak = 0
+
+    private var display: List<Renderable>? = null
+    private var displayDirty = false
+    private var displayHibernating = true
+    private var timeSinceHibernation = SimpleTimeMark.farPast()
+
+    private var flowstateCache: Int? = null
+
+    private val pickobulusPattern by RepoPattern.pattern(
+        "mining.pickobulus.blockdestroy",
+        "§7Your §r§aPickobulus §r§7destroyed §r§e(?<amount>\\d+) §r§7blocks!"
+    )
+
+    enum class GUIElements(val label: String, var renderable: Renderable = Renderable.string("")) {
+        TITLE("§d§lFlowstate Helper", Renderable.string("§d§lFlowstate Helper")),
+        TIMER("Time Remaining: §b6.71"),
+        STREAK("Streak: §7234"),
+        SPEED("§6+600⸕"),
+        ;
+
+        override fun toString() = label
+
+        fun create() {
+            when (this) {
+                TIMER -> {
+                    var timeRemaining = streakEndTimer.minus(SimpleTimeMark.now())
+                    if (timeRemaining < 0.seconds) timeRemaining = 0.seconds
+
+                    renderable = Renderable.string(
+                        "Time Remaining: ${getTimerColor(timeRemaining)}${
+                            timeRemaining.format(
+                                TimeUnit.SECOND, true, maxUnits = 2, showSmallerUnits = true
+                            )
+                        }")
+                }
+                STREAK -> {
+                    val textColor = if (blockBreakStreak < 200) "§7" else "§f"
+                    renderable = Renderable.string("Streak: $textColor$blockBreakStreak")
+                }
+                SPEED -> renderable = Renderable.string("§6+${getSpeedBonus()}⸕")
+                else -> return
+            }
+        }
+
+        companion object {
+            @JvmField
+            val defaultOption = listOf(
+                TITLE, TIMER, STREAK, SPEED
+            )
+        }
+    }
+
+    @HandleEvent(onlyOnSkyblock = true)
+    fun onBlockMined(event: OreMinedEvent) {
+        if (!MiningAPI.inCustomMiningIsland()) return
+        if (flowstateCache == null) return
+
+        displayHibernating = false
+        streakEndTimer = 10.seconds.fromNow()
+        blockBreakStreak += event.extraBlocks.values.sum()
+        displayDirty = true
+        createDisplay()
+    }
+
+    @SubscribeEvent
+    fun onTick(event: LorenzTickEvent) {
+        if (!MiningAPI.inCustomMiningIsland()) return
+
+        attemptClearDisplay()
+    }
+
+    private fun attemptClearDisplay() {
+        if (streakEndTimer.isInFuture()) return
+        blockBreakStreak = 0
+        displayDirty = true
+        if (!displayHibernating) timeSinceHibernation = SimpleTimeMark.now()
+        displayHibernating = true
+        createDisplay()
+    }
+
+    @SubscribeEvent
+    fun onRenderOverlay(event: GuiRenderEvent.GuiOverlayRenderEvent) {
+        if (!MiningAPI.inCustomMiningIsland()) return
+        if (!config.enabled) return
+        if (flowstateCache == null) return
+
+        if (displayHibernating && config.autoHide > -1 && timeSinceHibernation.passedSince() > config.autoHide.seconds) return
+        if (display == null || streakEndTimer.isInFuture()) {
+            createDisplay()
+        }
+
+        display?.let {
+            config.position.renderRenderables(
+                it,
+                1,
+                "Flowstate Helper",
+                true
+            )
+        }
+    }
+
+    private fun createDisplay() {
+        if (displayDirty) {
+            displayDirty = false
+            GUIElements.STREAK.create()
+            GUIElements.SPEED.create()
+        }
+        GUIElements.TIMER.create()
+        display = config.appearance.map { it.renderable }
+    }
+
+    private fun getSpeedBonus(): Int {
+        val flowstateLevel = flowstateCache ?: 0
+        if (blockBreakStreak >= 200) return 200 * flowstateLevel
+        return blockBreakStreak * flowstateLevel
+    }
+
+    @SubscribeEvent
+    fun onChangeItem(event: ItemInHandChangeEvent) {
+        hasFlowstate()
+    }
+
+    @SubscribeEvent
+    fun onIslandChange(event: IslandChangeEvent) {
+        streakEndTimer = SimpleTimeMark.farPast()
+        attemptClearDisplay()
+    }
+
+    private fun getTimerColor(timeRemaining: Duration): String {
+        if (!config.colorfulTimer) return "§6"
+        return when (timeRemaining) {
+            in 0.seconds..2.seconds -> "§c"
+            in 2.seconds..5.seconds -> "§6§#§f§c§7§a§2§5§/"
+            in 5.seconds..7.seconds -> "§e"
+            in 7.seconds..10.seconds -> "§a"
+            else -> "§6"
+        }
+    }
+
+    private fun hasFlowstate() {
+        val enchantList = InventoryUtils.getItemInHand()?.getEnchantments() ?: run {
+            flowstateCache = null
+            return
+        }
+        if ("ultimate_flowstate" !in enchantList) {
+            flowstateCache = null
+            return
+        }
+        flowstateCache = enchantList.getValue("ultimate_flowstate")
+    }
+}