Added Basic Hytale Support #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

LeeGodSRC wants to merge 20 commits into v0.7 from feat/hytale

build-logic/build.gradle.kts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -11,16 +11,16 @@ dependencies {
  
        compileOnly(gradleApi())

        compileOnly("org.codehaus.groovy:groovy-all:3.0.9")

        implementation("org.yaml:snakeyaml:1.29")

        implementation("org.yaml:snakeyaml:2.0")

        compileOnly("org.projectlombok:lombok:1.18.32")

        annotationProcessor("org.projectlombok:lombok:1.18.32")

        compileOnly("org.projectlombok:lombok:1.18.40")

        annotationProcessor("org.projectlombok:lombok:1.18.40")

        compileOnly("org.jetbrains:annotations:23.0.0")

        annotationProcessor("org.jetbrains:annotations:23.0.0")

        implementation("com.google.code.gson:gson:2.8.9")

        implementation("com.google.guava:guava:32.0.0-android")

        implementation("org.apache.commons:commons-lang3:3.12.0")

        implementation("org.ow2.asm:asm:9.7")

        implementation("org.ow2.asm:asm-commons:9.7")

        implementation("com.google.guava:guava:32.0.1-android")

        implementation("org.apache.commons:commons-lang3:3.18.0")

        implementation("org.ow2.asm:asm:9.9.1")

        implementation("org.ow2.asm:asm-commons:9.9.1")

    }

build-logic/src/main/java/io/fairyproject/gradle/ProjectTransformPlugin.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -19,7 +19,7 @@ public void apply(Project project) { @@
         }
         private void configurePlugin(Project project, String language) {
-            sourceSets.all(sourceSet -> {
+            sourceSets.configureEach(sourceSet -> {
                 project.getTasks().named(sourceSet.getCompileTaskName(language), AbstractCompile.class, compile -> {
                     ModuleCompilerAction action = project.getObjects().newInstance(ModuleCompilerAction.class);
                     compile.doLast("extraCompile", action);
@@ Expand Down @@

build-logic/src/main/kotlin/io.fairyproject.bootstrap.gradle.kts

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,11 +4,6 @@ plugins { @@
         id("io.fairyproject.publish")
     }
-    configurations {
-        compileOnly {
-            isCanBeResolved = true
-        }
-    }
     //sourceSets {
     //    test.get().compileClasspath += configurations.compileOnly.get()
@@ Expand Down @@

build-logic/src/main/kotlin/io.fairyproject.common.gradle.kts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -70,16 +70,16 @@ repositories {
  
    dependencies {

        compileOnly("org.jetbrains:annotations:24.1.0")

        compileOnly("org.projectlombok:lombok:1.18.32")

        annotationProcessor("org.projectlombok:lombok:1.18.32")

        compileOnly("org.projectlombok:lombok:1.18.40")

        annotationProcessor("org.projectlombok:lombok:1.18.40")

        testCompileOnly("org.jetbrains:annotations:24.1.0")

        testImplementation("org.mockito:mockito-core:4.2.0")

        testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2")

        testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")

        testCompileOnly("org.projectlombok:lombok:1.18.32")

        testAnnotationProcessor("org.projectlombok:lombok:1.18.32")

        testCompileOnly("org.projectlombok:lombok:1.18.40")

        testAnnotationProcessor("org.projectlombok:lombok:1.18.40")

    }

    java {

build-logic/src/main/kotlin/io.fairyproject.module.hytale.gradle.kts

-Original file line number
+Diff line change
@@ -0,0 +1,22 @@
+    plugins {
+        id("io.fairyproject.module")
+    }
+    dependencies {
+        compileOnly("dev.imanity.hytale:HytaleServer:2026.01.17-2")
+    }
+    repositories {
+        maven ("https://repo.imanity.dev/imanity-libraries/")
+    }
+    java {
+        toolchain {
+            languageVersion.set(JavaLanguageVersion.of(25))
+        }
+    }
+    tasks.withType(JavaCompile::class.java).configureEach {
+        options.encoding = "UTF-8"
+        options.release = 25
+    }

.../bootstraps/core-bootstrap/src/main/java/io/fairyproject/bootstrap/type/PlatformType.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ public enum PlatformType { @@
         BUNGEE,
         VELOCITY,
         NUKKIT,
-        APP
+        APP,
+        HYTALE
     }

framework/bootstraps/hytale-bootstrap/build.gradle.kts

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    plugins {
+        id("io.fairyproject.bootstrap")
+    }
+    dependencies {
+        api(project(":core-bootstrap"))
+        compileOnly("io.fairyproject:hytale-platform")
+    }
+    java {
+        toolchain {
+            languageVersion.set(JavaLanguageVersion.of(25))
+        }
+    }
+    tasks.withType(JavaCompile::class.java).configureEach {
+        options.encoding = "UTF-8"
+        options.release = 25
+    }

...ale-bootstrap/src/main/java/io/fairyproject/bootstrap/hytale/HytalePlatformBootstrap.java

-Original file line number
+Diff line change
@@ -0,0 +1,60 @@
+    /*
+     * MIT License
+     *
+     * Copyright (c) 2022 Fairy Project
+     *
+     * Permission is hereby granted, free of charge, to any person obtaining a copy
+     * of this software and associated documentation files (the "Software"), to deal
+     * in the Software without restriction, including without limitation the rights
+     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+     * copies of the Software, and to permit persons to whom the Software is
+     * furnished to do so, subject to the following conditions:
+     *
+     * The above copyright notice and this permission notice shall be included in all
+     * copies or substantial portions of the Software.
+     *
+     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+     * SOFTWARE.
+     */
+    package io.fairyproject.bootstrap.hytale;
+    import io.fairyproject.FairyPlatform;
+    import io.fairyproject.bootstrap.platform.AbstractPlatformBootstrap;
+    import io.fairyproject.bootstrap.type.PlatformType;
+    import io.fairyproject.hytale.FairyHytalePlatform;
+    import lombok.Getter;
+    import org.jetbrains.annotations.Nullable;
+    @Getter
+    class HytalePlatformBootstrap extends AbstractPlatformBootstrap {
+        @Override
+        protected void onFailure(@Nullable Throwable throwable) {
+            if (throwable != null) {
+                throwable.printStackTrace();
+            }
+            if (HytalePlugin.INSTANCE != null && HytalePlugin.INSTANCE.getShutdownAction() != null) {
+                HytalePlugin.INSTANCE.getShutdownAction().run();
+            }
+        }
+        @Override
+        protected PlatformType getPlatformType() {
+            return PlatformType.HYTALE;
+        }
+        @Override
+        protected FairyPlatform createPlatform() {
+            return new FairyHytalePlatform(
+                    HytalePlugin.INSTANCE,
+                    HytalePlugin.INSTANCE.getShutdownAction(),
+                    HytalePlugin.INSTANCE.getDataDirectory().toFile()
+            );
+        }
+    }

...tstraps/hytale-bootstrap/src/main/java/io/fairyproject/bootstrap/hytale/HytalePlugin.java

-Original file line number
+Diff line change
@@ -0,0 +1,163 @@
+    /*
+     * MIT License
+     *
+     * Copyright (c) 2022 Fairy Project
+     *
+     * Permission is hereby granted, free of charge, to any person obtaining a copy
+     * of this software and associated documentation files (the "Software"), to deal
+     * in the Software without restriction, including without limitation the rights
+     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+     * copies of the Software, and to permit persons to whom the Software is
+     * furnished to do so, subject to the following conditions:
+     *
+     * The above copyright notice and this permission notice shall be included in all
+     * copies or substantial portions of the Software.
+     *
+     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+     * SOFTWARE.
+     */
+    package io.fairyproject.bootstrap.hytale;
+    import com.google.gson.JsonObject;
+    import com.hypixel.hytale.server.core.plugin.JavaPlugin;
+    import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
+    import io.fairyproject.bootstrap.PluginClassInitializerFinder;
+    import io.fairyproject.bootstrap.PluginFileReader;
+    import io.fairyproject.bootstrap.instance.PluginInstance;
+    import io.fairyproject.bootstrap.internal.FairyInternalIdentityMeta;
+    import io.fairyproject.bootstrap.platform.PlatformBootstrap;
+    import lombok.AccessLevel;
+    import lombok.Setter;
+    import org.jetbrains.annotations.NotNull;
+    @FairyInternalIdentityMeta
+    public final class HytalePlugin extends JavaPlugin {
+        public static HytalePlugin INSTANCE;
+        private final PluginInstance instance;
+        private final PluginFileReader pluginFileReader;
+        private final PlatformBootstrap bootstrap;
+        private Runnable shutdownAction;
+        @Setter(AccessLevel.PACKAGE)
+        private boolean loaded;
+        /**
+         * Constructor with dependency injection for testing purposes.
+         *
+         * @param init             the Hytale plugin init object
+         * @param instance         the plugin instance
+         * @param pluginFileReader the plugin file reader
+         * @param bootstrap        the platform bootstrap
+         * @param shutdownAction   the action to run on shutdown (nullable, will use default if null)
+         */
+        public HytalePlugin(@NotNull JavaPluginInit init,
+                            PluginInstance instance,
+                            PluginFileReader pluginFileReader,
+                            PlatformBootstrap bootstrap,
+                            Runnable shutdownAction) {
+            super(init);
+            this.instance = instance;
+            this.pluginFileReader = pluginFileReader;
+            this.bootstrap = bootstrap;
+            this.shutdownAction = shutdownAction;
+        }
+        /**
+         * Default constructor for Hytale server.
+         *
+         * @param init the Hytale plugin init object
+         */
+        public HytalePlugin(@NotNull JavaPluginInit init) {
+            this(
+                    init,
+                    new HytalePluginInstance(PluginClassInitializerFinder.find()),
+                    new PluginFileReader(),
+                    new HytalePlatformBootstrap(),
+                    null // will be initialized lazily
+            );
+        }
+        /**
+         * Get the shutdown action to be used by the platform.
+         * Lazily initializes to server stop if not set.
+         *
+         * @return the shutdown action
+         */
+        public Runnable getShutdownAction() {
+            if (this.shutdownAction == null) {
+                // Use reflection to call server stop to avoid compile-time API dependency issues
+                this.shutdownAction = () -> {
+                    try {
+                        Object server = this.getClass().getMethod("getServer").invoke(this);
+                        if (server != null) {
+                            server.getClass().getMethod("stop").invoke(server);
+                        }
+                    } catch (Exception e) {
+                        System.err.println("[Fairy] Failed to stop server: " + e.getMessage());
+                    }
+                };
+            }
+            return this.shutdownAction;
+        }
+        /**
+         * Called by Hytale during plugin setup phase.
+         * Maps to Bukkit's onLoad() lifecycle.
+         * Performs: preload + load + instance.onLoad
+         */
+        @Override
+        protected void setup() {
+            if (this.loaded)
+                return;
+            INSTANCE = this;
+            if (!this.bootstrap.preload()) {
+                System.err.println("[Fairy] Failed to boot fairy! check stacktrace for the reason of failure!");
+                this.getShutdownAction().run();
+                return;
+            }
+            JsonObject jsonObject = pluginFileReader.read(this.getClass());
+            this.instance.init(jsonObject);
+            this.bootstrap.load(this.instance.getPlugin());
+            this.instance.onLoad();
+            this.loaded = true;
+        }
+        /**
+         * Called by Hytale during plugin start phase.
+         * Maps to Bukkit's onEnable() lifecycle.
+         * Performs: enable + instance.onEnable
+         */
+        @Override
+        protected void start() {
+            if (!this.loaded)
+                throw new IllegalStateException("Plugin not loaded yet!");
+            this.bootstrap.enable();
+            this.instance.onEnable();
+        }
+        /**
+         * Called by Hytale during plugin shutdown phase.
+         * Maps to Bukkit's onDisable() lifecycle.
+         * Performs: instance.onDisable + disable
+         */
+        @Override
+        protected void shutdown() {
+            if (!this.loaded)
+                return;
+            this.instance.onDisable();
+            this.bootstrap.disable();
+        }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Basic Hytale Support #194

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Added Basic Hytale Support #194

Are you sure you want to change the base?

Uh oh!

Added Basic Hytale Support #194

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!