Merge pull request #553 from pylonmc/guide-polishing

LordIdra · web-flow · commit b10a487abe1e · 2026-01-09T02:27:25.000Z
Guide polishing :flag_pl:
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/content/guide/PylonGuide.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/content/guide/PylonGuide.kt
@@ -71,6 +71,12 @@ class PylonGuide(stack: ItemStack) : PylonItem(stack), PylonInteractor {
         @JvmStatic
         val hiddenItems: MutableSet<NamespacedKey> = mutableSetOf()
 
+        /**
+         * Admin items do not show up in searches unless a player has the `pylon.guide.cheat` permission
+         */
+        @JvmStatic
+        val adminOnlyItems: MutableSet<NamespacedKey> = mutableSetOf()
+
         /**
          * Hidden fluids do not show up in searches
          */
@@ -86,7 +92,11 @@ class PylonGuide(stack: ItemStack) : PylonItem(stack), PylonInteractor {
         @JvmStatic
         val fluidsPage = object : SimpleDynamicGuidePage(
             pylonKey("fluids"),
-            { PylonRegistry.FLUIDS.map { FluidButton(it) }.toMutableList() }
+            {
+                PylonRegistry.FLUIDS.filter { it.key !in hiddenFluids }
+                    .map { FluidButton(it) }
+                    .toMutableList()
+            }
         ) {}
 
         @JvmStatic
@@ -156,6 +166,14 @@ class PylonGuide(stack: ItemStack) : PylonItem(stack), PylonInteractor {
             hiddenItems.add(key)
         }
 
+        /**
+         * Hide an item from showing up in searches unless a player has the `pylon.guide.cheat` permission
+         */
+        @JvmStatic
+        fun hideItemUnlessAdmin(key: NamespacedKey) {
+            adminOnlyItems.add(key)
+        }
+
         /**
          * Hide a fluid from showing up in searches
          */
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/BackButton.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/BackButton.kt
@@ -2,7 +2,9 @@ package io.github.pylonmc.pylon.core.guide.button
 
 import io.github.pylonmc.pylon.core.content.guide.PylonGuide
 import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.guideHints
 import io.github.pylonmc.pylon.core.util.pylonKey
+import io.papermc.paper.datacomponent.DataComponentTypes
 import net.kyori.adventure.text.Component
 import org.bukkit.Material
 import org.bukkit.entity.Player
@@ -15,9 +17,15 @@ import xyz.xenondevs.invui.item.impl.AbstractItem
  */
 class BackButton : AbstractItem() {
 
-    override fun getItemProvider() = ItemStackBuilder.gui(Material.ENCHANTED_BOOK, pylonKey("guide_back"))
-        .name(Component.translatable("pylon.pyloncore.guide.button.back.name"))
-        .lore(Component.translatable("pylon.pyloncore.guide.button.back.lore"))
+    override fun getItemProvider(player: Player): ItemStackBuilder {
+        val stack = ItemStackBuilder.gui(Material.ENCHANTED_BOOK, pylonKey("guide_back"))
+            .set(DataComponentTypes.ENCHANTMENT_GLINT_OVERRIDE, false)
+            .name(Component.translatable("pylon.pyloncore.guide.button.back.name"))
+        if (player.guideHints) {
+            stack.lore(Component.translatable("pylon.pyloncore.guide.button.back.hints"))
+        }
+        return stack
+    }
 
     override fun handleClick(clickType: ClickType, player: Player, event: InventoryClickEvent) {
         val history = PylonGuide.history.getOrPut(player.uniqueId) { mutableListOf() }
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/FluidButton.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/FluidButton.kt
@@ -7,6 +7,7 @@ import io.github.pylonmc.pylon.core.guide.pages.fluid.FluidRecipesPage
 import io.github.pylonmc.pylon.core.guide.pages.fluid.FluidUsagesPage
 import io.github.pylonmc.pylon.core.i18n.PylonArgument
 import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.guideHints
 import io.github.pylonmc.pylon.core.recipe.RecipeInput
 import io.github.pylonmc.pylon.core.util.gui.unit.UnitFormat
 import io.papermc.paper.datacomponent.DataComponentTypes
@@ -73,8 +74,8 @@ open class FluidButton(
         }
     }
 
-    override fun getItemProvider() = try {
-        if (amount == null) {
+    override fun getItemProvider(player: Player) = try {
+        val stack = if (amount == null) {
             preDisplayDecorator.invoke(ItemStackBuilder.of(currentFluid.item))
         } else {
             preDisplayDecorator.invoke(ItemStackBuilder.of(currentFluid.item))
@@ -86,6 +87,10 @@ open class FluidButton(
                     )
                 )
         }
+        if (player.guideHints) {
+            stack.lore(Component.translatable("pylon.pyloncore.guide.button.fluid.hints"))
+        }
+        stack
     } catch (e: Exception) {
         e.printStackTrace()
         ItemStackBuilder.of(Material.BARRIER)
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/ItemButton.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/ItemButton.kt
@@ -11,6 +11,7 @@ import io.github.pylonmc.pylon.core.item.PylonItem
 import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.canCraft
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.canUse
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.guideHints
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchPoints
 import io.github.pylonmc.pylon.core.recipe.RecipeInput
 import io.papermc.paper.datacomponent.DataComponentTypes
@@ -103,8 +104,17 @@ class ItemButton @JvmOverloads constructor(
                 } else {
                     builder.lore(Component.translatable("pylon.pyloncore.guide.button.item.not-researched"))
                 }
+            }
 
-                builder.lore(Component.translatable("pylon.pyloncore.guide.button.item.research-instructions"))
+            if (player.guideHints) {
+                if (!player.canCraft(item)) {
+                    builder.lore(Component.translatable("pylon.pyloncore.guide.button.item.hints.unresearched"))
+                } else {
+                    builder.lore(Component.translatable("pylon.pyloncore.guide.button.item.hints.researched"))
+                }
+                if (player.hasPermission("pylon.guide.cheat")) {
+                    builder.lore(Component.translatable("pylon.pyloncore.guide.button.item.hints.admin"))
+                }
             }
 
             return builder
@@ -163,7 +173,11 @@ class ItemButton @JvmOverloads constructor(
                     if (!player.hasPermission("pylon.guide.cheat")) return
                     val stack = getCheatItemStack(currentStack, event)
                     stack.amount = 1
-                    player.dropItem(stack)
+                    if (player.itemOnCursor.isEmpty) {
+                        player.setItemOnCursor(stack)
+                    } else if (player.itemOnCursor.isSimilar(stack)) {
+                        player.itemOnCursor.add()
+                    }
                 }
 
                 ClickType.CONTROL_DROP -> {
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/ResearchButton.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/ResearchButton.kt
@@ -4,6 +4,7 @@ import io.github.pylonmc.pylon.core.guide.pages.research.ResearchItemsPage
 import io.github.pylonmc.pylon.core.i18n.PylonArgument
 import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
 import io.github.pylonmc.pylon.core.item.research.Research
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.guideHints
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchPoints
 import io.github.pylonmc.pylon.core.util.getAddon
 import io.github.pylonmc.pylon.core.util.pylonKey
@@ -34,7 +35,6 @@ open class ResearchButton(val research: Research) : AbstractItem() {
             }
         } else {
             addResearchCostLore(item, player, research)
-            item.lore(Component.translatable("pylon.pyloncore.guide.button.research.instructions"))
         }
 
         item.lore(Component.translatable("pylon.pyloncore.guide.button.research.unlocks-title"))
@@ -66,6 +66,12 @@ open class ResearchButton(val research: Research) : AbstractItem() {
             ))
         }
 
+        if (player.guideHints) {
+            item.lore(Component.translatable("pylon.pyloncore.guide.button.research.hints."
+                    + (if (playerHasResearch) "researched" else "unresearched")
+            ))
+        }
+
         item.lore(getAddon(research.key).displayName)
 
         item
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/pages/SearchItemsAndFluidsPage.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/pages/SearchItemsAndFluidsPage.kt
@@ -9,7 +9,6 @@ import io.github.pylonmc.pylon.core.util.plainText
 import io.github.pylonmc.pylon.core.util.pylonKey
 import net.kyori.adventure.text.Component
 import net.kyori.adventure.translation.GlobalTranslator
-import org.bukkit.Material
 import org.bukkit.entity.Player
 import xyz.xenondevs.invui.item.Item
 
@@ -19,7 +18,7 @@ import xyz.xenondevs.invui.item.Item
 class SearchItemsAndFluidsPage : SearchPage(pylonKey("search")) {
 
     fun getItemButtons(player: Player): MutableList<Pair<Item, String>> = PylonRegistry.ITEMS.filter {
-        it.key !in PylonGuide.hiddenItems
+        it.key !in PylonGuide.hiddenItems || (it.key in PylonGuide.adminOnlyItems && player.hasPermission("pylon.guide.cheat"))
     }.map { item ->
         val name = GlobalTranslator.render(Component.translatable("pylon.${item.key.namespace}.item.${item.key.key}.name"), player.locale())
         ItemButton(item.getItemStack()) to name.plainText.lowercase(player.locale())
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/pages/base/SimpleStaticGuidePage.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/pages/base/SimpleStaticGuidePage.kt
@@ -5,6 +5,7 @@ import io.github.pylonmc.pylon.core.guide.button.FluidButton
 import io.github.pylonmc.pylon.core.guide.button.ItemButton
 import io.github.pylonmc.pylon.core.guide.button.PageButton
 import io.github.pylonmc.pylon.core.guide.button.ResearchButton
+import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
 import io.github.pylonmc.pylon.core.item.research.Research
 import org.bukkit.Material
 import org.bukkit.NamespacedKey
@@ -31,6 +32,8 @@ open class SimpleStaticGuidePage @JvmOverloads constructor(
 
     open fun addButton(button: Item) = buttons.add(button)
     open fun addPage(material: Material, page: GuidePage) = addButton(PageButton(material, page))
+    open fun addPage(stack: ItemStack, page: GuidePage) = addButton(PageButton(stack.clone(), page))
+    open fun addPage(builder: ItemStackBuilder, page: GuidePage) = addButton(PageButton(builder.build().clone(), page))
     open fun addItem(item: ItemStack) = addButton(ItemButton(item))
     open fun addFluid(fluid: PylonFluid) = addButton(FluidButton(fluid))
     open fun addResearch(research: Research) = addButton(ResearchButton(research))
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/pages/settings/MainSettingsPage.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/pages/settings/MainSettingsPage.kt
@@ -3,6 +3,7 @@ package io.github.pylonmc.pylon.core.guide.pages.settings
 import io.github.pylonmc.pylon.core.config.PylonConfig
 import io.github.pylonmc.pylon.core.guide.button.PageButton
 import io.github.pylonmc.pylon.core.guide.button.setting.TogglePlayerSettingButton
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.guideHints
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchConfetti
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchSounds
 import io.github.pylonmc.pylon.core.util.pylonKey
@@ -30,6 +31,13 @@ object MainSettingsPage : PlayerSettingsPage(pylonKey("settings")) {
         isEnabled = { player -> player.researchSounds }
     )
 
+    @JvmStatic
+    val guideHintsButton = TogglePlayerSettingButton(
+        pylonKey("toggle-guide-hints"),
+        toggle = { player -> player.guideHints = !player.guideHints },
+        isEnabled = { player -> player.guideHints }
+    )
+
     init {
         if (PylonConfig.WailaConfig.enabled) {
             addSetting(wailaSettingsButton)
@@ -41,5 +49,7 @@ object MainSettingsPage : PlayerSettingsPage(pylonKey("settings")) {
             addSetting(researchConfettiButton)
             addSetting(researchSoundsButton)
         }
+
+        addSetting(guideHintsButton)
     }
 }
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/item/builder/PylonMiniMessage.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/item/builder/PylonMiniMessage.kt
@@ -35,6 +35,7 @@ val customMiniMessage = MiniMessage.builder()
     .tags(TagResolver.standard())
     .editTags {
         it.tag("arrow", ::arrow)
+        it.tag("guidearrow", ::guidearrow)
         it.tag("diamond", ::diamond)
         it.tag("star", ::star)
         it.tag(setOf("instruction", "insn")) { _, _ -> Tag.styling(TextColor.color(0xf9d104)) }
@@ -52,6 +53,11 @@ private fun arrow(args: ArgumentQueue, @Suppress("unused") ctx: Context): Tag {
     return Tag.selfClosingInserting(Component.text("\u2192").color(color))
 }
 
+private fun guidearrow(args: ArgumentQueue, @Suppress("unused") ctx: Context): Tag {
+    val color = args.peek()?.value()?.let(::parseColor) ?: TextColor.color(0x3a293)
+    return Tag.selfClosingInserting(Component.text("\u2192").color(color))
+}
+
 private fun diamond(args: ArgumentQueue, @Suppress("unused") ctx: Context): Tag {
     val color = args.peek()?.value()?.let(::parseColor) ?: TextColor.color(0x666666)
     return Tag.selfClosingInserting(Component.text("\u25C6").color(color))
diff --git a/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/item/research/Research.kt b/pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/item/research/Research.kt
@@ -143,18 +143,23 @@ data class Research(
     companion object : Listener {
         private val researchesKey = pylonKey("researches")
         private val researchPointsKey = pylonKey("research_points")
-        private val researchEffectsKey = pylonKey("research_effects")
+        private val researchConfettiKey = pylonKey("research_confetti")
+        private val researchSoundsKey = pylonKey("research_sounds")
+        private val guideHintsKey = pylonKey("guide_hints")
         private val researchesType =
             PylonSerializers.SET.setTypeFrom(PylonSerializers.KEYED.keyedTypeFrom(PylonRegistry.RESEARCHES::getOrThrow))
 
         @JvmStatic
         var Player.researchPoints: Long by persistentData(researchPointsKey, PylonSerializers.LONG, 0)
 
         @JvmStatic
-        var Player.researchConfetti: Boolean by persistentData(researchEffectsKey, PylonSerializers.BOOLEAN, true)
+        var Player.researchConfetti: Boolean by persistentData(researchConfettiKey, PylonSerializers.BOOLEAN, true)
 
         @JvmStatic
-        var Player.researchSounds: Boolean by persistentData(researchEffectsKey, PylonSerializers.BOOLEAN, true)
+        var Player.researchSounds: Boolean by persistentData(researchSoundsKey, PylonSerializers.BOOLEAN, true)
+
+        @JvmStatic
+        var Player.guideHints: Boolean by persistentData(guideHintsKey, PylonSerializers.BOOLEAN, true)
 
         @JvmStatic
         fun getResearches(player: OfflinePlayer): Set<Research> {
diff --git a/pylon-core/src/main/resources/lang/en.yml b/pylon-core/src/main/resources/lang/en.yml

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ import io.github.pylonmc.pylon.core.guide.pages.fluid.FluidRecipesPage`
`7`	`7`	`import io.github.pylonmc.pylon.core.guide.pages.fluid.FluidUsagesPage`
`8`	`8`	`import io.github.pylonmc.pylon.core.i18n.PylonArgument`
`9`	`9`	`import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder`
	`10`	`+import io.github.pylonmc.pylon.core.item.research.Research.Companion.guideHints`
`10`	`11`	`import io.github.pylonmc.pylon.core.recipe.RecipeInput`
`11`	`12`	`import io.github.pylonmc.pylon.core.util.gui.unit.UnitFormat`
`12`	`13`	`import io.papermc.paper.datacomponent.DataComponentTypes`
`@@ -73,8 +74,8 @@ open class FluidButton(`
`73`	`74`	`}`
`74`	`75`	`}`
`75`	`76`
`76`		`- override fun getItemProvider() = try {`
`77`		`- if (amount == null) {`
	`77`	`+ override fun getItemProvider(player: Player) = try {`
	`78`	`+ val stack = if (amount == null) {`
`78`	`79`	`preDisplayDecorator.invoke(ItemStackBuilder.of(currentFluid.item))`
`79`	`80`	`} else {`
`80`	`81`	`preDisplayDecorator.invoke(ItemStackBuilder.of(currentFluid.item))`
`@@ -86,6 +87,10 @@ open class FluidButton(`
`86`	`87`	`)`
`87`	`88`	`)`
`88`	`89`	`}`
	`90`	`+ if (player.guideHints) {`
	`91`	`+ stack.lore(Component.translatable("pylon.pyloncore.guide.button.fluid.hints"))`
	`92`	`+ }`
	`93`	`+ stack`
`89`	`94`	`} catch (e: Exception) {`
`90`	`95`	`e.printStackTrace()`
`91`	`96`	`ItemStackBuilder.of(Material.BARRIER)`