Hydex — Hytale Source Documentation
Comprehensive documentation for the Hytale source, mechanically generated from the decompiled Hytale JAR. Every type is documented with full method signatures, field listings, and cross-references.
Coverage
Section titled “Coverage”| Metric | Count |
|---|---|
| Total documented types | 5,572 |
| Java packages | 911 |
| API surface types | 677 |
| Internal types | 4,895 |
| Internal links | 9,318 |
Organization
Section titled “Organization”Documentation is organized by Java package under packages/. Each package
directory contains an index.md listing all types in that package, plus
individual type documentation pages.
The api_surface frontmatter field indicates whether a type is part of the
plugin-facing API (true) or an internal implementation type (false). All
types receive full documentation regardless of classification.
The sidebar covers the most important packages grouped by category. All 911 packages are searchable — use the search bar (⌘K) to find any type by name.
Key Entry Points
Section titled “Key Entry Points”Plugin Development
Section titled “Plugin Development”com.hypixel.hytale.server.core.plugin— Plugin manager, lifecycle, class loading
Events
Section titled “Events”com.hypixel.hytale.event— Event base interfacescom.hypixel.hytale.server.core.event.events.player— Player eventscom.hypixel.hytale.server.core.event.events.ecs— ECS events
ECS Framework
Section titled “ECS Framework”com.hypixel.hytale.component— Core ECS: Store, ComponentRegistry, Ref, Archetype
Commands
Section titled “Commands”com.hypixel.hytale.server.core.command.system— Command framework
Entity System
Section titled “Entity System”com.hypixel.hytale.server.core.entity— Entity, LivingEntity, interactionscom.hypixel.hytale.server.core.modules.entity.damage— Damage and combat
com.hypixel.hytale.server.core.universe.world— World, chunks, block operationscom.hypixel.hytale.server.worldgen— World generation pipeline
NPC System
Section titled “NPC System”com.hypixel.hytale.server.npc.systems— NPC ECS systemscom.hypixel.hytale.server.npc.role— NPC roles and behavior profiles
Assets & Codecs
Section titled “Assets & Codecs”com.hypixel.hytale.assetstore.map— Asset maps and lookup tablescom.hypixel.hytale.codec— JSON serialization framework
Protocol
Section titled “Protocol”com.hypixel.hytale.protocol— Network protocol types
Inventory & Items
Section titled “Inventory & Items”com.hypixel.hytale.server.core.inventory— Inventory systemcom.hypixel.hytale.server.core.asset.type.item.config— Item definitions
JSON Schemas
Section titled “JSON Schemas”Source
Section titled “Source”All documentation is derived from the Hytale JAR. No external sources are used. If a description says “Purpose unknown,” it means the purpose could not be determined from the decompiled source alone.
Acknowledgements
Section titled “Acknowledgements”Built with Vineflower, JavaParser, Astro Starlight, Cloudflare Workers, Claude Code, and PAI.
Build Information
Section titled “Build Information”- JAR Hash:
sha256:4dc38055618aa4447fbdcbdbce458f7eefb1850728e8fc4da7a645f02ff8f46e - Generator Version: 2.0.0
- Generated: 2026-03-21