feat: idofront-services module, used to let other plugins register 'item providers' for serializable itemstack

chore: Remove extra plugin dependencies used for SerializableItemStack, move all others to mirror repo

Author: 0ffz

.editorconfig

@@ -0,0 +1,2 @@
+[*.kt]
+max_line_length = off

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project between Minecraft versions will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). We currently do not follow semver but
+try to keep MAJOR changes in sync with Minecraft updates.
+
+## [Unreleased]
+
+### Added
+
+- New `idofront-services` module for interfaces implemented by this plugin using Bukkit's ServiceManager API
+- Start a changelog based on Keep a Changelog
+- `Services.register` helper function
+
+### Changed
+
+- SerializableItemStack uses a new service for letting other plugins register custom item types instead of manually
+  adding support for them
+
+## [1.0.0] - 2025-08-12
+
+### Changed
+
+- Update to Minecraft 1.21.8
+- Update to Kotlin 2.2
+- Add androidx.sqlite library which provides lightweight native bindings we plan to use for our own database library

build.gradle.kts

@@ -17,13 +17,9 @@ subprojects {
         mavenCentral()
         maven("https://repo.mineinabyss.com/releases")
         maven("https://repo.mineinabyss.com/snapshots")
-        mavenLocal()
+        maven("https://repo.mineinabyss.com/mirror")
         maven("https://repo.papermc.io/repository/maven-public/")
-        maven("https://repo.spaceio.xyz/repository/maven-snapshots/")
-        maven("https://jitpack.io")
-        maven("https://mvn.lumine.io/repository/maven-public/") { metadataSources { artifact() } }// MythicMobs
-        maven("https://repo.nexomc.com/releases")
-        maven("https://repo.nexomc.com/snapshots")
+        mavenLocal()
     }
 
     tasks {

gradle.properties

@@ -1,5 +1,5 @@
 group=com.mineinabyss
-version=1.0
+version=2.0
 # Version to use for our conventions plugins.
 # Idofront will point to this version in its catalog.
 conventionsVersion=1.0.3

idofront-catalog-shaded/src/main/java/com/mineinabyss/idofront/IdofrontPlugin.kt

@@ -1,11 +1,18 @@
 package com.mineinabyss.idofront
 
 import com.mineinabyss.idofront.di.DI
+import com.mineinabyss.idofront.plugin.Services
 import com.mineinabyss.idofront.plugin.listeners
 import com.mineinabyss.idofront.serialization.recipes.options.IngredientOptionsListener
+import com.mineinabyss.idofront.services.SerializableItemStackService
+import com.mineinabyss.idofront.services.impl.SerializableItemStackServiceImpl
 import org.bukkit.plugin.java.JavaPlugin
 
 class IdofrontPlugin : JavaPlugin() {
+    override fun onLoad() {
+        Services.register<SerializableItemStackService>(this, SerializableItemStackServiceImpl())
+    }
+
     override fun onEnable() {
         val recipeOptionsListener = IngredientOptionsListener(this)
         DI.add(recipeOptionsListener)

idofront-catalog-shaded/src/main/java/com/mineinabyss/idofront/services/impl/SerializableItemStackServiceImpl.kt

@@ -0,0 +1,26 @@
+package com.mineinabyss.idofront.services.impl
+
+import com.mineinabyss.idofront.messaging.idofrontLogger
+import com.mineinabyss.idofront.services.ItemProvider
+import com.mineinabyss.idofront.services.SerializableItemStackService
+
+class SerializableItemStackServiceImpl : SerializableItemStackService {
+    val extensions = mutableMapOf<String, ItemProvider>()
+
+    override fun registerProvider(prefix: String, provider: ItemProvider) {
+        if (prefix.contains(" ")) {
+            error("Cannot register item provider with space in prefix: $prefix")
+        }
+
+        // Print warning with strack trace to know which plugin is causing this issue.
+        if (extensions.containsKey(prefix)) {
+            idofrontLogger.w { IllegalStateException("An item provider with prefix '$prefix' was already registered").stackTraceToString() }
+        } else {
+            extensions[prefix] = provider
+        }
+    }
+
+    override fun getProvider(prefix: String): ItemProvider? {
+        return extensions[prefix]
+    }
+}

idofront-serializers/build.gradle.kts

@@ -9,13 +9,10 @@ dependencies {
     compileOnly(libs.kotlin.reflect)
     compileOnly(libs.kotlinx.serialization.json)
     compileOnly(libs.kotlinx.serialization.kaml)
-    compileOnly(libs.minecraft.plugin.mythic.dist)
-    compileOnly(libs.minecraft.plugin.mythic.crucible)
-    compileOnly(libs.minecraft.plugin.nexo)
-    compileOnly(libs.minecraft.plugin.itemsadder)
     compileOnly(libs.creative.api) { isTransitive = true }
     implementation(projects.idofrontUtil)
     implementation(projects.idofrontLogging)
     implementation(projects.idofrontTextComponents)
     implementation(projects.idofrontDi)
+    implementation(projects.idofrontServices)
 }

idofront-serializers/src/main/kotlin/com/mineinabyss/idofront/serialization/MaterialByNameSerializer.kt

@@ -20,5 +20,4 @@ object MaterialByNameSerializer : KSerializer<Material> {
         val name = decoder.decodeString()
         return Material.matchMaterial(name) ?: error("Material $name does not exist")
     }
-
 }

idofront-serializers/src/main/kotlin/com/mineinabyss/idofront/serialization/SerializableItemStack.kt

@@ -2,35 +2,23 @@
 
 package com.mineinabyss.idofront.serialization
 
-import com.mineinabyss.idofront.di.DI
 import com.mineinabyss.idofront.messaging.idofrontLogger
-import com.mineinabyss.idofront.plugin.Plugins
+import com.mineinabyss.idofront.plugin.Services
 import com.mineinabyss.idofront.serialization.recipes.options.IngredientOption
+import com.mineinabyss.idofront.services.SerializableItemStackService
 import com.mineinabyss.idofront.textcomponents.miniMsg
 import com.mineinabyss.idofront.textcomponents.serialize
-import com.nexomc.nexo.NexoPlugin
-import com.nexomc.nexo.api.NexoItems
-import dev.lone.itemsadder.api.CustomStack
-import io.lumine.mythiccrucible.MythicCrucible
 import io.papermc.paper.datacomponent.DataComponentType
 import io.papermc.paper.datacomponent.DataComponentTypes
 import io.papermc.paper.datacomponent.item.ItemLore
 import io.papermc.paper.datacomponent.item.MapDecorations
 import io.papermc.paper.item.MapPostProcessing
 import io.papermc.paper.registry.RegistryAccess
 import io.papermc.paper.registry.RegistryKey
-import kotlinx.serialization.Contextual
 import kotlinx.serialization.*
 import kotlinx.serialization.EncodeDefault.Mode.NEVER
 import net.kyori.adventure.key.Key
-import net.kyori.adventure.text.Component
-import net.kyori.adventure.text.format.TextDecoration
-import org.bukkit.Art
-import org.bukkit.Bukkit
-import org.bukkit.Keyed
-import org.bukkit.Material
-import org.bukkit.NamespacedKey
-import org.bukkit.Registry
+import org.bukkit.*
 import org.bukkit.inventory.ItemRarity
 import org.bukkit.inventory.ItemStack
 import org.bukkit.inventory.RecipeChoice
@@ -40,11 +28,14 @@ typealias SerializableItemStack = @Serializable(with = SerializableItemStackSeri
 /**
  * A wrapper for [ItemStack] that uses [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization).
  * Allows for easy-to-use serialization to JSON (or YAML with kaml).
+ *
+ * @param type The item type to inherit a baseline configuration from, other plugins may register extra providers for this.
  */
 @Suppress("UnstableApiUsage")
 @Serializable
 data class BaseSerializableItemStack(
-    @EncodeDefault(NEVER) val type: @Serializable(with = MaterialByNameSerializer::class) Material? = null,
+    @EncodeDefault(NEVER) val material: @Serializable(with = MaterialByNameSerializer::class) Material? = null,
+    @EncodeDefault(NEVER) val type: String? = null,
     @EncodeDefault(NEVER) val amount: Int? = null,
     @EncodeDefault(NEVER) val customModelData: SerializableDataTypes.CustomModelData? = null,
     @EncodeDefault(NEVER) val itemModel: @Serializable(KeySerializer::class) Key? = null,
@@ -103,75 +94,46 @@ data class BaseSerializableItemStack(
     @EncodeDefault(NEVER) val noteBlockSound: @Serializable(KeySerializer::class) Key? = null,
     @EncodeDefault(NEVER) val potDecorations: SerializableDataTypes.PotDecorations? = null,
 
-
-    @EncodeDefault(NEVER) val prefab: String? = null,
     @EncodeDefault(NEVER) val tag: @Serializable(NamespacedKeySerializer::class) NamespacedKey? = null,
     @EncodeDefault(NEVER) val recipeOptions: List<IngredientOption> = listOf(),
 
     // Unvalued DataTypes
     @EncodeDefault(NEVER) @Contextual val intangibleProjectile: SerializableDataTypes.IntangibleProjectile? = null,
     @EncodeDefault(NEVER) @Contextual val glider: SerializableDataTypes.Glider? = null,
     @EncodeDefault(NEVER) val unbreakable: SerializableDataTypes.Unbreakable? = null,
-
-    // Third-party plugins
-    @EncodeDefault(NEVER) val crucibleItem: String? = null,
-    @EncodeDefault(NEVER) val nexoItem: String? = null,
-    @EncodeDefault(NEVER) val itemsadderItem: String? = null,
 ) {
-    private fun Component.removeItalics() =
-        Component.text().decoration(TextDecoration.ITALIC, false).build().append(this)
-
-    @Transient val itemName = _itemName?.miniMsg()
-    @Transient val customName = _customName?.miniMsg()
-    @Transient val lore = _lore?.map { it.miniMsg() }
+    @Transient
+    val itemName = _itemName?.miniMsg()
+
+    @Transient
+    val customName = _customName?.miniMsg()
+
+    @Transient
+    val lore = _lore?.map { it.miniMsg() }
+
+    @Transient
+    val itemProvider = type?.let {
+        val provider = Services
+            .getOrNull<SerializableItemStackService>()
+            ?.getProvider(it.substringBefore(' ', missingDelimiterValue = ""))
+        if (provider == null) idofrontLogger.w { "Item provider for '$type' could not be found." }
+        provider
+    }
 
     /**
      * Converts this serialized item's data to an [ItemStack], optionally applying the changes to an
      * [existing item][applyTo].
      */
-    fun toItemStack(applyTo: ItemStack = ItemStack.of(type ?: Material.AIR)): ItemStack {
-        // Import ItemStack from Crucible
-        crucibleItem?.let { id ->
-            if (Plugins.isEnabled<MythicCrucible>()) {
-                MythicCrucible.core().itemManager.getItemStack(id)?.let {
-                    applyTo.type = it.type
-                    applyTo.itemMeta = it.itemMeta
-                } ?: idofrontLogger.w("No Crucible item found with id $id")
-            } else {
-                idofrontLogger.w("Tried to import Crucible item, but MythicCrucible was not enabled")
-            }
-        }
-
-        // Import ItemStack from Nexo
-        nexoItem?.let { id ->
-            if (Plugins.isEnabled<NexoPlugin>()) {
-                NexoItems.itemFromId(id)?.build()?.let {
-                    applyTo.type = it.type
-                    applyTo.itemMeta = it.itemMeta
-                } ?: idofrontLogger.w("No Nexo item found with id $id")
-            } else {
-                idofrontLogger.w("Tried to import Nexo item, but Nexo was not enabled")
-            }
+    fun toItemStack(applyTo: ItemStack = ItemStack.of(material ?: Material.AIR)): ItemStack {
+        if (type != null && itemProvider != null) {
+            val definition = type.substringAfter(' ')
+            val success = itemProvider.invoke(applyTo, definition)
+            if (!success) idofrontLogger.w { "Item provider for '$type' could not find such item." }
         }
 
-        // Import ItemStack from ItemsAdder
-        itemsadderItem?.let { id ->
-            if (Plugins.isEnabled("ItemsAdder")) {
-                CustomStack.getInstance(id)?.itemStack?.let {
-                    applyTo.type = it.type
-                    applyTo.itemMeta = it.itemMeta
-                } ?: idofrontLogger.w("No ItemsAdder item found with id $id")
-            } else {
-                idofrontLogger.w("Tried to import ItemsAdder item, but ItemsAdder was not enabled")
-            }
-        }
-
-        // Support for our prefab system in geary.
-        prefab?.let { encodePrefab.invoke(applyTo, it) } ?: applyTo
-
         // Modify item
         amount?.let { applyTo.amount = it }
-        type?.let { applyTo.type = type }
+        material?.let { applyTo.type = material }
 
         SerializableDataTypes.setData(applyTo, DataComponentTypes.ITEM_NAME, itemName)
         SerializableDataTypes.setData(applyTo, DataComponentTypes.CUSTOM_NAME, customName)
@@ -237,7 +199,7 @@ data class BaseSerializableItemStack(
         return applyTo
     }
 
-    fun toItemStackOrNull(applyTo: ItemStack = ItemStack(type ?: Material.AIR)) =
+    fun toItemStackOrNull(applyTo: ItemStack = ItemStack(material ?: Material.AIR)) =
         toItemStack(applyTo).takeUnless { it.isEmpty }
 
     fun toRecipeChoice(): RecipeChoice = toItemStackOrNull()?.let(RecipeChoice::ExactChoice) ?: RecipeChoice.empty()
@@ -246,11 +208,6 @@ data class BaseSerializableItemStack(
     fun matches(item: ItemStack): Boolean {
         return item == toItemStack(applyTo = item.clone())
     }
-
-    companion object {
-        @Suppress("UNCHECKED_CAST")
-        private val encodePrefab by DI.observe<SerializablePrefabItemService>()
-    }
 }
 
 /**
@@ -260,7 +217,7 @@ data class BaseSerializableItemStack(
  */
 fun ItemStack.toSerializable(): SerializableItemStack = with(itemMeta) {
     SerializableItemStack(
-        type = type,
+        material = type,
         amount = amount.takeIf { it != 1 },
         _itemName = dataIfOverriden(DataComponentTypes.ITEM_NAME)?.serialize(),
         _customName = dataIfOverriden(DataComponentTypes.CUSTOM_NAME)?.serialize(),
@@ -319,7 +276,6 @@ fun ItemStack.toSerializable(): SerializableItemStack = with(itemMeta) {
 
         intangibleProjectile = SerializableDataTypes.IntangibleProjectile.takeIf { hasData(DataComponentTypes.INTANGIBLE_PROJECTILE) },
         unbreakable = SerializableDataTypes.Unbreakable.takeIf { hasData(DataComponentTypes.UNBREAKABLE) },
-
     )
 }
 

idofront-serializers/src/main/kotlin/com/mineinabyss/idofront/serialization/SerializableItemStackSerializer.kt

@@ -1,21 +1,15 @@
 package com.mineinabyss.idofront.serialization
 
 import com.charleskorn.kaml.YamlInput
-import com.charleskorn.kaml.YamlList
 import com.charleskorn.kaml.YamlScalar
 import kotlinx.serialization.ContextualSerializer
-import kotlinx.serialization.InternalSerializationApi
 import kotlinx.serialization.KSerializer
-import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
-import kotlinx.serialization.encoding.decodeStructure
 import org.bukkit.Material
 
 class SerializableItemStackSerializer : KSerializer<SerializableItemStack> {
-    //    override val descriptor: SerialDescriptor = BaseSerializableItemStack.serializer().descriptor
-    override val descriptor: SerialDescriptor =
-        ContextualSerializer(BaseSerializableItemStack::class).descriptor
+    override val descriptor = ContextualSerializer(BaseSerializableItemStack::class).descriptor
 
     override fun deserialize(decoder: Decoder): SerializableItemStack {
         val node = (decoder as? YamlInput)?.node ?: return BaseSerializableItemStack.serializer().deserialize(decoder)
@@ -34,20 +28,12 @@ class SerializableItemStackSerializer : KSerializer<SerializableItemStack> {
 
     fun decodeFromShorthand(stringShorthand: String) = when {
         stringShorthand.startsWith("minecraft:") -> BaseSerializableItemStack(
-            type = Material.matchMaterial(
-                stringShorthand
-            )
+            material = Material.matchMaterial(stringShorthand)
         )
 
-        stringShorthand.startsWith("crucible ") -> BaseSerializableItemStack(
-            crucibleItem = stringShorthand.removePrefix("crucible ")
-        )
-
-        stringShorthand.startsWith("nexo ") -> BaseSerializableItemStack(
-            nexoItem = stringShorthand.removePrefix("nexo ")
-        )
-
-        else -> BaseSerializableItemStack(prefab = stringShorthand)
+        else -> {
+            BaseSerializableItemStack(type = stringShorthand)
+        }
     }
 
     override fun serialize(encoder: Encoder, value: SerializableItemStack) {