Merge pull request #12 from SLNE-Development/feat/9-improve-skin-handling

TheBjoRedCraft · web-flow · commit 502953890ee8 · 2025-08-04T17:07:16.000Z
Feat/9 improve skin handling
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
 kotlin.code.style=official
 kotlin.stdlib.default.dependency=false
 org.gradle.parallel=true
-version=1.21.7-1.2.1-SNAPSHOT
+version=1.21.7-1.3.0-SNAPSHOT
diff --git a/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/SurfNpcApi.kt b/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/SurfNpcApi.kt
@@ -8,8 +8,10 @@ import dev.slne.surf.npc.api.npc.property.NpcPropertyType
 import dev.slne.surf.npc.api.npc.rotation.NpcRotation
 import dev.slne.surf.npc.api.npc.rotation.NpcRotationType
 import dev.slne.surf.npc.api.npc.skin.NpcSkin
+import dev.slne.surf.npc.api.npc.skin.NpcSkinPart
 import dev.slne.surf.npc.api.result.NpcCreationResult
 import dev.slne.surf.npc.api.result.NpcDeletionResult
+import dev.slne.surf.surfapi.core.api.util.objectSetOf
 import dev.slne.surf.surfapi.core.api.util.requiredService
 import it.unimi.dsi.fastutil.objects.ObjectList
 import it.unimi.dsi.fastutil.objects.ObjectSet
@@ -197,7 +199,8 @@ interface SurfNpcApi {
     fun createSkinData(
         owner: String,
         value: String,
-        signature: String
+        signature: String,
+        parts: ObjectSet<NpcSkinPart> = objectSetOf(NpcSkinPart.entries)
     ): NpcSkin
 
     /**
diff --git a/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/dsl/NpcDslSubBuilders.kt b/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/dsl/NpcDslSubBuilders.kt
@@ -5,7 +5,11 @@ import dev.slne.surf.npc.api.npc.property.NpcProperty
 import dev.slne.surf.npc.api.npc.property.NpcPropertyType
 import dev.slne.surf.npc.api.npc.rotation.NpcRotation
 import dev.slne.surf.npc.api.npc.skin.NpcSkin
+import dev.slne.surf.npc.api.npc.skin.NpcSkinPart
 import dev.slne.surf.npc.api.surfNpcApi
+import dev.slne.surf.surfapi.core.api.util.objectSetOf
+import dev.slne.surf.surfapi.core.api.util.toObjectSet
+import it.unimi.dsi.fastutil.objects.ObjectSet
 
 /**
  * Builder class for creating NPC skins.
@@ -26,6 +30,11 @@ class SkinBuilder {
      */
     lateinit var signature: String
 
+    /**
+     * The parts of the skin, represented as a set of `NpcSkinPart`.
+     */
+    var parts: ObjectSet<NpcSkinPart> = NpcSkinPart.entries.toObjectSet()
+
     /**
      * Builds the NPC skin.
      *
@@ -35,6 +44,7 @@ class SkinBuilder {
         override val ownerName = this@SkinBuilder.ownerName
         override val value = this@SkinBuilder.value
         override val signature = this@SkinBuilder.signature
+        override val parts = this@SkinBuilder.parts
     }
 }
 
diff --git a/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/property/NpcProperty.kt b/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/property/NpcProperty.kt
@@ -19,19 +19,9 @@ interface NpcProperty {
         const val DISPLAYNAME = "displayname"
 
         /**
-         * The owner of the NPC's skin.
+         * The skin data of the NPC.
          */
-        const val SKIN_OWNER = "skin_owner"
-
-        /**
-         * The texture of the NPC's skin.
-         */
-        const val SKIN_TEXTURE = "skin_texture"
-
-        /**
-         * The signature of the NPC's skin.
-         */
-        const val SKIN_SIGNATURE = "skin_signature"
+        const val SKIN_DATA = "skin_data"
 
         /**
          * The location of the NPC.
diff --git a/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/property/NpcPropertyType.kt b/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/property/NpcPropertyType.kt
@@ -83,5 +83,10 @@ interface NpcPropertyType {
          * Represents a rotation property type for an NPC.
          */
         const val NPC_ROTATION = "npc_rotation"
+
+        /**
+         * Represents a skin data property type for an NPC.
+         */
+        const val SKIN_DATA = "skin_data"
     }
 }
diff --git a/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/skin/NpcSkin.kt b/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/skin/NpcSkin.kt
@@ -1,5 +1,7 @@
 package dev.slne.surf.npc.api.npc.skin
 
+import it.unimi.dsi.fastutil.objects.ObjectSet
+
 /**
  * Data class representing the skin data of an NPC.
  *
@@ -10,4 +12,17 @@ interface NpcSkin {
     val ownerName: String
     val value: String
     val signature: String
+    val parts: ObjectSet<NpcSkinPart>
+
+    fun skinByte(): Byte {
+        var skinByte = 0
+        if (NpcSkinPart.CAPE in parts) skinByte = skinByte or 0x01
+        if (NpcSkinPart.JACKET in parts) skinByte = skinByte or 0x02
+        if (NpcSkinPart.LEFT_SLEEVES in parts) skinByte = skinByte or 0x04
+        if (NpcSkinPart.RIGHT_SLEEVES in parts) skinByte = skinByte or 0x08
+        if (NpcSkinPart.LEFT_PANTS_LEG in parts) skinByte = skinByte or 0x10
+        if (NpcSkinPart.RIGHT_PANTS_LEG in parts) skinByte = skinByte or 0x20
+        if (NpcSkinPart.HAT in parts) skinByte = skinByte or 0x40
+        return skinByte.toByte()
+    }
 }
diff --git a/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/skin/NpcSkinPart.kt b/surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/skin/NpcSkinPart.kt
@@ -0,0 +1,11 @@
+package dev.slne.surf.npc.api.npc.skin
+
+enum class NpcSkinPart {
+    HAT,
+    JACKET,
+    LEFT_SLEEVES,
+    RIGHT_SLEEVES,
+    LEFT_PANTS_LEG,
+    RIGHT_PANTS_LEG,
+    CAPE;
+}
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/BukkitMain.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/BukkitMain.kt
@@ -32,6 +32,7 @@ class BukkitMain : SuspendingJavaPlugin() {
         propertyTypeRegistry.register(UuidPropertyType(NpcPropertyType.Types.UUID))
         propertyTypeRegistry.register(NamedTextColorPropertyType(NpcPropertyType.Types.NAMED_TEXT_COLOR))
         propertyTypeRegistry.register(NpcRotationPropertyType(NpcPropertyType.Types.NPC_ROTATION))
+        propertyTypeRegistry.register(SkinDataPropertyType(NpcPropertyType.Types.SKIN_DATA))
 
         storageService.initialize()
         storageService.loadNpcs()
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/BukkitPackets.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/BukkitPackets.kt
@@ -27,10 +27,10 @@ fun createPlayerInfoPacket(profile: UserProfile, displayName: Component, listed:
         )
     )
 
-fun createEntityMetadataPacket(npcEntityId: Int) = WrapperPlayServerEntityMetadata(
+fun createEntityMetadataPacket(npcEntityId: Int, skinParts: Byte = 0x7F.toByte()) = WrapperPlayServerEntityMetadata(
     npcEntityId,
     listOf(
-        EntityData(17, EntityDataTypes.BYTE, 0x7F.toByte()),
+        EntityData(17, EntityDataTypes.BYTE, skinParts),
         EntityData(0, EntityDataTypes.BYTE, 0x02.toByte()),
     )
 )
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/api/BukkitSurfNpcApi.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/api/BukkitSurfNpcApi.kt
@@ -10,12 +10,13 @@ import dev.slne.surf.npc.api.npc.property.NpcPropertyType
 import dev.slne.surf.npc.api.npc.rotation.NpcRotation
 import dev.slne.surf.npc.api.npc.rotation.NpcRotationType
 import dev.slne.surf.npc.api.npc.skin.NpcSkin
+import dev.slne.surf.npc.api.npc.skin.NpcSkinPart
 import dev.slne.surf.npc.api.result.NpcCreationResult
 import dev.slne.surf.npc.api.result.NpcDeletionResult
 import dev.slne.surf.npc.bukkit.npc.location.BukkitNpcLocation
 import dev.slne.surf.npc.bukkit.npc.property.BukkitNpcProperty
 import dev.slne.surf.npc.bukkit.npc.rotation.BukkitNpcRotation
-import dev.slne.surf.npc.bukkit.npc.skin.BukkitSNpcSkinData
+import dev.slne.surf.npc.bukkit.npc.skin.BukkitNpcSkin
 import dev.slne.surf.npc.bukkit.util.skinDataFromName
 import dev.slne.surf.npc.core.controller.npcController
 import dev.slne.surf.npc.core.property.propertyTypeRegistry
@@ -137,9 +138,10 @@ class BukkitSurfNpcApi : SurfNpcApi, Services.Fallback {
     override fun createSkinData(
         owner: String,
         value: String,
-        signature: String
+        signature: String,
+        parts: ObjectSet<NpcSkinPart>
     ): NpcSkin {
-        return BukkitSNpcSkinData(owner, value, signature)
+        return BukkitNpcSkin(owner, value, signature, parts)
     }
 
     override fun createLocation(
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/command/sub/NpcInfoCommand.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/command/sub/NpcInfoCommand.kt
@@ -6,6 +6,7 @@ import dev.jorel.commandapi.kotlindsl.playerExecutor
 import dev.slne.surf.npc.api.npc.Npc
 import dev.slne.surf.npc.api.npc.location.NpcLocation
 import dev.slne.surf.npc.api.npc.property.NpcProperty
+import dev.slne.surf.npc.api.npc.skin.NpcSkin
 import dev.slne.surf.npc.bukkit.command.argument.npcArgument
 import dev.slne.surf.npc.bukkit.util.PermissionRegistry
 import dev.slne.surf.npc.bukkit.util.readableString
@@ -31,8 +32,8 @@ class NpcInfoCommand(commandName: String) : CommandAPICommand(commandName) {
             val rotationType =
                 npc.getPropertyValue(NpcProperty.Internal.ROTATION_TYPE, Boolean::class)
                     ?: error("NPC ${npc.uniqueName} has no rotation type set")
-            val skinOwner = npc.getPropertyValue(NpcProperty.Internal.SKIN_OWNER, String::class)
-                ?: error("NPC ${npc.uniqueName} has no skin owner set")
+            val skinData = npc.getPropertyValue(NpcProperty.Internal.SKIN_DATA, NpcSkin::class)
+                ?: error("NPC ${npc.uniqueName} has no skin data set")
             val global =
                 npc.getPropertyValue(NpcProperty.Internal.VISIBILITY_GLOBAL, Boolean::class)
                     ?: error("NPC ${npc.uniqueName} has no global visibility set")
@@ -108,7 +109,7 @@ class NpcInfoCommand(commandName: String) : CommandAPICommand(commandName) {
                     decorate(TextDecoration.BOLD)
                 }
                 variableKey("Skin: ")
-                variableValue(skinOwner)
+                variableValue(skinData.ownerName)
                 appendNewline()
 
                 append {
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/command/sub/edit/NpcEditSkinCommand.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/command/sub/edit/NpcEditSkinCommand.kt
@@ -38,23 +38,9 @@ class NpcEditSkinCommand(commandName: String) : CommandAPICommand(commandName) {
 
                 npc.addProperty(
                     BukkitNpcProperty(
-                        NpcProperty.Internal.SKIN_OWNER,
-                        skinData.ownerName,
-                        propertyTypeRegistry.get(NpcPropertyType.Types.STRING) ?: return@launch
-                    )
-                )
-                npc.addProperty(
-                    BukkitNpcProperty(
-                        NpcProperty.Internal.SKIN_TEXTURE,
-                        skinData.value,
-                        propertyTypeRegistry.get(NpcPropertyType.Types.STRING) ?: return@launch
-                    )
-                )
-                npc.addProperty(
-                    BukkitNpcProperty(
-                        NpcProperty.Internal.SKIN_SIGNATURE,
-                        skinData.signature,
-                        propertyTypeRegistry.get(NpcPropertyType.Types.STRING) ?: return@launch
+                        NpcProperty.Internal.SKIN_DATA,
+                        skinData,
+                        propertyTypeRegistry.get(NpcPropertyType.Types.SKIN_DATA) ?: return@launch
                     )
                 )
                 npc.refresh()
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/controller/BukkitNpcController.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/controller/BukkitNpcController.kt
@@ -90,19 +90,16 @@ class BukkitNpcController : NpcController, Services.Fallback {
         val namedTextColorType = propertyTypeRegistry.get(
             NpcPropertyType.Types.NAMED_TEXT_COLOR
         ) ?: error("NAMED_TEXT_COLOR property type not found")
+        val skinDataType = propertyTypeRegistry.get(
+            NpcPropertyType.Types.SKIN_DATA
+        ) ?: error("SKIN_DATA property type not found")
 
         npc.addProperties(
             Triple(
             NpcProperty.Internal.DISPLAYNAME, displayName, componentType
             ),
             Triple(
-                NpcProperty.Internal.SKIN_OWNER, skinData.ownerName, stringType
-            ),
-            Triple(
-                NpcProperty.Internal.SKIN_TEXTURE, skinData.value, stringType
-            ),
-            Triple(
-                NpcProperty.Internal.SKIN_SIGNATURE, skinData.signature, stringType
+                NpcProperty.Internal.SKIN_DATA, skinData, skinDataType
             ),
             Triple(
                 NpcProperty.Internal.LOCATION, location, npcLocationType
@@ -238,23 +235,9 @@ class BukkitNpcController : NpcController, Services.Fallback {
     ) {
         npc.addProperty(
             BukkitNpcProperty(
-                NpcProperty.Internal.SKIN_OWNER, skin.ownerName, propertyTypeRegistry.get(
-                    NpcPropertyType.Types.STRING
-                ) ?: error("STRING property type not found")
-            )
-        )
-        npc.addProperty(
-            BukkitNpcProperty(
-                NpcProperty.Internal.SKIN_TEXTURE, skin.value, propertyTypeRegistry.get(
-                    NpcPropertyType.Types.STRING
-                ) ?: error("STRING property type not found")
-            )
-        )
-        npc.addProperty(
-            BukkitNpcProperty(
-                NpcProperty.Internal.SKIN_SIGNATURE, skin.signature, propertyTypeRegistry.get(
-                    NpcPropertyType.Types.STRING
-                ) ?: error("STRING property type not found")
+                NpcProperty.Internal.SKIN_DATA, skin, propertyTypeRegistry.get(
+                    NpcPropertyType.Types.SKIN_DATA
+                ) ?: error("SKIN_DATA property type not found")
             )
         )
     }
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/npc/BukkitNpc.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/npc/BukkitNpc.kt
@@ -15,6 +15,7 @@ import dev.slne.surf.npc.api.npc.property.NpcProperty
 import dev.slne.surf.npc.api.npc.property.NpcPropertyType
 import dev.slne.surf.npc.api.npc.rotation.NpcRotation
 import dev.slne.surf.npc.api.npc.rotation.NpcRotationType
+import dev.slne.surf.npc.api.npc.skin.NpcSkin
 import dev.slne.surf.npc.bukkit.*
 import dev.slne.surf.npc.bukkit.npc.location.BukkitNpcLocation
 import dev.slne.surf.npc.bukkit.npc.property.BukkitNpcProperty
@@ -56,10 +57,8 @@ class BukkitNpc(
             this.getPropertyValue(NpcProperty.Internal.DISPLAYNAME, Component::class) ?: return
         val profile = UserProfile(npcUuid, uniqueName)
 
-        val skinValue =
-            this.getPropertyValue(NpcProperty.Internal.SKIN_TEXTURE, String::class) ?: return
-        val skinSignature =
-            this.getPropertyValue(NpcProperty.Internal.SKIN_SIGNATURE, String::class) ?: return
+        val skinData =
+            this.getPropertyValue(NpcProperty.Internal.SKIN_DATA, NpcSkin::class) ?: return
 
         val rotation =
             this.getPropertyValue(NpcProperty.Internal.ROTATION_FIXED, NpcRotation::class) ?: return
@@ -73,8 +72,8 @@ class BukkitNpc(
         profile.textureProperties.add(
             TextureProperty(
                 "textures",
-                skinValue,
-                skinSignature
+                skinData.value,
+                skinData.signature
             )
         )
 
@@ -93,7 +92,7 @@ class BukkitNpc(
                 rotationPair.second
             )
         )
-        user.sendPacket(createEntityMetadataPacket(id))
+        user.sendPacket(createEntityMetadataPacket(id, skinData.skinByte()))
 
         user.sendPacket(createTeamCreatePacket("npc_$id", displayName))
         user.sendPacket(createTeamAddEntityPacket("npc_$id", uniqueName))
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/npc/property/impl/SkinDataPropertyType.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/npc/property/impl/SkinDataPropertyType.kt
@@ -0,0 +1,26 @@
+package dev.slne.surf.npc.bukkit.npc.property.impl
+
+import dev.slne.surf.npc.api.npc.property.NpcPropertyType
+import dev.slne.surf.npc.api.npc.skin.NpcSkin
+import dev.slne.surf.npc.api.npc.skin.NpcSkinPart
+import dev.slne.surf.npc.bukkit.npc.skin.BukkitNpcSkin
+import dev.slne.surf.surfapi.core.api.util.toObjectSet
+
+class SkinDataPropertyType(override val id: String) : NpcPropertyType {
+    override fun encode(value: Any): String {
+        require(value is NpcSkin) { "Expected NpcSkin, got ${value::class}" }
+        return "${value.ownerName}:${value.value}:${value.signature}:${value.parts.joinToString(",") { it.name }}"
+    }
+
+    override fun decode(value: String): NpcSkin {
+        return value.split(":").let {
+            require(it.size >= 3) { "Invalid skin data format: $value" }
+            val ownerName = it[0]
+            val skinValue = it[1]
+            val signature = it[2]
+            val parts = it.getOrNull(3)?.split(",")?.map { part -> NpcSkinPart.valueOf(part) } ?: emptyList()
+
+            BukkitNpcSkin(ownerName, skinValue, signature, parts.toObjectSet())
+        }
+    }
+}
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/npc/skin/BukkitNpcSkin.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/npc/skin/BukkitNpcSkin.kt
@@ -1,9 +1,12 @@
 package dev.slne.surf.npc.bukkit.npc.skin
 
 import dev.slne.surf.npc.api.npc.skin.NpcSkin
+import dev.slne.surf.npc.api.npc.skin.NpcSkinPart
+import it.unimi.dsi.fastutil.objects.ObjectSet
 
-data class BukkitSNpcSkinData(
+data class BukkitNpcSkin(
     override val ownerName: String,
     override val value: String,
-    override val signature: String
+    override val signature: String,
+    override val parts: ObjectSet<NpcSkinPart>
 ) : NpcSkin
diff --git a/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/util/npc-util.kt b/surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/util/npc-util.kt
diff --git a/surf-npc-example-dsl/src/main/kotlin/dev/slne/surf/npc/example/SurfNpcExamplePlugin.kt b/surf-npc-example-dsl/src/main/kotlin/dev/slne/surf/npc/example/SurfNpcExamplePlugin.kt

Original file line number	Diff line number	Diff line change
`@@ -83,5 +83,10 @@ interface NpcPropertyType {`
`83`	`83`	`* Represents a rotation property type for an NPC.`
`84`	`84`	`*/`
`85`	`85`	`const val NPC_ROTATION = "npc_rotation"`
	`86`	`+`
	`87`	`+ /**`
	`88`	`+ * Represents a skin data property type for an NPC.`
	`89`	`+ */`
	`90`	`+ const val SKIN_DATA = "skin_data"`
`86`	`91`	`}`
`87`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,10 @@ fun createPlayerInfoPacket(profile: UserProfile, displayName: Component, listed:`
`27`	`27`	`)`
`28`	`28`	`)`
`29`	`29`
`30`		`-fun createEntityMetadataPacket(npcEntityId: Int) = WrapperPlayServerEntityMetadata(`
	`30`	`+fun createEntityMetadataPacket(npcEntityId: Int, skinParts: Byte = 0x7F.toByte()) = WrapperPlayServerEntityMetadata(`
`31`	`31`	`npcEntityId,`
`32`	`32`	`listOf(`
`33`		`- EntityData(17, EntityDataTypes.BYTE, 0x7F.toByte()),`
	`33`	`+ EntityData(17, EntityDataTypes.BYTE, skinParts),`
`34`	`34`	`EntityData(0, EntityDataTypes.BYTE, 0x02.toByte()),`
`35`	`35`	`)`
`36`	`36`	`)`