feat: Add support for transparent name tags and update related config…

gradle.properties

@@ -1,4 +1,4 @@
 kotlin.code.style=official
 kotlin.stdlib.default.dependency=false
 org.gradle.parallel=true
-version=1.6.6
+version=1.6.7

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,9 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.0-bin.zip
 networkTimeout=10000
+retries=0
+retryBackOffMs=500
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
+zipStorePath=wrapper/dists

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/SurfNpcApi.kt

@@ -21,6 +21,7 @@ interface SurfNpcApi {
         displayName: Component,
         uniqueName: String,
         type: EntityType,
+        useTransparentBackground: Boolean = false,
         location: Location,
         viewers: ObjectSet<UUID>? = null,
         rotationType: NpcRotationType = NpcRotationType.PER_PLAYER,

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/dsl/NpcDslBuilder.kt

@@ -40,6 +40,8 @@ class NpcDslBuilder {
 
     lateinit var type: EntityType
 
+    var useTransparentNametagBackground = false
+
     /**
      * The location of the NPC.
      */
@@ -105,6 +107,10 @@ class NpcDslBuilder {
         this.scale = scale
     }
 
+    fun useTransparentNametagBackground(useTransparentNametagBackground: Boolean = true) {
+        this.useTransparentNametagBackground = useTransparentNametagBackground
+    }
+
 
     /**
      * Configures the skin of the NPC using a DSL block.
@@ -171,11 +177,12 @@ fun npc(block: NpcDslBuilder.() -> Unit): Npc {
         displayName = SurfComponentBuilder.builder().apply(builder.displayName).build(),
         uniqueName = builder.uniqueName,
         type = builder.type,
-        skin = builder.skin,
+        useTransparentBackground = builder.useTransparentNametagBackground,
         location = builder.location,
         viewers = builder.viewers,
         rotationType = builder.rotationType,
         persistent = builder.persistent,
+        skin = builder.skin,
     )
 
     npc.setScale(builder.scale)

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/npc/Npc.kt

@@ -41,6 +41,7 @@ data class Npc(
     val npcUuid: UUID,
     val nameTagId: Int,
     val nameTagUuid: UUID,
+    val transparentNameTag: Boolean,
     val properties: Object2ObjectMap<String, NpcProperty>,
     val viewers: ObjectSet<UUID>?,
     val npcSittingId: Int,

surf-npc-example-dsl/src/main/kotlin/dev/slne/surf/npc/example/SurfNpcExamplePlugin.kt

@@ -58,6 +58,8 @@ class SurfNpcExamplePlugin() : SuspendingJavaPlugin() {
                 }
             }
 
+            useTransparentNametagBackground()
+
             scale(2.0)
 
             /**

surf-npc-example/src/main/kotlin/dev/slne/surf/npc/example/SurfNpcExamplePlugin.kt

@@ -6,7 +6,6 @@ import dev.slne.surf.npc.api.SurfNpcApi
 import dev.slne.surf.npc.api.event.NpcInteractEvent
 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.skin.NpcSkin
 import dev.slne.surf.npc.api.util.addEventHandler
 import dev.slne.surf.npc.example.listener.ExampleNpcListener
 import net.kyori.adventure.text.minimessage.MiniMessage
@@ -23,8 +22,7 @@ class SurfNpcExamplePlugin : SuspendingJavaPlugin() {
                 .deserialize("<rainbow>Example Npc by surf-npc-example"),
             uniqueName = "example_npc",
             type = EntityType.MANNEQUIN,
-            location = Location(Bukkit.getWorlds().first(), 0.0, 0.0, 0.0),
-            skin = NpcSkin.empty()
+            location = Location(Bukkit.getWorlds().first(), 0.0, 0.0, 0.0)
         )
 
         SurfNpcApi.addProperty(

surf-npc-paper/src/main/kotlin/dev/slne/surf/npc/paper/PaperPackets.kt

@@ -185,14 +185,22 @@ sealed class BukkitPackets {
             )
         }
 
-        data class NameTagMetaDataPacket(val entityId: Int, val displayName: Component) :
+        data class NameTagMetaDataPacket(
+            val entityId: Int,
+            val displayName: Component,
+            val transparentBackground: Boolean
+        ) :
             NpcNameTagPackets() {
             override fun build() = WrapperPlayServerEntityMetadata(
                 entityId,
-                listOf(
-                    buildMetaData(23, EntityDataTypes.ADV_COMPONENT, displayName),
-                    buildMetaData(15, EntityDataTypes.BYTE, 3.toByte())
-                )
+                buildList {
+                    add(buildMetaData(23, EntityDataTypes.ADV_COMPONENT, displayName))
+                    add(buildMetaData(15, EntityDataTypes.BYTE, 3.toByte()))
+
+                    if (transparentBackground) {
+                        add(buildMetaData(25, EntityDataTypes.INT, 0))
+                    }
+                }
             )
         }
 

surf-npc-paper/src/main/kotlin/dev/slne/surf/npc/paper/api/PaperSurfNpcApi.kt

@@ -28,6 +28,7 @@ class PaperSurfNpcApi : SurfNpcApi, Services.Fallback {
         displayName: Component,
         uniqueName: String,
         type: EntityType,
+        useTransparentBackground: Boolean,
         location: Location,
         viewers: ObjectSet<UUID>?,
         rotationType: NpcRotationType,
@@ -37,6 +38,7 @@ class PaperSurfNpcApi : SurfNpcApi, Services.Fallback {
         displayName,
         uniqueName,
         type,
+        useTransparentBackground,
         location,
         viewers,
         rotationType,

surf-npc-paper/src/main/kotlin/dev/slne/surf/npc/paper/config/NpcConfig.kt

@@ -11,6 +11,7 @@ data class NpcConfig(
     var entityType: EntityType = EntityType.ZOMBIE,
     var nameTagId: Int = 0,
     var nameTagUuid: UUID = UUID.randomUUID(),
+    var transparentNameTag: Boolean = false,
     var uniqueName: String = "",
     var sittingId: Int = 0,
     var sittingUuid: UUID = UUID.randomUUID(),

surf-npc-paper/src/main/kotlin/dev/slne/surf/npc/paper/controller/NpcController.kt

@@ -49,6 +49,7 @@ class NpcController {
         displayName: Component,
         uniqueName: String,
         type: EntityType,
+        useTransparentBackground: Boolean = false,
         location: Location,
         viewers: ObjectSet<UUID>? = null,
         rotationType: NpcRotationType = NpcRotationType.PER_PLAYER,
@@ -62,6 +63,7 @@ class NpcController {
             npcUuid = UUID.randomUUID(),
             nameTagId = random.nextInt(),
             nameTagUuid = UUID.randomUUID(),
+            useTransparentBackground,
             properties = mutableObject2ObjectMapOf<String, NpcProperty>(),
             viewers = viewers,
             npcSittingId = npcs.size + 1,
@@ -153,7 +155,8 @@ class NpcController {
         ).build().sendPacket(uuid)
         BukkitPackets.NpcNameTagPackets.NameTagMetaDataPacket(
             npc.nameTagId,
-            npc.getDisplayName()
+            npc.getDisplayName(),
+            npc.transparentNameTag
         ).build()
             .sendPacket(uuid)
 

surf-npc-paper/src/main/kotlin/dev/slne/surf/npc/paper/service/StorageService.kt

@@ -52,7 +52,8 @@ class NpcStorageService {
                     npcSittingUuid = config.sittingUuid,
                     viewers = if (config.viewerAmount == -1) null
                     else config.viewers.toMutableObjectSet(),
-                    properties = mutableObject2ObjectMapOf()
+                    properties = mutableObject2ObjectMapOf(),
+                    transparentNameTag = config.transparentNameTag
                 )
 
                 config.properties.forEach { (key, prop) ->
@@ -89,6 +90,7 @@ class NpcStorageService {
             npcUuid = npc.npcUuid
             nameTagId = npc.nameTagId
             nameTagUuid = npc.nameTagUuid
+            transparentNameTag = npc.transparentNameTag
             uniqueName = npc.uniqueName
             sittingId = npc.npcSittingId
             sittingUuid = npc.npcSittingUuid