feat: add option to use Bukkit's item comparison

Author: ybw0014

build.gradle.kts

@@ -24,15 +24,15 @@ dependencies {
 
     compileOnly(kotlin("stdlib")) // loaded through library loader
     compileOnly(kotlin("reflect")) // loaded through library loader
-    compileOnlyAndTestImpl("io.papermc.paper:paper-api:1.21.1-R0.1-SNAPSHOT")
+    compileOnlyAndTestImpl("io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT")
     compileOnlyAndTestImpl("com.github.slimefun:Slimefun4:experimental-SNAPSHOT")
     compileOnly("net.guizhanss:SlimefunTranslation:e6da231617")
     compileOnly("com.github.schntgaispock:SlimeHUD:1.3.0")
     compileOnly("com.github.SlimefunGuguProject:InfinityExpansion:bebf0bd0f9")
     compileOnly("com.github.VoperAD:SlimeFrame:8af2379a01")
     compileOnly("net.guizhanss:InfinityExpansion2:8d3e6c40f6")
     implementation("org.bstats:bstats-bukkit:3.1.0")
-    implementation("net.guizhanss:guizhanlib-all:2.4.0-SNAPSHOT")
+    implementation("net.guizhanss:guizhanlib-all:2.5.0")
     implementation("net.guizhanss:guizhanlib-kt-all:0.2.0")
 
     testImplementation(kotlin("test"))
@@ -95,14 +95,14 @@ bukkit {
 tasks.runServer {
     downloadPlugins {
         // Slimefun
-        url("https://blob.build/dl/Slimefun4/Dev/latest")
+        url("https://builds.guizhanss.com/api/download/SlimefunGuguProject/Slimefun4/master/latest")
         // SlimeHUD
         url("https://blob.build/dl/SlimeHUD/Dev/latest")
         // GuizhanCraft for testing convenient
         url("https://builds.guizhanss.com/api/download/ybw0014/GuizhanCraft/master/latest")
     }
     jvmArgs("-Dcom.mojang.eula.agree=true")
-    minecraftVersion("1.20.6")
+    minecraftVersion("1.21.11")
 }
 
 tasks.test {

src/main/kotlin/net/guizhanss/fastmachines/core/services/ConfigService.kt

@@ -15,6 +15,7 @@ class ConfigService(plugin: FastMachines) {
     lateinit var fmTickRate: ConfigField<Int>
     lateinit var fmUseEnergy: ConfigField<Boolean>
     lateinit var fmRequireSfResearch: ConfigField<Boolean>
+    lateinit var fmUseBukkitItemComparison: ConfigField<Boolean>
 
     private val config = addonConfig(plugin, "config.yml") {
         autoUpdate = boolean("auto-update", true)
@@ -24,6 +25,7 @@ class ConfigService(plugin: FastMachines) {
         fmTickRate = int("fast-machines.tick-rate", 10, 5, 600)
         fmUseEnergy = boolean("fast-machines.use-energy", true)
         fmRequireSfResearch = boolean("fast-machines.require-sf-research", false)
+        fmUseBukkitItemComparison = boolean("fast-machines.use-bukkit-items", false)
     }
 
     init {

src/main/kotlin/net/guizhanss/fastmachines/utils/items/ItemExt.kt

@@ -3,6 +3,7 @@
 package net.guizhanss.fastmachines.utils.items
 
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun
+import net.guizhanss.fastmachines.FastMachines
 import net.guizhanss.fastmachines.core.items.ItemWrapper
 import net.guizhanss.guizhanlib.minecraft.utils.MinecraftVersionUtil
 import org.bukkit.inventory.ItemStack
@@ -32,11 +33,16 @@ fun ItemWrapper?.isSimilarTo(other: ItemStack?, checkLore: Boolean = false): Boo
     // null check
     if (this == null || other == null) return false
 
+    // bukkit item comparison
+    if (FastMachines.configService.fmUseBukkitItemComparison.value) {
+        return baseItem.isSimilar(other)
+    }
+
     // type check
     if (baseItem.type != other.type) return false
     if (baseItem.type.isAir || other.type.isAir) return false
 
-    // meta check
+    // has meta check
     if (baseItemMeta == null || !other.hasItemMeta()) {
         return (baseItemMeta != null) == other.hasItemMeta()
     }
@@ -146,7 +152,7 @@ private fun ItemMeta.quickNotEquals(other: ItemMeta): Boolean {
     }
 
     if (this is PotionMeta && other is PotionMeta) {
-        if (MinecraftVersionUtil.isAtLeast(20, 5)) {
+        if (MinecraftVersionUtil.isAtLeast(1, 20, 5)) {
             if (this.basePotionType != other.basePotionType) return true
         } else {
             if (this.basePotionData != other.basePotionData) return true

src/main/resources/config.yml

@@ -24,5 +24,8 @@ fast-machines:
   # Whether crafting a Slimefun item needs it to be unlocked first.
   require-sf-research: false
 
+  # Whether to use ItemStack's own isSimilar to compare items.
+  use-bukkit-item-comparison: false
+
 # Print debug messages.
 debug: false

src/test/kotlin/net/guizhanss/fastmachines/core/items/ItemWrapperTest.kt

@@ -7,7 +7,6 @@ import org.junit.jupiter.api.BeforeEach
 import org.mockbukkit.mockbukkit.MockBukkit
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlin.test.assertTrue
 
 class ItemWrapperTest {
 
@@ -33,11 +32,11 @@ class ItemWrapperTest {
         val wrapper1 = ItemWrapper.of(ItemStack(Material.DIAMOND, 32))
         val wrapper2 = ItemWrapper.of(ItemStack(Material.DIAMOND, 32))
 
-        assertTrue(wrapper1 == wrapper2)
+        assertEquals(wrapper1, wrapper2)
 
         val wrapper3 = ItemWrapper.of(ItemStack(Material.GOLD_INGOT, 32))
         val wrapper4 = ItemWrapper.of(ItemStack(Material.GOLD_INGOT, 16))
 
-        assertTrue(wrapper3 == wrapper4)
+        assertEquals(wrapper3, wrapper4)
     }
 }