Merge pull request #303 from DecentSoftware-eu/improvement/283-Reworking-the-NMS-implementation

Author: d0by1

build.gradle

@@ -1,72 +1,29 @@
-plugins {
-    id "java"
-    id "maven-publish"
-    id "com.github.johnrengelman.shadow" version "8.1.1"
-}
+subprojects {
+    apply plugin: "java"
 
-group = "eu.decentsoftware.holograms"
-version = "2.8.17"
-description = "A lightweight yet very powerful hologram plugin with many features and configuration options."
+    group = 'eu.decentsoftware.holograms'
 
-repositories {
-    mavenCentral()
-    maven { url = "https://oss.sonatype.org/content/repositories/snapshots" }
-    maven { url = "https://repo.codemc.io/repository/nms/" }
-    maven { url = "https://repo.codemc.io/repository/maven-public/" }
-    maven { url = "https://repo.extendedclip.com/content/repositories/placeholderapi/" }
-}
-
-dependencies {
-    compileOnly "org.spigotmc:spigot:1.13-R0.1-SNAPSHOT"
-    compileOnly "me.clip:placeholderapi:2.11.6"
-    compileOnly "com.arcaniax:HeadDatabase-API:1.3.2"
-
-    implementation "org.bstats:bstats-bukkit:3.1.0"
-    implementation "de.tr7zw:item-nbt-api:2.15.0"
-    implementation "com.github.cryptomorin:XSeries:13.0.0"
-
-    compileOnly "org.projectlombok:lombok:1.18.36"
-    annotationProcessor "org.projectlombok:lombok:1.18.36"
-    compileOnly "org.jetbrains:annotations:26.0.2"
-    annotationProcessor "org.jetbrains:annotations:26.0.2"
-}
-
-java {
-    withJavadocJar()
-    withSourcesJar()
-    toolchain {
-        languageVersion = JavaLanguageVersion.of(8)
+    repositories {
+        mavenCentral()
+        maven { url = "https://repo.codemc.io/repository/nms/" }
     }
-}
-
-compileJava {
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
-    options.encoding = "UTF-8"
-}
 
-processResources {
-    def props = [version: project.version, description: project.description]
-    inputs.properties(props)
-    filteringCharset = "UTF-8"
-    filesMatching("plugin.yml") {
-        expand(props)
+    dependencies {
+        if (!project.path.endsWith(":shared")) {
+            implementation project(":shared")
+        }
     }
-}
-
-shadowJar {
-    archiveClassifier.set("")
-
-    relocate "org.bstats", "eu.decentsoftware.holograms.metrics"
-    relocate "de.tr7zw.changeme.nbtapi", "eu.decentsoftware.holograms.libs.nbtapi"
-    relocate "com.cryptomorin.xseries", "eu.decentsoftware.holograms.libs.xseries"
-}
 
-publishing {
-    publications {
-        create("shadow", MavenPublication) {
-            from(components["java"] as SoftwareComponent)
-            artifactId = "decentholograms"
+    java {
+        withSourcesJar()
+        toolchain {
+            languageVersion = JavaLanguageVersion.of(8)
         }
     }
+
+    compileJava {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+        options.encoding = "UTF-8"
+    }
 }

gradle.properties

@@ -0,0 +1,5 @@
+# Gradle options
+org.gradle.daemon=true
+org.gradle.jvmargs=-Xmx512M
+org.gradle.parallel=true
+org.gradle.caching=true

gradle/libs.versions.toml

@@ -0,0 +1,36 @@
+[versions]
+spigot = "1.13-R0.1-SNAPSHOT"
+placeholderapi = "2.11.6"
+headdatabase-api = "1.3.2"
+bstats = "3.1.0"
+item-nbt-api = "2.14.1"
+xseries = "13.0.0"
+lombok = "1.18.36"
+annotations = "26.0.2"
+# Test
+junit = "5.12.0"
+junit-platform-launcher = "1.12.0"
+mockito = "4.11.0" # Has to be 4.x for Java 8 compatibility
+# Plugins
+shadow = "8.3.6"
+
+[libraries]
+spigot = { module = "org.spigotmc:spigot", version.ref = "spigot" }
+placeholderapi = { module = "me.clip:placeholderapi", version.ref = "placeholderapi" }
+headdatabase-api = { module = "com.arcaniax:HeadDatabase-API", version.ref = "headdatabase-api" }
+bstats-bukkit = { module = "org.bstats:bstats-bukkit", version.ref = "bstats" }
+item-nbt-api = { module = "de.tr7zw:item-nbt-api", version.ref = "item-nbt-api" }
+xseries = { module = "com.github.cryptomorin:XSeries", version.ref = "xseries" }
+lombok = { module = "org.projectlombok:lombok", version.ref = "lombok" }
+annotations = { module = "org.jetbrains:annotations", version.ref = "annotations" }
+# Test
+junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }
+junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" }
+junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" }
+junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher", version.ref = "junit-platform-launcher" }
+mockito-core = { module = "org.mockito:mockito-core", version.ref = "mockito" }
+mockito-inline = { module = "org.mockito:mockito-inline", version.ref = "mockito" }
+mockito-junit-jupiter = { module = "org.mockito:mockito-junit-jupiter", version.ref = "mockito" }
+
+[plugins]
+shadow = { id = "com.gradleup.shadow", version.ref = "shadow" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

nms/build.gradle

@@ -0,0 +1,38 @@
+subprojects {
+    dependencies {
+        if (!project.path.endsWith(":nms-common")) {
+            implementation project(":nms:nms-common")
+        }
+    }
+}
+
+dependencies {
+    childProjects.values().collect { child ->
+        implementation files("$rootDir/nms/${child.project.name}/build/libs/${child.project.name}.jar")
+    }
+}
+
+compileJava {
+    dependsOn childProjects.values().collect { child ->
+        child.tasks.named("jar")
+    }
+}
+
+sourceSets {
+    main {
+        java {
+            setSrcDirs([])
+        }
+        resources {
+            setSrcDirs([])
+        }
+    }
+    test {
+        java {
+            setSrcDirs([])
+        }
+        resources {
+            setSrcDirs([])
+        }
+    }
+}

nms/nms-common/build.gradle

@@ -0,0 +1,3 @@
+dependencies {
+    compileOnly(libs.spigot)
+}

nms/nms-common/src/main/java/eu/decentsoftware/holograms/nms/api/DecentHologramsNmsException.java

@@ -0,0 +1,19 @@
+package eu.decentsoftware.holograms.nms.api;
+
+import eu.decentsoftware.holograms.shared.DecentHologramsException;
+
+/**
+ * An exception that may be thrown by an NMS implementation.
+ *
+ * @author d0by
+ * @since 2.9.0
+ */
+public class DecentHologramsNmsException extends DecentHologramsException {
+    public DecentHologramsNmsException(String message) {
+        super(message);
+    }
+
+    public DecentHologramsNmsException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

nms/nms-common/src/main/java/eu/decentsoftware/holograms/nms/api/NmsAdapter.java

@@ -0,0 +1,40 @@
+package eu.decentsoftware.holograms.nms.api;
+
+import eu.decentsoftware.holograms.nms.api.renderer.NmsHologramRendererFactory;
+import org.bukkit.entity.Player;
+
+/**
+ * This class serves as the main access-point to an NMS implementation.
+ *
+ * @author d0by
+ * @since 2.9.0
+ */
+public interface NmsAdapter {
+
+    /**
+     * Get the factory for creating hologram renderers.
+     *
+     * @return An instance of {@link NmsHologramRendererFactory}.
+     */
+    NmsHologramRendererFactory getHologramComponentFactory();
+
+    /**
+     * Register a packet listener for a player.
+     *
+     * <p>A player can only have a single listener registered.</p>
+     *
+     * @param player   The player to register the listener for.
+     * @param listener The listener to register.
+     */
+    void registerPacketListener(Player player, NmsPacketListener listener);
+
+    /**
+     * Unregister a packet listener for a player.
+     *
+     * <p>If there is not registered listener for the given player, nothing will happen.</p>
+     *
+     * @param player The player to unregister the listener for.
+     */
+    void unregisterPacketListener(Player player);
+
+}

nms/nms-common/src/main/java/eu/decentsoftware/holograms/nms/api/NmsHologramPartData.java

@@ -0,0 +1,48 @@
+package eu.decentsoftware.holograms.nms.api;
+
+import eu.decentsoftware.holograms.shared.DecentPosition;
+
+import java.util.function.Supplier;
+
+/**
+ * A class that holds the data for a hologram part.
+ *
+ * @param <T> the type of content in the hologram part
+ * @author d0by
+ * @since 2.9.0
+ */
+public class NmsHologramPartData<T> {
+
+    private final Supplier<DecentPosition> positionSupplier;
+    private final Supplier<T> contentSupplier;
+
+    /**
+     * Constructs a new NmsHologramPartData object.
+     *
+     * @param positionSupplier a supplier that provides the position of the hologram part
+     * @param contentSupplier  a supplier that provides the content of the hologram part
+     */
+    public NmsHologramPartData(Supplier<DecentPosition> positionSupplier, Supplier<T> contentSupplier) {
+        this.positionSupplier = positionSupplier;
+        this.contentSupplier = contentSupplier;
+    }
+
+    /**
+     * Gets the position of the hologram part.
+     *
+     * @return the position of the hologram part
+     */
+    public DecentPosition getPosition() {
+        return positionSupplier.get();
+    }
+
+    /**
+     * Gets the content of the hologram part.
+     *
+     * @return the content of the hologram part
+     */
+    public T getContent() {
+        return contentSupplier.get();
+    }
+
+}

nms/nms-common/src/main/java/eu/decentsoftware/holograms/nms/api/NmsPacketListener.java

@@ -0,0 +1,21 @@
+package eu.decentsoftware.holograms.nms.api;
+
+import eu.decentsoftware.holograms.nms.api.event.NmsEntityInteractEvent;
+
+/**
+ * Represents a listener used for handling NMS-related events.
+ *
+ * @author d0by
+ * @since 2.9.0
+ */
+public interface NmsPacketListener {
+
+    /**
+     * Invoked when a player interacts with an entity.
+     *
+     * @param event The event.
+     * @see NmsEntityInteractEvent
+     */
+    void onEntityInteract(NmsEntityInteractEvent event);
+
+}