Skip to content

README.md

Latest commit

 

History

History
153 lines (106 loc) · 6.04 KB

README.md

File metadata and controls

153 lines (106 loc) · 6.04 KB

Hytale Server API Documentation

Complete reference documentation for the Hytale Server API, combining architectural deep-dives with comprehensive reference material.

Server Version: Latest decompiled build (5,234 Java source files) Decompiled Sources: ../decompiled/ Repository: https://github.com/HyperSystemsDev/HytaleServerDocs

Getting Started

New to Hytale plugin development? Start here:

  1. Plugin System - Learn the plugin lifecycle, manifest structure, and entry points
  2. Command System - Create interactive commands with arguments and permissions
  3. Event System - Listen to game events and build reactive plugins
  4. Permissions - Implement permission checks and integrate with HyperPerms

Building complex features? Explore:

Reference Material:

Documentation Structure

📐 Architecture

Deep-dive guides into Hytale's internal architecture and design patterns.

Document Topic
00-overview.md Package hierarchy, architecture, entry points, singletons
05-player-entity.md PlayerRef, Player, Holder, World, Universe models
06-messaging.md Message factory methods, colors, composition
07-protocol-enums.md GameMode, ChatType, FormattedMessage protocol
10-storage-registry.md Registry types, Config, DataStore, plugin storage
11-ecs-component-system.md Store, Holder, Ref, Component, ComponentType (ECS)

🔌 Plugin Development

Practical guides for building plugins using Hytale's APIs.

Document Topic Content Source
01-plugin-system.md Plugin lifecycle, manifest.json, setup/start/shutdown Merged: Our docs + HytaleServerDocs
02-event-system.md EventRegistry, EventPriority, async events, all event types Merged: Our docs + HytaleServerDocs
03-command-system.md AbstractCommand, CommandContext, ArgTypes Our docs
04-permissions-system.md PermissionsModule, PermissionProvider, HytalePermissions Merged: Our docs + HytaleServerDocs

📚 Reference

Complete reference material for permissions, commands, and events.

Document Topic Source
permissions.md Complete permission node reference by category HytaleServerDocs
commands.md All built-in server commands with syntax and permissions HytaleServerDocs
events.md All game events with parameters and code examples HytaleServerDocs

🧩 Modules

Documentation for Hytale's built-in server modules and their commands.

Document Topic
builtin-modules.md Built-in server modules and their commands

Quick Reference

Common Tasks

Register a command:

getCommandRegistry().register(new MyCommand());

Listen to an event:

getEventRegistry().register(PlayerJoinEvent.class, this::onPlayerJoin);

Check permissions:

boolean hasPerm = getPermissionsModule().hasPermission(playerRef, "my.permission");

Send a message:

playerRef.sendMessage(Message.raw("Hello!").color("#FFD700"));

Save plugin data:

Config config = getDataRegistry().getConfig("mydata");
config.set("key", value);
config.save();

Key Classes

Class Package Purpose
JavaPlugin com.hypixel.hytale.server.core.plugin Plugin entry point (extend this)
AbstractCommand com.hypixel.hytale.server.core.command Command base class
EventRegistry com.hypixel.hytale.server.core.event Event registration
PermissionsModule com.hypixel.hytale.server.core.permissions Permission checks
PlayerRef com.hypixel.hytale.server.core.universe Persistent player reference
Message com.hypixel.hytale.server.core.message Message builder
Config com.hypixel.hytale.server.core.registry Configuration storage

External Resources

Credits

This documentation includes:

  • Architecture docs (00, 05-07, 10-11): Deep-dive guides into Hytale's internal systems
  • Reference docs (permissions, commands, events, plugin-api): Complete API reference
  • Plugin development guides (01, 02, 03, 04): Practical tutorials and examples

Contributing

Found an error or want to improve the docs?

Last Updated: 2026-01-24