Hyloom

A gradle plugin designed to setup a dev environment for Hytale server plugins.

This plugin is a work in progress. Use at own risk and report bugs!

---

Plugin Features

• Automatically add Hytale Server as a gradle dependency
• Add a task you can use to test your plugin on a server, directly from the IDE
• IDE Debugging support

---

Setting up the Plugin

Before anything else, make sure that you have the Hytale launcher installed as well as the game itself. This plugin will refuse to function is Hytale is not installed.

Currently, we only support Windows and Linux. MacOS users can still use the plugin, but needs some manual work. If anyone on Mac want's to submit a PR, please do so.

Step 1

Add our Maven repository to your settings.gradle:

pluginManagement {
    repositories {
        gradlePluginPortal()
        mavenCentral()
        maven {
            url = "https://maven.firstdark.dev/releases"
        }

        // For snapshot builds. Not needed if you don't use them
        maven {
            url = "https://maven.firstdark.dev/releases"
        }
    }
}

or settings.gradle.kts

pluginManagement {
    repositories {
        gradlePluginPortal()
        maven("https://maven.firstdark.dev/releases")

        // For snapshot builds. Not needed if you don't use them
        maven("https://maven.firstdark.dev/snapshots")
    }
}

Step 2

Add the plugin to your build.gradle:

plugins {
    id "com.hypherionmc.hyloom" version "0.0.+"
}

or build.gradle.kts

plugins {
    id("com.hypherionmc.hyloom") version "0.0.+"
}

And that's it. Now reload Gradle and you should be ready to go.

---

Advanced Properties

You can modify some aspects of the plugin. Below is a full list of options available:

hyloom {
    // Target a specific version of hytale. Defaults to `latest`
    hytaleBuild.set("latest")
    
    // Target a specific release channel. Defaults to `release`
    patchLine.set("release")
    
    // Override the Hytale Install directory. 
    // On Windows: %user/AppData/Roaming
    // On Linux: `/home/user/.var/app/com.hypixel.HytaleLauncher/data`
    // On Mac: TODO
    hytaleInstallPath.set("c:\\Hytale")
    
    // Override the Hytale Assets.zip path
    // Defaults to hytaleInstallPath/Assets.zip
    hytaleAssetPath.set("")
    
    // Enable/Disable the run task. Defaults to true
    runConfiguration.set(true)
}

---

License

This plugin and code is licensed under the MIT license