Architecture & Overview

The HytaleAdminAPI is a REST API that runs as a plugin on Hytale servers and provides an HTTP interface.

Technology Stack

Language: Java (Plugin for the Hytale server)
HTTP Server: Embedded lightweight HTTP server (Javalin / Light-HTTP)
Format: JSON (Request & Response)
Port: Default 5550 (configurable)
Architecture: Handler-based (each endpoint area has its own handler)

Structure

HytaleAdminAPI/
├── handlers/
│   ├── StatusHandler.java
│   ├── StatsHandler.java
│   ├── PlayersHandler.java
│   ├── ChatHandler.java
│   ├── BanHandler.java
│   ├── MuteHandler.java
│   ├── WorldHandler.java
│   ├── WarpHandler.java
│   ├── ItemHandler.java
│   ├── IconHandler.java
│   ├── PermissionHandler.java
│   ├── WhitelistHandler.java
│   ├── ConfigHandler.java
│   ├── BackupHandler.java
│   ├── DeathHandler.java
│   ├── MemoryHandler.java
│   └── VersionHandler.java
├── config.yml
├── data/
└── logs/

Handler System

Each handler is responsible for a specific area and registers its own routes. This makes the API modular and extensible.

Response Format

All responses come in JSON format:

{
  "success": true,
  "data": { ... }
}

On errors:

{
  "success": false,
  "error": "Error description",
  "code": 404
}