Merge pull request #141 from pylonmc/add-pylon-guide

Add pylon guide

Author: LordIdra

pylon-core/build.gradle.kts

@@ -12,6 +12,7 @@ plugins {
 }
 
 repositories {
+    mavenCentral()
     maven("https://repo.xenondevs.xyz/releases") {
         name = "InvUI"
     }
@@ -28,6 +29,8 @@ dependencies {
 
     runtimeOnly(project(":nms"))
 
+    implementation("info.debatty:java-string-similarity:2.0.0")
+
     paperLibraryApi("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.1")
 
     compileOnly("io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT")

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/PylonCore.kt

@@ -13,13 +13,17 @@ import io.github.pylonmc.pylon.core.debug.DebugWaxedWeatheredCutCopperStairs
 import io.github.pylonmc.pylon.core.entity.EntityListener
 import io.github.pylonmc.pylon.core.entity.EntityStorage
 import io.github.pylonmc.pylon.core.entity.PylonEntity
+import io.github.pylonmc.pylon.core.guide.PylonGuide
 import io.github.pylonmc.pylon.core.i18n.AddonTranslator
 import io.github.pylonmc.pylon.core.item.PylonItem
 import io.github.pylonmc.pylon.core.item.PylonItemListener
 import io.github.pylonmc.pylon.core.item.research.Research
 import io.github.pylonmc.pylon.core.mobdrop.MobDropListener
+import io.github.pylonmc.pylon.core.recipe.PylonRecipeListener
+import io.github.pylonmc.pylon.core.recipe.RecipeType
 import io.github.pylonmc.pylon.core.registry.PylonRegistry
 import org.bukkit.Bukkit
+import org.bukkit.Material
 import org.bukkit.NamespacedKey
 import org.bukkit.entity.BlockDisplay
 import org.bukkit.plugin.java.JavaPlugin
@@ -50,6 +54,7 @@ object PylonCore : JavaPlugin(), PylonAddon {
         Bukkit.getPluginManager().registerEvents(PylonGuiBlock, this)
         Bukkit.getPluginManager().registerEvents(PylonEntityHolderBlock, this)
         Bukkit.getPluginManager().registerEvents(PylonSimpleMultiblock, this)
+        Bukkit.getPluginManager().registerEvents(PylonRecipeListener, this)
 
         Bukkit.getScheduler().runTaskTimer(
             this,
@@ -72,12 +77,21 @@ object PylonCore : JavaPlugin(), PylonAddon {
         registerWithPylon()
 
         PylonItem.register(DebugWaxedWeatheredCutCopperStairs::class.java, DebugWaxedWeatheredCutCopperStairs.STACK)
+        PylonGuide.hideItem(DebugWaxedWeatheredCutCopperStairs.KEY)
+
         PylonItem.register(PhantomBlock.ErrorItem::class.java, PhantomBlock.ErrorItem.STACK)
+        PylonGuide.hideItem(PhantomBlock.ErrorItem.KEY)
+
+        PylonItem.register(PylonGuide::class.java, PylonGuide.STACK)
+        PylonGuide.hideItem(PylonGuide.KEY)
+
         PylonEntity.register(
             PylonSimpleMultiblock.MultiblockGhostBlock.KEY,
             BlockDisplay::class.java,
             PylonSimpleMultiblock.MultiblockGhostBlock::class.java
         )
+
+        RecipeType.addVanillaRecipes()
     }
 
     override fun onDisable() {
@@ -93,7 +107,7 @@ object PylonCore : JavaPlugin(), PylonAddon {
 
     override val javaPlugin = this
 
-    override val displayName = "Core"
+    override val material = Material.BEDROCK
 
     override val languages: Set<Locale> = setOf(
         Locale.ENGLISH,

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/addon/PylonAddon.kt

@@ -4,10 +4,17 @@ import io.github.pylonmc.pylon.core.PylonCore
 import io.github.pylonmc.pylon.core.config.Config
 import io.github.pylonmc.pylon.core.config.ConfigSection
 import io.github.pylonmc.pylon.core.i18n.AddonTranslator
+import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
 import io.github.pylonmc.pylon.core.registry.PylonRegistry
+import net.kyori.adventure.text.Component
+import net.kyori.adventure.text.TranslatableComponent
+import net.kyori.adventure.text.format.NamedTextColor
+import net.kyori.adventure.text.format.TextDecoration
 import org.bukkit.Keyed
+import org.bukkit.Material
 import org.bukkit.NamespacedKey
 import org.bukkit.configuration.file.YamlConfiguration
+import org.bukkit.inventory.ItemStack
 import org.bukkit.plugin.java.JavaPlugin
 import java.util.Locale
 
@@ -17,10 +24,12 @@ interface PylonAddon : Keyed {
 
     val languages: Set<Locale>
 
-    /**
-     * The display name used, for example, at the bottom of items to show which addon an item is from
-     */
-    val displayName: String
+    val material: Material
+
+    val displayName: TranslatableComponent
+        get() = Component.translatable("pylon.${key.namespace}.addon")
+                        .decoration(TextDecoration.ITALIC, true)
+                        .color(NamedTextColor.BLUE)
 
     override fun getKey(): NamespacedKey
             = NamespacedKey(javaPlugin, javaPlugin.name.lowercase())
@@ -31,6 +40,15 @@ interface PylonAddon : Keyed {
     fun registerWithPylon() {
         PylonRegistry.ADDONS.register(this)
         AddonTranslator.register(this)
+
+        if (key !in addonNameWarningsSupressed) {
+            val translator = AddonTranslator.translators[this]!!
+            for (locale in languages) {
+                if (!translator.canTranslate("pylon.${key.namespace}.addon", locale)) {
+                    PylonCore.logger.warning("${key.namespace} is missing the 'addon' translation key for ${locale.displayName}")
+                }
+            }
+        }
     }
 
     /**
@@ -65,4 +83,14 @@ interface PylonAddon : Keyed {
         }
         return config
     }
+
+    companion object {
+
+        private val addonNameWarningsSupressed: MutableSet<NamespacedKey> = mutableSetOf()
+
+        @JvmStatic
+        fun supressAddonNameWarnings(key: NamespacedKey) {
+            addonNameWarningsSupressed.add(key)
+        }
+    }
 }

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/block/BlockListener.kt

@@ -28,8 +28,8 @@ import org.bukkit.event.inventory.BrewingStandFuelEvent
 import org.bukkit.event.inventory.FurnaceBurnEvent
 import org.bukkit.event.inventory.FurnaceExtractEvent
 import org.bukkit.event.player.PlayerInteractEvent
-import org.bukkit.event.player.PlayerTakeLecternBookEvent
 import org.bukkit.event.player.PlayerToggleSneakEvent
+import org.bukkit.event.player.PlayerTakeLecternBookEvent
 
 
 /**

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/block/PhantomBlock.kt

@@ -82,7 +82,7 @@ class PhantomBlock(
         companion object {
             val KEY = pylonKey("error_item")
             val BLOCK_KEY = pylonKey("block")
-            val STACK = ItemStackBuilder.pylonItem(Material.BARRIER, key)
+            val STACK = ItemStackBuilder.pylonItem(Material.BARRIER, KEY)
                 .build()
         }
     }

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/command/PylonCommand.kt

@@ -8,6 +8,7 @@ import io.github.pylonmc.pylon.core.PylonCore
 import io.github.pylonmc.pylon.core.block.BlockStorage
 import io.github.pylonmc.pylon.core.block.waila.Waila.Companion.wailaEnabled
 import io.github.pylonmc.pylon.core.debug.DebugWaxedWeatheredCutCopperStairs
+import io.github.pylonmc.pylon.core.guide.PylonGuide
 import io.github.pylonmc.pylon.core.i18n.PylonArgument
 import io.github.pylonmc.pylon.core.item.research.Research
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchPoints
@@ -36,6 +37,29 @@ import org.jetbrains.annotations.ApiStatus
 @ApiStatus.Internal
 internal class PylonCommand : BaseCommand() {
 
+    @Default
+    @Description("Open the Pylon guide")
+    @CommandPermission("pylon.command.guide")
+    fun default(player: Player) {
+        PylonGuide.open(player)
+    }
+
+    @Subcommand("guide")
+    @Description("Obtain the Pylon guide")
+    @CommandPermission("pylon.command.guide")
+    fun guide(player: Player) {
+        player.inventory.addItem(PylonGuide.STACK)
+    }
+
+    init {
+        Bukkit.getPluginManager().addPermission(
+            Permission(
+                "pylon.command.guide",
+                PermissionDefault.TRUE
+            )
+        )
+    }
+
     @Subcommand("give")
     @CommandCompletion("@players @items")
     @Description("Give a Pylon item to a player")
@@ -223,9 +247,24 @@ internal class PylonCommand : BaseCommand() {
                 player.sendRichMessage("<red>Research not found: $research")
                 return
             }
-            player.removeResearch(res)
-            val name = MiniMessage.miniMessage().serialize(res.name)
-            player.sendRichMessage("<green>Removed research $name from ${player.name}")
+            if (player.hasResearch(res)) {
+                player.removeResearch(res)
+                val name = MiniMessage.miniMessage().serialize(res.name)
+                player.sendRichMessage("<green>Removed research $name from ${player.name}")
+            } else {
+                player.sendRichMessage("<red>${player.name} does not have $name")
+            }
+        }
+
+        @Subcommand("removeall")
+        @CommandCompletion("@players")
+        @Description("Remove all researches from a player")
+        @CommandPermission("pylon.command.research.modify")
+        fun removeAll(p: OnlinePlayer) {
+            val player = p.player
+            for (research in player.researches) {
+                player.removeResearch(research)
+            }
         }
 
         @Subcommand("points")

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/event/PylonRegisterEvent.kt

@@ -0,0 +1,19 @@
+package io.github.pylonmc.pylon.core.event
+
+import io.github.pylonmc.pylon.core.registry.PylonRegistry
+import org.bukkit.Keyed
+import org.bukkit.event.Event
+import org.bukkit.event.HandlerList
+
+class PylonRegisterEvent(
+    val registry: PylonRegistry<*>,
+    val value: Keyed,
+) : Event() {
+    override fun getHandlers(): HandlerList
+            = handlerList
+
+    companion object {
+        @JvmStatic
+        val handlerList: HandlerList = HandlerList()
+    }
+}

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/event/PylonUnregisterEvent.kt

@@ -0,0 +1,19 @@
+package io.github.pylonmc.pylon.core.event
+
+import io.github.pylonmc.pylon.core.registry.PylonRegistry
+import org.bukkit.Keyed
+import org.bukkit.event.Event
+import org.bukkit.event.HandlerList
+
+class PylonUnregisterEvent(
+    val registry: PylonRegistry<*>,
+    val value: Keyed,
+) : Event() {
+    override fun getHandlers(): HandlerList
+            = handlerList
+
+    companion object {
+        @JvmStatic
+        val handlerList: HandlerList = HandlerList()
+    }
+}

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/fluid/PylonFluid.kt

@@ -1,6 +1,10 @@
 package io.github.pylonmc.pylon.core.fluid
 
+import io.github.pylonmc.pylon.core.PylonCore
+import io.github.pylonmc.pylon.core.i18n.AddonTranslator
+import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
 import io.github.pylonmc.pylon.core.registry.PylonRegistry
+import io.github.pylonmc.pylon.core.util.key.getAddon
 import net.kyori.adventure.text.Component
 import org.bukkit.Keyed
 import org.bukkit.Material
@@ -22,6 +26,18 @@ open class PylonFluid(
 
     override fun getKey(): NamespacedKey = key
 
+    init {
+        val addon = PylonRegistry.ADDONS[NamespacedKey(key.namespace, key.namespace)]!!
+        val translator = AddonTranslator.translators[addon]!!
+
+        for (locale in addon.languages) {
+            val translationKey = "pylon.${key.namespace}.fluid.${key.key}"
+            check(translator.canTranslate(translationKey, locale)) {
+                PylonCore.logger.warning("${key.namespace} is missing a translation key for fluid ${key.key} (locale: ${locale.displayName} | expected translation key: $translationKey")
+            }
+        }
+    }
+
     fun addTag(tag: PylonFluidTag) = apply {
         check(!hasTag(tag.javaClass)) { "Fluid already has a tag of the same type" }
         tags.add(tag)
@@ -46,6 +62,19 @@ open class PylonFluid(
         PylonRegistry.FLUIDS.register(this)
     }
 
+    fun getItem(): ItemStackBuilder {
+        val item = ItemStackBuilder.of(material)
+            .name(Component.translatable("pylon.${key.namespace}.fluid.${key.key}"))
+
+        for (tag in tags) {
+            item.lore(tag.displayText)
+        }
+
+        item.lore(getAddon(key).displayName)
+
+        return item
+    }
+
     override fun equals(other: Any?): Boolean = other is PylonFluid && key == other.key
     override fun hashCode(): Int = key.hashCode()
     override fun toString(): String = key.toString()

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/fluid/PylonFluidTag.kt

@@ -1,5 +1,7 @@
 package io.github.pylonmc.pylon.core.fluid
 
+import net.kyori.adventure.text.Component
+
 interface PylonFluidTag {
-    // TODO add text display methods once the guide is added
+    val displayText: Component
 }