Installation & Setup

Installation & Setup

Complete step-by-step guide to installing both the Pelican Panel plugin and the Hytale server-side Java mod, configuring the API connection, and verifying everything works.

Prerequisites

• Pelican Panel version 1.0.0+ installed and running
• PHP 8.1, 8.2, or 8.3 on the Panel server
• A Hytale game server managed by the Panel
• Network access from the Panel server to the Hytale server on port 5550 (default)
• storage/ and bootstrap/cache/ writable (permissions 0755, owner: web server user)

Step 1: Install the Panel Plugin

1. Download the latest hytale-admin plugin release
2. Place it in your Pelican Panel's plugins/ directory:

   /var/www/pelican/plugins/hytale-admin/
   

3. Verify the directory structure:

   plugins/hytale-admin/
   ├── src/
   ├── config/
   ├── resources/
   └── plugin.json
   

4. Clear the application cache:

   php artisan cache:clear
   php artisan config:clear
   php artisan view:clear
   

5. Verify the plugin appears under Admin Panel → Plugins as "Hytale Admin Panel"

Step 2: Configure the Egg

The plugin uses the hytale-admin feature flag to determine which servers show the admin panel.

1. Go to Admin Panel → Eggs
2. Edit your Hytale server Egg (e.g., "Hytale Server")
3. Add hytale-admin to the Features field:

   ["hytale-admin"]
   

   If the Egg already has features:

   ["steam_disk_space", "hytale-admin"]
   

4. Click Save

Important: The feature flag must be exactly hytale-admin (lowercase, hyphenated). Variations like HytaleAdmin or hytale_admin will not work.

Step 3: Install the Java Mod on the Server

The Java mod is the server-side component that exposes the REST API.

1. Navigate to your server → Hytale Admin in the sidebar
2. Go to the Setup tab
3. Click Install Mod — the plugin uploads the bundled JAR from resources/mod/ to the server's mods/ directory
4. Success notification: "Java mod installed successfully"
5. Restart the Hytale server for the mod to load

Integrity Verification

The plugin uses RSA-2048 signature verification and SHA-256 hash comparison to ensure mod integrity:

After installation, click Verify Integrity to run both checks:

• Success: "Integrity check passed"
• Failure: "SHA-256 mismatch" — reinstall the mod

Step 4: Configure the API Connection

After the Java mod starts for the first time, it generates a configuration file at:

mods/Eranio_HytaleAdminAPI/config.json

Configuration Reference

The plugin reads this configuration automatically via the Daemon file API. No manual configuration needed unless you want to customize values.

Security Note: The token is auto-generated and should be kept secret. It authenticates all API requests. If compromised, stop the server, change the token in config.json, and restart.

Step 5: First Launch

1. Ensure the Hytale server is running with the Java mod loaded
2. Navigate to your server → click Hytale Admin in the sidebar
3. The plugin connects to the Java mod API and displays:
   • Dashboard with server status (players, TPS, uptime)
   • Navigation tabs for all features
4. If connection fails, you'll see "Hytale API error" in logs

Connection Troubleshooting

Step 6: Admin Settings

On the Setup tab, you can configure:

Success: "Admin settings saved" Failure: "Settings save failed"

Uninstalling the Mod

1. Go to Setup tab → click Uninstall Mod
2. The JAR is deleted from the server's mods/ directory
3. Success: "Java mod uninstalled"
4. Restart the server
5. The panel plugin can remain installed but will show connection errors without the mod

Verification Checklist

Permission System

The plugin uses 16 granular permissions to control access. See the dedicated Permissions guide for the full reference. By default, server owners have all permissions.