Unofficial community documentation for running and modding Hytale dedicated servers. This documentation was created through decompilation and analysis of the HytaleServer.jar.
- Getting Started — Installation, project setup, and server configuration
- Plugin System — Plugin architecture, lifecycle, and manifest format
- Event System — Subscribing to and creating custom events
- Component System (ECS) — Entity-Component-System architecture
- Commands — Creating custom server commands
- Networking — Protocol and packet handling
- Assets & Registry — Custom content registration
- World Generation — Terrain and structure generation
- And more...
.
├── public/ # Static assets (favicon, etc.)
├── src/
│ ├── assets/ # Images and media
│ ├── content/
│ │ └── docs/ # Documentation pages
│ │ ├── getting-started/
│ │ └── modding/
│ └── styles/ # Custom CSS
├── decompiled/ # Decompiled source reference
├── astro.config.mjs # Astro + Starlight config
└── package.json
| Command | Action |
|---|---|
npm install |
Install dependencies |
npm run dev |
Start local dev server at localhost:4321 |
npm run build |
Build production site to ./dist/ |
npm run preview |
Preview build locally before deploying |
Contributions are welcome! If you have additional information about the Hytale server API or find errors in the documentation:
- Fork the repository
- Create a feature branch
- Add or update documentation in
src/content/docs/ - Submit a pull request
This is unofficial community documentation created through reverse engineering. It is not affiliated with or endorsed by Hypixel Studios. Implementation details may change in future Hytale versions.