A ready-to-use starting point for creating Hytale server plugins with Java, or Kotlin. If you've been using the Asset Editor and want to start writing server-side logic — custom commands, event handling, gameplay systems — this is the simplest place to begin.
- Copy the template by downloading it or using the "Use this template" button.
- Configure or Install the Java SDK to use the latest 25 from JetBrains or similar.
- Open the project in your favorite IDE, we recommend IntelliJ IDEA.
- Optionally, run
./gradlewif your IDE does not automtically synchronizes. - Run the devserver with the Run Configuration created, or
./gradlew devServer.
On Windows, use
.\gradlew.batinstead of./gradlew, this script is here to run the Gradle without you needing to install the tooling itself, only the Java is required.
With that you will be prompted in the output to authorize your server, and then you can start developing your plugin while the server is live reloading the code changes.
From here, the HytaleModding guides cover more details!
While there are multiple plugins made for Hytale, the template currently uses a zero-boilerplate one where you only need the absolute minimum to start. However, you do have access to everything as normal if you know what you are doing.
For in-depth configuration, you can visit the ScaffoldIt Plugin Docs.
- Gradle sync fails in IntelliJ – Check that Java 25 is installed and configured under File → Project Structure → SDKs.
- Build fails with missing dependencies –
Run
./gradlew build --refresh-dependencies. Make sure you have internet access! - Permission denied on
./gradlew– Runchmod +x gradlew(macOS/Linux). - Hot-reload doesn't work – Verify you're using JetBrains Runtime, not a regular JDK.
Add your own after copying the template, though we recommend using MIT, BSD, or Apache to keep the modding community open!