Setup Your Environment
Install Java 21, configure your build tool, and create your first plugin project. Setup Guide
Hytale Server Modding
Build powerful server plugins with Java. Comprehensive API documentation, tutorials, and examples.
Start Building
Section titled “Start Building”Create Your First Plugin
Walk through building a complete plugin from scratch with events, commands, and more. First Plugin Tutorial
Understand the ECS
Learn how Hytale’s Entity Component System works and how to extend it. ECS Overview
Browse the API
Explore the complete API reference with classes, methods, and code examples. API Reference
Core Systems
Section titled “Core Systems”Event System
Subscribe to game events with priority ordering and cancellation support. Learn more
Commands
Create custom commands with argument parsing, permissions, and tab completion. Learn more
World API
Manipulate blocks, chunks, lighting, and world generation. Learn more
Entities
Work with players, NPCs, creatures, and custom entity types. Learn more
Documentation Status
Section titled “Documentation Status”This documentation is derived from Hytale server source code analysis. While comprehensive, it is community-maintained and may contain inaccuracies. Always verify against the actual API when possible.
| Section | Status |
|---|---|
| Getting Started | Verified |
| Core Concepts | Verified |
| API Reference | Verified |
| Tutorials | In Progress |