Skip to content

HyperSystemsDev/HytaleServerDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hytale Server Documentation

The first comprehensive, community-driven reference for Hytale's dedicated server internals.

Built from decompilation and analysis of HytaleServer.jar (pre-release 2026.02.05-9ce2783f7), this repository documents the server's plugin API, command system, event architecture, permission nodes, and the complete World Generation V2 asset pipeline — covering 170+ registered types across 19 reference documents.


Table of Contents


Quick Start

Document Description
Documentation Index Full documentation index with all guides and references
Permissions Reference All 54+ permission nodes (hytale.command.*, hytale.editor.*, hytale.system.*)
Commands Reference Every server command — syntax, arguments, required permissions, player/console availability
Events Reference All 77 event classes — player, world, entity, and permission events
Plugin API Plugin lifecycle, event registration, command registration
Changelog Version diff: 55 new classes, 17 removed, 963 modified between releases
WorldGen V2 Overview Entry point for the V2 world generation system (start here)

Server Plugin API

Documentation for building Hytale server plugins. See the Documentation Index for the complete guide structure.

Reference

  • Permissions — All permission nodes across three namespaces: hytale.command.*, hytale.editor.*, hytale.system.*
  • Commands — Every server command with syntax, argument types, required permissions, and console/player availability
  • Events — 77 event classes for player, world, entity, and permission lifecycle hooks
  • Plugin API — Plugin lifecycle, event registration, command registration

Architecture Guides

Deep-dive documentation into Hytale's internal systems:

Plugin Development

Step-by-step guides for building plugins:

Modules


World Generation V2

The V2 world generation system is Hytale's asset-based procedural generation pipeline. It replaces the legacy zone system with a fully data-driven architecture built on 170+ registered JSON asset types. Every terrain shape, block material, biome boundary, and prop placement rule is defined through composable asset graphs.

This is the first community reference for this system. The documentation covers the complete pipeline from world structure definitions down to individual density function nodes.

Architecture

WorldStructure                        -- biome distribution via noise ranges
  └── Biomes[]                        -- terrain + materials + props per biome
       ├── Terrain (DAOTerrain)       -- density function graph defining 3D shape
       │    └── Density               -- 68 composable node types
       ├── MaterialProvider           -- 14 types selecting block materials
       ├── Props[]                    -- 11 types placing structures/vegetation
       │    ├── PositionProvider      -- 14 types generating candidate XZ positions
       │    ├── Scanner               -- 5 types finding valid Y positions
       │    ├── Pattern               -- 15 types validating placement conditions
       │    ├── Assignments           -- 5 types distributing prop selection
       │    └── BlockMask             -- placement/replacement rules
       ├── EnvironmentProvider        -- atmosphere, weather, spawn density
       └── TintProvider               -- biome color tinting

Reference Documents

Core Pipeline

Document Types Description
Overview and Architecture V1/V2 pipelines, asset registry, threading model, entry points
World Structures 1 NoiseRange root definition, biome ranges, transition blending
Biomes 1 BiomeAsset fields, DAOTerrain, prop runtime stages, build pipeline

Terrain and Materials

Document Types Description
Density Functions 68 Computational graph core — noise, math, shapes, warping, caching, coordinates
Curves 19 Value-mapping functions — manual, arithmetic, clamping, min/max
Material Providers 14 Block selection — SpaceAndDepth subsystem, 4 layer types, 7 condition types
Vector Providers 5 3D vector generation for warping and directional operations

Prop Placement

Document Types Description
Props 11 Object/structure placement — box, prefab, cluster, density, weighted
Position Providers 14 Candidate coordinate generation — grid, noise-filtered, cached
Scanners 5 Vertical position scanning — linear, random, area
Patterns 15 Boolean placement conditions — surface, block, spatial, logic
Assignments 5 Prop distribution strategies — constant, weighted, field function, sandwich
Block Masks Placement/replacement rules and prefab filter syntax

Environment and Configuration

Document Types Description
Environment and Tint 4 Atmosphere, weather, spawn density, and color tinting
Framework 2 Named constants and shared position providers via ReferenceBundle
Settings Performance tuning — concurrency, buffers, view distance
File System Asset overlay system for mod overrides and version packs

Legacy (V1)

Document Description
World.json V1 world configuration — dimensions, masks, data overrides
Zones V1 zone system — discovery config, tile biomes, cave generators, color masks

Version History

This documentation tracks the Hytale dedicated server across releases.

Property Value
Current Version 2026.02.05-9ce2783f7 (pre-release)
Previous Version 2026.01.24-6e2d4fc36 (release)
Server Java Version 21
Build JDK 25
Root Package com.hypixel.hytale

The Changelog documents the diff between these versions: 55 new classes, 17 removed, 963 modified. Notable changes include world generation refactoring, world map markers, sleep system, and builder tools.


Source Analysis

Decompilation

Detail Value
Source JAR HytaleServer.jar (~84 MB)
Decompiler Vineflower 1.11.2
Scope com.hypixel.hytale.* only
Total Classes 7,265
Decompiled Files 5,272

Coverage

Area Documented Items
Permission Nodes 54+
Command Classes ~446
Event Classes 77
WorldGen V2 Asset Types 170+
WorldGen V2 Reference Docs 19

Key Packages

Package Area
server.core.permissions Permission system
server.core.command Command framework
server.core.event Event system
server.core.plugin Plugin loading
server.core.universe World management
builtin.hytalegenerator World generation V2
procedurallib Procedural generation library
server.worldgen World generation config and loading
protocol Network protocol

All packages are under the com.hypixel.hytale root.


Related Projects

Project Description
HyperVerse Multi-world management plugin — create, configure, and teleport between worlds using V1 and V2 generators
HyperPerms Permission management plugin
HyperHomes Home system plugin
HyperFactions Factions plugin

Community

Join the Discord for discussion, support, and updates: https://discord.gg/SNPjyfkYPc


Disclaimer

This documentation is provided for educational and modding purposes. All content is derived from analysis of publicly available server binaries. Hytale is a trademark of Hypixel Studios. This project is not affiliated with or endorsed by Hypixel Studios.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages