Hytale

Bridge your Discord server with your Hytale server for seamless cross-platform integration!

Overview

The Hytale addon creates a powerful bridge between your Discord server and your Hytale game server. Enable two-way chat relay, account linking with rewards, real-time server status monitoring, automated ban synchronization, and remote console access - all seamlessly integrated with Athena Bot.

---

Table of Contents

1. Features

2. Installation

3. Server Requirements

4. Commands

---

Features

Account Linking System

• Link Discord to Hytale: Players can link their Discord account to their in-game Hytale account

• Automatic Role Assignment: Assign verified roles to linked players

• Nickname Synchronization: Automatically sync Discord nicknames with Hytale usernames

• Discord Rewards: Give coins or other Discord rewards when players link their accounts

• In-Game Rewards: Execute commands to give in-game items or bonuses upon linking

• Recurring Rewards: Configure rewards to be claimable once, daily, weekly, or monthly

• Admin Controls: Force link/unlink accounts and manage reward claims

---

Two-Way Chat Relay

• Discord to Hytale: Messages sent in Discord appear in-game

• Hytale to Discord: In-game chat messages appear in Discord

• Reply Support: Discord users can reply to Hytale messages and vice versa

• Attachment Detection: Automatically indicates when Discord messages contain attachments

• World Context: Optionally show which world/zone the player is in

---

Real-Time Server Status Panel

• Live Server Information: Display current server status in a dedicated Discord embed

• Player Count: Show online players and max capacity

• Performance Metrics: Display TPS (ticks per second), memory usage, and uptime

• Player List: Show all currently online players

• Custom Branding: Add server name, description, and thumbnail

• Refresh Button: Manual refresh option for instant updates

• Custom Buttons: Add links to your website, wiki, or store

• Auto-Updates: Configurable update intervals (30s, 1m, 5m, etc.)

---

Event Notifications

• Player Join/Leave: Notify your Discord when players connect or disconnect

• Death Messages: Broadcast player deaths and their causes

• World Events: Announce boss spawns, invasions, and special events

• Zone Discovery: Celebrate when players discover new zones or biomes

• Server Status: Alert when the server goes online or offline

---

Ban Synchronization

• Discord to Hytale: Automatically ban linked Hytale accounts when a user is banned on Discord

• Hytale to Discord: Automatically ban Discord users when their Hytale account is banned

• Custom Ban Commands: Configure the exact command used to ban players in-game

• Bidirectional Sync: Keep both platforms moderated consistently

---

Remote Console Access

• Execute Commands: Run server commands directly from Discord

• Console Channel: Dedicated channel for sending commands via chat

• Console Logging: Real-time relay of server console logs to Discord

• Filtered Logs: Choose which log categories to display (info, warnings, errors, etc.)

• Permission-Based: Restrict console access to authorized staff only

---

Installation

This is a premium addon! You must purchase this addon separately and have a valid license.

Step 1: Install Discord Bot Addon

1. Download the Hytale addon files from your purchase

2. Extract all files into the plugins/ folder of your Athena Bot installation

3. Restart your bot to load the addon

4. Configure the addon using the hytale.json5 file in your configuration/ folder

Step 2: Install Hytale Server Plugin

The Hytale addon includes a server-side plugin that must be installed on your Hytale server.

1. Locate the Hytale server plugin files included with your download

2. Install the plugin in your Hytale server's mod/plugin directory

3. Configure the config.json file in your Hytale server's plugin directory

---

Server Requirements

Hytale Server Plugin Configuration

The Hytale server-side plugin requires a config.json file with the following structure:

{
    "athena_license_key": "YOUR-LICENSE-KEY-HERE",
    "hytale_server_api": {
        "hytale_server_api_port": 3333,
        "hytale_server_api_ip_whitelist": false,
        "hytale_server_api_ip_list": ["localhost"]
    },
    "athena_web_api": {
        "authentication_key": "YOUR-API-KEY-HERE",
        "athena_web_api_ip": "localhost",
        "athena_web_api_port": 3111
    },
    "features": {
        "chat_relay": true,
        "player_join": true,
        "player_leave": true,
        "console_relay": true
    }
}

IMPORTANT: The athena_web_api.authentication_key must match the first API key configured in your Athena Bot's Web API settings.

Configuration Parameters

athena_license_key

• Your Athena Bot license key

hytale_server_api_port

• The port the Hytale plugin's API will listen on (default: 3333)

• This is NOT your Hytale game server port

hytale_server_api_ip_whitelist

• Enable IP whitelisting for security (recommended: true for production)

hytale_server_api_ip_list

• List of allowed IPs that can connect to the Hytale plugin API

• Include your Athena Bot server's IP address

athena_web_api.authentication_key

• API key for authenticating with Athena Bot

• Must match the first API key in your Web API configuration

athena_web_api_ip and athena_web_api_port

• IP address and port where your Athena Bot's Web API is accessible

---

Commands

User Commands

/link

• Link your Discord account to your Hytale account

• Usage: /link code:<6-digit-code>

• Example: /link code:A1B2C3

• Get your link code by typing /link in-game on the Hytale server

/unlink

• Unlink your Discord account from your Hytale account

• Usage: /unlink

• Removes linked role and resets nickname if configured

---

Admin Commands

/hytaleconsole execute

• Execute a command on the Hytale server console

• Usage: /hytaleconsole execute command:<command>

• Example: /hytaleconsole execute command:give PlayerName Weapon_Sword_Iron

• Permission: Requires management-level access

/linkadmin force-link

• Manually link a Discord user to a Hytale account

• Usage: /linkadmin force-link user:<@user> hytale_username:<username>

• Bypasses the normal linking process

/linkadmin force-unlink

• Manually unlink a Discord user's Hytale account

• Usage: /linkadmin force-unlink user:<@user>

• Useful for fixing incorrect links

/linkadmin reset-user

• Reset a user's link reward claims

• Usage: /linkadmin reset-user user:<@user>

• Allows them to claim rewards again

/linkadmin reset-all

• Reset all users' link reward claims

• Usage: /linkadmin reset-all

• Use when changing reward configurations

---

Getting Help

Need assistance with the Hytale addon?

• Join the Athena Bot support Discord server

• Check the configuration guide for detailed setup instructions

• Contact support for technical issues or questions

---