# KyuubiSoft Panel

# KyuubiSoft Panel

A fully automated Docker-based server management solution for Hytale game servers. The Panel provides a modern web-based administration interface with real-time monitoring, player management, and complete server automation.

**Current Version:** v2.1.3

## Features

### Server Management
- **Auto-Download System** - Automatic server JAR and assets download via official Hytale Downloader
- **Web Admin Panel** - Modern dark-themed interface with real-time updates
- **Live Console** - Real-time server logs with filtering, auto-scroll, and command history
- **Multi-User System** - Multiple administrator accounts with role-based access control

### Monitoring & Analytics
- **Performance Monitor** - CPU, RAM, JVM Heap statistics with real-time charts
- **TPS Tracking** - Current, average, minimum, and maximum ticks per second
- **MSPT Analytics** - Milliseconds per tick with trend analysis
- **Player Statistics** - Top players, playtime tracking, activity trends
- **Prometheus Metrics** - `/metrics` endpoint for Grafana integration

### Player Management
- **Player Actions** - Kick, ban, teleport, gamemode changes, item distribution
- **Inventory Display** - View and manage player inventories with item icons
- **Death Tracking** - Record and display death locations with teleport
- **Whitelist & Ban System** - Complete access control management
- **Chat Management** - Full chat history with search functionality

### Mod & Plugin Management
- **Plugin Upload** - Upload, enable/disable, config editing
- **CurseForge Integration** - Browse and install Hytale mods
- **Modtale & StackMart** - Community mod platform support
- **Unified Updates** - Centralized tracking from all mod sources

### Administration
- **Backup System** - Automatic and manual backups with restore
- **Scheduler** - Scheduled backups and automatic restarts
- **Server Broadcasts** - Messages to all players
- **Quick Settings** - Fast configuration for server name, MOTD, password
- **Activity Log** - Complete audit trail of admin actions

## Requirements

- **Docker** and **Docker Compose**
- **UDP Port 5520** (QUIC protocol)
- **Minimum 4GB RAM** (3GB for server + 1GB overhead)

## Quick Start

```bash
# 1. Clone the repository
git clone https://github.com/KyuubiDDragon/KyuubiSoft-Hytale-Panel.git
cd KyuubiSoft-Hytale-Panel

# 2. Create .env file
cp .env.example .env

# 3. Configure required variables
JWT_SECRET=$(openssl rand -base64 48)
# Edit .env with your settings

# 4. Start the stack
docker-compose up -d

# 5. Access the panel
# http://localhost:18080
```

See [Getting Started](./getting-started) for detailed setup instructions.

## Architecture

```
┌─────────────────────────────────────────────────────┐
│                   Docker Host                        │
│  ┌─────────────────┐    ┌─────────────────────────┐ │
│  │  hytale-manager │    │        hytale           │ │
│  │   (Node.js)     │◄──►│    (Java Server)        │ │
│  │   Port 18080    │    │    Port 5520/UDP        │ │
│  └─────────────────┘    └─────────────────────────┘ │
│           │                        │                 │
│           └────────┬───────────────┘                 │
│                    ▼                                 │
│  ┌─────────────────────────────────────────────────┐│
│  │              Shared Volumes                      ││
│  │  server/ data/ backups/ plugins/ mods/          ││
│  └─────────────────────────────────────────────────┘│
└─────────────────────────────────────────────────────┘
```

## Security

The panel includes enterprise-grade security features:

- **JWT Authentication** with token rotation
- **Role-Based Access Control** with 53 granular permissions
- **Rate Limiting** on authentication endpoints
- **Non-root Container** execution
- **Path Traversal Protection**
- **Command Injection Prevention**
- **Content Security Policy** headers

## Links

- [GitHub Repository](https://github.com/KyuubiDDragon/KyuubiSoft-Hytale-Panel)
- [Discord Support](https://dc.gg/kyuubisoft)