Documentation

Learn how to create plugins, asset packs, and mods for Hytale servers.

Set up your development environment with Java 25, Gradle, and IntelliJ IDEA.

Understand setup(), start(), and shutdown() methods and when they're called.

Create custom slash commands with arguments, permissions, and tab completion.

Listen and respond to player actions, chat messages, and game events.

Understand Hytale's Entity Component System - Store, Ref, Holder, and components.

Add new items with custom models, textures, icons, and behaviors.

Build interactive UI pages, windows, and HUD elements.

Load and paste pre-built structures for dungeons, arenas, and procedural generation.

Create isolated game worlds for minigames with automatic cleanup.

Persist player progress, stats, and unlocks across sessions.

Work with day/night cycles, game time, and time-based events.

Structure and bundle assets with your plugins correctly.

Avoid common mistakes and learn the quirks of Hytale modding.