Skip to content

README.md

Latest commit

 

History

History
115 lines (89 loc) · 4.79 KB

README.md

File metadata and controls

115 lines (89 loc) · 4.79 KB
Raw

Hytale Gradle Plugin

Gradle Plugin Java Hytale

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.

Quickstart

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

What it provides

  • 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

Common tasks

Task Purpose
setupHytaleDev Prepare assets and IDE sources
runServer Run one mod locally
runAllMods Run all workspace mods together
prepareDecompiledSourcesForIde Generate IDE source attachments
updatePluginManifest Regenerate manifest.json
hytaleDoctor Diagnose project, asset, and dependency issues
hytaleJvmDoctor Diagnose debug and hot-swap support

Documentation

The full documentation lives in the project wiki.

Getting started

Workspace and configuration

Development and reference

Requirements

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

Support