metru.dev / hytale-modding-wsl-experiments
[READ-ONLY] Mirror of https://github.com/metruzanca/hytale-modding-wsl-experiments.
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

Java 100.0%
30 1 0

Clone this repository

https://tangled.org/metru.dev/hytale-modding-wsl-experiments https://tangled.org/did:plc:udwi3gdphfgk24zacqthra7h
git@tangled.org:metru.dev/hytale-modding-wsl-experiments git@tangled.org:did:plc:udwi3gdphfgk24zacqthra7h

For self-hosted knots, clone URLs may differ based on your setup.


Download tar.gz Download .zip
README.md

Hytale Plugin Template#

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.

How to start?#

  1. Copy the template by downloading it or using the "Use this template" button.
  2. Configure or Install the Java SDK to use the latest 25 from JetBrains or similar.
  3. Set up Hytale path (required for WSL/Windows users):
    • Set the HYTALE_HOME environment variable to point to your Hytale installation directory:
      • Windows: C:/Users/<username>/AppData/Roaming/Hytale
      • WSL: /mnt/c/Users/<username>/AppData/Roaming/Hytale
  4. Open the project in your favorite IDE, we recommend IntelliJ IDEA.
  5. Run the devserver: gradle devServer

This project uses Gradle via mise. Ensure you have gradle available in your PATH.

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!

Scaffoldit Plugin#

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.

WSL (Windows Subsystem for Linux) Setup#

Running the dev server in WSL while Hytale is installed on Windows is fully supported:

  1. Ensure Hytale is installed on Windows via the Hytale Launcher
  2. Set the HYTALE_HOME environment variable to your WSL path:
    • Example: export HYTALE_HOME=/mnt/c/Users/<username>/AppData/Roaming/Hytale
    • Add this to your shell profile (e.g., ~/.bashrc or ~/.zshrc) to make it persistent
  3. Run ./setup-wsl.sh to configure Gradle (one-time setup)
  4. Start the server: gradle devServer

The setup script writes the Hytale path to your global Gradle configuration (~/.gradle/gradle.properties), which is the standard location for machine-specific settings.

Troubleshooting#

  • 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 – Run chmod +x gradlew (macOS/Linux).
  • Hot-reload doesn't work – Verify you're using JetBrains Runtime, not a regular JDK.
  • "Assets are not present" error – Make sure HYTALE_HOME environment variable is set correctly and Hytale is installed on Windows. Run ./setup-wsl.sh to configure Gradle.

Resources#

License#

Add your own after copying the template, though we recommend using MIT, BSD, or Apache to keep the modding community open!