1. Download the IDEA Template

The easiest way to start developing plugins is by downloading the template created by Darkhax & Jared.

  • Zip File (TBC)
  • GitHub Repo (TBC)


This plugin has many great features, such as:

  • Add the latest Hytale server files to your classpath.
  • Run the game from your IDE, even with breakpoints!
  • Bundle assets with your plugin, which can be modified using the official in-game asset editor.
  • Supports various patch lines, including releases and pre-releases.
  • Includes example code and assets.


2. Setup the Template

Extract the contents of the ZIP file to where you want to develop your plugin. The ZIP contains a README.md file with an in-depth guide to using the plugin.


Ensure that you have completed all the following steps before proceeding:

  1. Download Hytale using the official launcher.
  2. Have IntelliJ IDEA installed. Community edition is fine.
  3. Download Java 25 and add it as an SDK in IDEA.
  4. Set your project name in settings.gradle
  5. Review the properties in gradle.properties
  6. Update src/main/resources/manifest.json to reflect your project.


3. Open the Project in IDEA

Next, open the template folder in IDEA to load and initialize the project.


4. Tips

  • To build a shareable version of your plugin, run gradle build. The plugin JAR file will be located in the builds/libs directory.
  • A run configuration to launch the game will be added for you. It's called HytaleServer.
  • Plugins can be installed by placing them in the %appdata%/Hytale/UserData/Mods directory. If the folder doesn't exist, you can create this manually.


This guide was created by Darkhax, Jared and Rick.