Initial project setup with Hytale plugin template

Add a minimal, ready-to-use Hytale plugin template including Gradle build scripts, GitHub Actions CI workflow, example plugin class, configuration and manifest files, and supporting documentation. This setup provides modern build tooling, automated server testing, and best practices for plugin development.
2026-01-09 20:08:26 +01:00
commit 0dc5695def
17 changed files with 1204 additions and 0 deletions
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -0,0 +1,87 @@
+plugins {
+    id("java-library")
+    id("com.gradleup.shadow") version "9.3.1"
+    id("run-hytale")
+}
+
+group = findProperty("pluginGroup") as String? ?: "com.example"
+version = findProperty("pluginVersion") as String? ?: "1.0.0"
+description = findProperty("pluginDescription") as String? ?: "A Hytale plugin template"
+
+repositories {
+    mavenLocal()
+    mavenCentral()
+}
+
+dependencies {
+    // Hytale Server API (provided by server at runtime)
+    compileOnly(files("libs/hytale-server.jar"))
+    
+    // Common dependencies (will be bundled in JAR)
+    implementation("com.google.code.gson:gson:2.10.1")
+    implementation("org.jetbrains:annotations:24.1.0")
+    
+    // Test dependencies
+    testImplementation("org.junit.jupiter:junit-jupiter:5.10.0")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}
+
+// Configure server testing
+runHytale {
+    // TODO: Update this URL when Hytale server is available
+    jarUrl = "https://example.com/hytale-server.jar"
+}
+
+tasks {
+    // Configure Java compilation
+    compileJava {
+        options.encoding = Charsets.UTF_8.name()
+        options.release = 25
+    }
+    
+    // Configure resource processing
+    processResources {
+        filteringCharset = Charsets.UTF_8.name()
+        
+        // Replace placeholders in manifest.json
+        val props = mapOf(
+            "group" to project.group,
+            "version" to project.version,
+            "description" to project.description
+        )
+        inputs.properties(props)
+        
+        filesMatching("manifest.json") {
+            expand(props)
+        }
+    }
+    
+    // Configure ShadowJar (bundle dependencies)
+    shadowJar {
+        archiveBaseName.set(rootProject.name)
+        archiveClassifier.set("")
+        
+        // Relocate dependencies to avoid conflicts
+        relocate("com.google.gson", "com.yourplugin.libs.gson")
+        
+        // Minimize JAR size (removes unused classes)
+        minimize()
+    }
+    
+    // Configure tests
+    test {
+        useJUnitPlatform()
+    }
+    
+    // Make build depend on shadowJar
+    build {
+        dependsOn(shadowJar)
+    }
+}
+
+// Configure Java toolchain
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(25))
+    }
+}