Hytale Admin Documentation
Full server management for Hytale servers — players, inventory editing, moderation, chat, world, backups, permissions, and AI log analysis via a custom Java mod REST API.
About Hytale Admin Panel
Hytale Admin Panel is a Pelican Panel plugin by Eranio that provides comprehensive server management for Hytale game servers. It communicates with a custom Java mod installed on the Hytale server via a local REST API, enabling real-time player management, inventory editing, moderation, chat monitoring, world control, backups, server configuration, and a granular permission system — all from your browser.
Key Features
| Feature | Description |
|---|---|
| Dashboard | Real-time server status — online players, TPS, uptime, quick actions |
| Player Management | Kick, heal, teleport, set gamemode, OP/de-OP, give items, clear inventory |
| Inventory Editor | Full visual inventory editing — drag-and-drop slots, armor, item search with auto-complete |
| Moderation | Ban/unban, mute/unmute players with reasons, durations, and admin attribution |
| Live Chat | Real-time chat monitoring with configurable poll interval, broadcast messages |
| World Manager | Set time, weather, create/delete/teleport warps |
| Backup System | Three backup types (world, mods, full), restore with diff-based file replacement |
| Server Config | Edit server configuration, manage whitelist |
| Permissions | 16 granular permissions, custom permission groups, OP management |
| Activity Log | Complete audit trail of all admin actions via Pelican's activity logging |
| AI Log Analysis | Gemini-powered crash log analysis (free tier, max 100KB) |
| Demo Mode | Full demo environment with fake data for testing without touching real server |
| Memories Tracker | Track discovered game memories by category |
Architecture
The plugin consists of two parts:
- Panel Plugin (PHP/Livewire) — Installed on the Pelican Panel, provides the web UI
- Java Mod (Server-Side) — Installed on the Hytale server, exposes a REST API on a configurable port
Communication flows:
Browser → Panel (Livewire) → Java Mod API (HTTP) → Hytale Server
The Java mod runs a lightweight HTTP server (default port 5550) and authenticates all requests with an X-Admin-Token header.
Data Storage
Unlike most plugins, Hytale Admin stores no data in the panel database. All data lives on the Hytale server:
| Data | Storage Location |
|---|---|
| API configuration | mods/Eranio_HytaleAdminAPI/config.json |
| Known players | mods/Eranio_HytaleAdminAPI/known_players.json |
| Ban list | bans.json |
| Whitelist | whitelist.json |
| Server config | serverconfig.json |
| Permission groups | permissions.json |
| Memories | memories.json |
| Player save files | universe/players/*.json |
Requirements
- Pelican Panel 1.0.0 or newer
- PHP 8.1, 8.2, or 8.3
- The
hytale-adminfeature on your Egg - A Hytale server with the Eranio HytaleAdminAPI Java mod installed
- Port 5550 (default) accessible from Panel to server (localhost or internal network)
- Optional:
GEMINI_API_KEYfor AI log analysis
Guides
Installation & Setup
# Installation & Setup Complete step-by-step guide to installing both the Pel...
Dashboard
# Dashboard The Dashboard provides a real-time overview of your Hytale server...
Player Management
# Player Management Complete guide to the Players page — viewing online/offli...
Moderation
# Moderation Complete guide to the moderation system — banning, unbanning, mu...
Chat
# Chat Real-time chat monitoring with configurable polling, event filtering,...
World Manager
# World Manager Manage world time, weather, and warp points — all from the br...
Backup System
# Backup System Three backup types, restore with intelligent diff-based file...
Server Configuration
# Server Configuration Edit server configuration, manage the whitelist, and v...
Permissions
# Permissions Complete guide to the Hytale Admin permission system — 16 granu...