Hytale Gradle Plugin

A Gradle plugin for Hytale mod development. It handles manifest generation and validation, local server runs, asset resolution, dependency staging, IDE source attachment, workspace orchestration, and optional Hytale Javadoc injection.

Need a new project? Start with the template generator.

plugins {
    id 'java'
    id 'com.azuredoom.hytale-tools' version '1.0.46'
}

hytaleTools {
    hytaleVersion = '0.+'
    patchline = 'release'
    manifestGroup = 'com.example.mods'
    modId = 'examplemod'
    mainClass = 'com.example.mods.ExampleMod'
    modCredits = 'yourname'
}

Then run:

./gradlew setupHytaleDev
./gradlew runServer

For debugging and hot swap:

./gradlew runServer -Ddebug=true -Dhotswap=true

• Generated and validated manifest.json
• Authenticated Hytale asset resolution
• Local Hytale server launch tasks
• Runtime plugin and library staging
• Decompiled source attachment for IDEs
• Hosted Hytale Javadocs in generated sources
• Multi-project workspace support
• VS Code run, task, and debug configuration
• Diagnostics and cleanup tasks

The full documentation lives in the project wiki.

• Why use this plugin?
• Quickstart
• Hot Swap Quickstart
• Usage
• Development Workflow
• VS Code Setup

• Multi-Project Setup
• Workspace Tasks
• Configuration
• Extension Reference
• Configurations
• Dependencies
• Manifest dependency fields
• SubPlugins
• AssetBridge

• Dependency Flow
• IDE Source Attachment
• Runtime Dependency Staging
• Hytale Server Dependency
• Cleaning Generated Files and Caches
• Features
• Included Tasks
• Task Reference
• Repositories
• Gradle Compatibility
• CI Usage

• Java 25+
• A supported Hytale release or pre-release patchline
• A modern Gradle version

• Troubleshooting
• GitHub issues
• Discord