Merge pull request #1 from DomiIRL/feat/1.2

Release v1.2

Author: DomiIRL

.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: build
+on: [pull_request, push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v2
+      - name: setup jdk 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+      - name: Exec flag
+        run: chmod +x ./gradlew
+      - name: build
+        run: ./gradlew build --stacktrace
+      - name: capture build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: Artifacts
+          # only include non javadoc and non-source jars
+          path: |
+            build/libs/*.jar
+            !build/libs/*-javadoc.jar
+            !build/libs/*-sources.jar

.gitignore

@@ -16,6 +16,7 @@ libs/
 
 ### Local Server ###
 /Server/
+/run/
 
 ### IntelliJ IDEA ###
 .idea

build.gradle

@@ -1,108 +1,85 @@
 plugins {
     id 'java'
-    id 'com.gradleup.shadow' version '9.3.1'
+    id 'org.jetbrains.gradle.plugin.idea-ext' version '1.3'
 }
 
-group = 'dev.svrt.dominik'
-version = '1.1'
+ext {
+    if (System.getProperty("os.name").toLowerCase().contains("win")) {
+        hytaleHome = "${System.getProperty("user.home")}/AppData/Roaming/Hytale"
+    } else {
+        hytaleHome = "${System.getProperty("user.home")}/.var/app/com.hypixel.HytaleLauncher/data/Hytale"
+    }
+}
 
 java {
-    toolchain {
-        languageVersion = JavaLanguageVersion.of(25)
-    }
+    toolchain.languageVersion = JavaLanguageVersion.of(java_version)
+    withSourcesJar()
+    withJavadocJar()
+}
+
+// Quiet warnings about missing Javadocs.
+javadoc {
+    options.addStringOption('Xdoclint:-missing', '-quiet')
 }
 
 repositories {
     mavenCentral()
+    maven {
+        name = 'HytaleRepo'
+        url = uri('https://maven.hytale.com/release')
+    }
 }
 
+// Adds the Hytale server as a build dependency, allowing you to reference and
+// compile against their code. This requires you to have Hytale installed using
+// the official launcher for now.
 dependencies {
-    // Local HytaleServer dependency
-    compileOnly files('libs/HytaleServer.jar')
+    implementation('com.hypixel.hytale:Server:+')
 }
 
-// Configure the JAR task
-jar {
-    archiveFileName = "${project.name}-${project.version}.jar"
+// Create the working directory to run the server if it does not already exist.
+def serverRunDir = file("$projectDir/run")
+if (!serverRunDir.exists()) {
+    serverRunDir.mkdirs()
 }
 
-// Configure Shadow JAR to create a single JAR with resources
-shadowJar {
-    archiveFileName = "${project.name}-${project.version}.jar"
-    archiveClassifier = ''
-    
-    // Exclude the HytaleServer from being bundled
-    dependencies {
-        exclude(dependency(files('libs/HytaleServer.jar')))
-    }
-}
-
-// Make build task use shadowJar
-build.dependsOn shadowJar
-
-// Task to run the Hytale server
-tasks.register('runServer', Exec) {
-    description = 'Builds plugin, deploys to Server/mods and starts the Hytale server'
-    group = 'application'
-    
-    dependsOn build
-
-    workingDir = file('Server')
-    commandLine 'java', '-jar', '../libs/HytaleServer.jar', '--assets', '../libs/Assets.zip'
-
-    // Enable interactive console
-    standardInput = System.in
-    standardOutput = System.out
-    errorOutput = System.err
-
-    doFirst {
-        // Ensure Server/mods directory exists
-        def modsDir = file('Server/mods')
-        modsDir.mkdirs()
-
-        // Copy the built JAR to Server/mods
-        def sourceJar = file("build/libs/${project.name}-${project.version}.jar")
-        if (sourceJar.exists()) {
-            copy {
-                from sourceJar
-                into modsDir
-            }
-            println "Copied ${sourceJar.name} to ${modsDir.absolutePath}"
-        } else {
-            println "Warning: Built JAR not found at ${sourceJar}"
+// Updates the manifest.json file with the latest properties defined in the
+// build.properties file. Currently we update the version and if packs are
+// included with the plugin.
+tasks.register('updatePluginManifest') {
+    def manifestFile = file('src/main/resources/manifest.json')
+    doLast {
+        if (!manifestFile.exists()) {
+            throw new GradleException("Could not find manifest.json at ${manifestFile.path}!")
         }
-        
-        println "Starting Hytale Server..."
-        println "Working directory: ${workingDir.absolutePath}"
-        println "Command: java -jar ../libs/HytaleServer.jar --assets ../libs/Assets.zip"
+        def manifestJson = new groovy.json.JsonSlurper().parseText(manifestFile.text)
+        manifestJson.Version = version
+        manifestJson.IncludesAssetPack = includes_pack.toBoolean()
+        manifestFile.text = groovy.json.JsonOutput.prettyPrint(groovy.json.JsonOutput.toJson(manifestJson))
     }
 }
 
-// Task to just deploy the plugin without running the server
-tasks.register('deployPlugin') {
-    description = 'Copies the built plugin JAR to Server/mods folder'
-    group = 'deployment'
-    
-    dependsOn build
-
-    doLast {
-        def modsDir = file('Server/mods')
-        modsDir.mkdirs()
+// Makes sure the plugin manifest is up to date.
+tasks.named('processResources') {
+    dependsOn 'updatePluginManifest'
+}
 
-        def sourceJar = file("build/libs/${project.name}-${project.version}.jar")
-        if (sourceJar.exists()) {
-            copy {
-                from sourceJar
-                into modsDir
-            }
-            println "Plugin deployed to ${modsDir.absolutePath}"
-        } else {
-            println "Warning: Built JAR not found at ${sourceJar}"
+// Creates a run configuration in IDEA that will run the Hytale server with
+// your plugin and the default assets.
+idea.project.settings.runConfigurations {
+    'HytaleServer'(org.jetbrains.gradle.ext.Application) {
+        mainClass = 'com.hypixel.hytale.Main'
+        moduleName = project.idea.module.name + '.main'
+        programParameters = "--allow-op --assets=$hytaleHome/install/$patchline/package/game/latest/Assets.zip"
+        if (includes_pack.toBoolean()) {
+            programParameters += " --mods=${sourceSets.main.java.srcDirs.first().parentFile.absolutePath}"
+        }
+        if (load_user_mods.toBoolean()) {
+            programParameters += " --mods=$hytaleHome/UserData/Mods"
         }
+        if (use_insecure_auth.toBoolean()) {
+            programParameters += " --auth-mode=insecure"
+        }
+        workingDirectory = serverRunDir.absolutePath
     }
 }
-
-
-
-
-

gradle.properties

@@ -1,4 +1,31 @@
-org.gradle.jvmargs=-Xmx4096m
-org.gradle.parallel=true
-org.gradle.caching=true
+ # The current version of your project. Please use semantic versioning!
+version=1.2
 
+# The group ID used for maven publishing. Usually the same as your package name
+# but not the same as your plugin group!
+maven_group=dev.svrt.dominik
+
+# The version of Java used by your plugin. The game is built on Java 21 but
+# actually runs on Java 25.
+java_version=25
+
+# Determines if your plugin should also be loaded as an asset pack. If your
+# pack contains assets, or you intend to use the in-game asset editor, you
+# want this to be true.
+includes_pack=true
+
+# The release channel your plugin should be built and ran against. This is
+# usually release or pre-release. You can verify your settings in the
+# official launcher.
+patchline=release
+
+# Determines if the development server should also load mods from the user's
+# standard mods folder. This lets you test mods by installing them where a
+# normal player would, instead of adding them as dependencies or adding them
+# to the development server manually.
+load_user_mods=false
+
+# Determines if the insecure auth mode should be used when authenticating
+# connections to the development server. There are some scenarios where
+# this may be required.
+use_insecure_auth=false

src/main/java/dev/svrt/dominik/warpbook/WarpBookMod.java

@@ -1,26 +1,35 @@
 package dev.svrt.dominik.warpbook;
 
+import com.hypixel.hytale.codec.Codec;
+import com.hypixel.hytale.component.ComponentRegistryProxy;
 import com.hypixel.hytale.logger.HytaleLogger;
+import com.hypixel.hytale.server.core.event.events.BootEvent;
 import com.hypixel.hytale.server.core.modules.interaction.interaction.config.Interaction;
 import com.hypixel.hytale.server.core.modules.interaction.interaction.config.server.OpenCustomUIInteraction;
 import com.hypixel.hytale.server.core.plugin.JavaPlugin;
 import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
 import com.hypixel.hytale.server.core.plugin.registry.CodecMapRegistry;
+import com.hypixel.hytale.component.ComponentType;
+import com.hypixel.hytale.server.core.universe.world.storage.ChunkStore;
 import com.hypixel.hytale.server.core.util.Config;
+import dev.svrt.dominik.warpbook.components.WarpPageTeleporter;
 import dev.svrt.dominik.warpbook.config.WarpBookConfig;
 import dev.svrt.dominik.warpbook.interactions.OpenWarpBookInteraction;
 import dev.svrt.dominik.warpbook.interactions.TeleportWarpPageInteraction;
+import dev.svrt.dominik.warpbook.interactions.WarpPageTeleporterInteraction;
+import dev.svrt.dominik.warpbook.listener.RandomWarpPagesDropListAdder;
 import dev.svrt.dominik.warpbook.services.*;
 import dev.svrt.dominik.warpbook.systems.TeleportCancelSystem;
 import dev.svrt.dominik.warpbook.ui.BindWarpPageUISupplier;
 import dev.svrt.dominik.warpbook.ui.WarpBookUISupplier;
+import dev.svrt.dominik.warpbook.ui.WarpPageTeleporterUISupplier;
 
 import javax.annotation.Nonnull;
-import java.util.logging.Level;
 
 public class WarpBookMod extends JavaPlugin {
 
     public static final HytaleLogger LOGGER = HytaleLogger.forEnclosingClass();
+    public static ComponentType<ChunkStore, WarpPageTeleporter> TELEPORTER_COMPONENT_TYPE;
 
     private static WarpBookMod instance;
 
@@ -30,6 +39,7 @@ public class WarpBookMod extends JavaPlugin {
     private WarpPageUsageService warpPageUsageService;
     private WarpBookService warpBookService;
     private TeleportationService teleportationService;
+    private RandomDestinationService randomDestinationService;
     private PaymentService paymentService;
 
     public WarpBookMod(@Nonnull JavaPluginInit init) {
@@ -45,19 +55,33 @@ protected void setup() {
         this.warpPageBindingService = new WarpPageBindingService();
         this.warpPageUsageService = new WarpPageUsageService();
         this.warpBookService = new WarpBookService();
+        this.randomDestinationService = new RandomDestinationService();
         this.teleportationService = new TeleportationService();
         this.paymentService = new PaymentService();
 
+        ComponentRegistryProxy<ChunkStore> chunkStoreRegistry = getChunkStoreRegistry();
+        TELEPORTER_COMPONENT_TYPE = chunkStoreRegistry.registerComponent(WarpPageTeleporter.class, "AWBWarpPageTeleporter", WarpPageTeleporter.CODEC);
+
         CodecMapRegistry.Assets<Interaction, ?> interactionRegistry = getCodecRegistry(Interaction.CODEC);
-        interactionRegistry.register("TeleportWarpPageInteraction", TeleportWarpPageInteraction.class, TeleportWarpPageInteraction.CODEC);
-        interactionRegistry.register("OpenWarpBookInteraction", OpenWarpBookInteraction.class, OpenWarpBookInteraction.CODEC);
+        interactionRegistry.register("AWBTeleportWarpPage", TeleportWarpPageInteraction.class, TeleportWarpPageInteraction.CODEC);
+        interactionRegistry.register("AWBOpenWarpBook", OpenWarpBookInteraction.class, OpenWarpBookInteraction.CODEC);
+        interactionRegistry.register("AWBWarpPageTeleporter", WarpPageTeleporterInteraction.class, WarpPageTeleporterInteraction.CODEC);
+
+        CodecMapRegistry<OpenCustomUIInteraction.CustomPageSupplier, Codec<? extends OpenCustomUIInteraction.CustomPageSupplier>> customPageRegistry = getCodecRegistry(OpenCustomUIInteraction.PAGE_CODEC);
+        customPageRegistry.register("AWBWarpBook", WarpBookUISupplier.class, WarpBookUISupplier.CODEC);
+        customPageRegistry.register("AWBBindWarpPage", BindWarpPageUISupplier.class, BindWarpPageUISupplier.CODEC);
+        customPageRegistry.register("AWBWarpPageTeleporter", WarpPageTeleporterUISupplier.class, WarpPageTeleporterUISupplier.CODEC);
 
-        getCodecRegistry(OpenCustomUIInteraction.PAGE_CODEC).register("Warp_Book_UI", WarpBookUISupplier.class, WarpBookUISupplier.CODEC);
-        getCodecRegistry(OpenCustomUIInteraction.PAGE_CODEC).register("Bind_Warp_Page_UI", BindWarpPageUISupplier.class, BindWarpPageUISupplier.CODEC);
+        getEventRegistry().registerGlobal(BootEvent.class, RandomWarpPagesDropListAdder::onBoot);
+
+        LOGGER.atInfo().log("Warp Book plugin loaded!");
+    }
 
+    @Override
+    protected void start() {
         getEntityStoreRegistry().registerSystem(new TeleportCancelSystem());
 
-        LOGGER.at(Level.INFO).log("Warp Book plugin loaded!");
+        LOGGER.atInfo().log("Warp Book plugin started!");
     }
 
     @Override
@@ -85,11 +109,15 @@ public TeleportationService getTeleportationService() {
         return teleportationService;
     }
 
+    public RandomDestinationService getRandomDestinationService() {
+        return randomDestinationService;
+    }
+
     public PaymentService getPaymentService() {
         return paymentService;
     }
 
     public static WarpBookMod getInstance() {
         return instance;
     }
-}
+}

src/main/java/dev/svrt/dominik/warpbook/components/WarpPageTeleporter.java

@@ -0,0 +1,31 @@
+package dev.svrt.dominik.warpbook.components;
+
+import com.hypixel.hytale.codec.builder.BuilderCodec;
+import com.hypixel.hytale.component.Component;
+import com.hypixel.hytale.server.core.universe.world.storage.ChunkStore;
+import dev.svrt.dominik.warpbook.data.WarpPageBinding;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+public class WarpPageTeleporter implements Component<ChunkStore> {
+
+    @Nullable
+    private WarpPageBinding warpPageBinding;
+
+    public static final BuilderCodec<WarpPageTeleporter> CODEC = BuilderCodec.builder(WarpPageTeleporter.class, WarpPageTeleporter::new)
+            .append(WarpPageBinding.KEYED_CODEC, (c, v) -> c.warpPageBinding = v, c -> c.warpPageBinding)
+            .add()
+            .build();
+
+    @Nonnull
+    @Override
+    public Component<ChunkStore> clone() {
+        WarpPageTeleporter warpPageTeleporter = new WarpPageTeleporter();
+        if (this.warpPageBinding != null) {
+            warpPageTeleporter.warpPageBinding = this.warpPageBinding.clone();
+        }
+        return warpPageTeleporter;
+    }
+}
+