Vanguard

Overview

Vanguard is the ultimate Hytale moderation suite. Take full control of your server's moderation with the most feature-rich and visually stunning punishment system designed specifically for Hytale. Featuring a world-class Discord global network integration, advanced vanish, private admin chat, freeze player, jail system, reports, and an optional advanced web interface, Vanguard provides everything you need to maintain a professional and healthy community.

Discord global network integration

• Unified Network Status – Track your entire server cluster in a single Discord message
• Multi-Server Aggregation – Sync player counts and status from every server to one centralized Discord channel
• Advanced /check Command – View detailed history via Discord with dynamic relative timestamps (e.g. "Expires: in 2 hours")
• Visual Punishment Labels – Instantly distinguish between permanent and temporary punishments with [TEMP] labels
• Unified Logging – Automatic real-time broadcasting of ALL punishments (Bans, Mutes, Kicks, Jails) to your staff channels

Complete moderation toolset

• Permanent and Temporary Bans
• Permanent and Temporary Mutes
• IP-Banning & IP-Muting Support
• Warnings & Kicks
• Jail System with Named Locations & Timed Sentences
• Inventory Inspection (InvSee) & Backpack Inspection (BackSee)
• Advanced Search (CheckBan / History / BanList)

Full jail system

• Create and manage named jail locations on your server
• Jail players with optional time limits and reasons
• Jailed players are automatically restricted from breaking, placing, and interacting with blocks
• Chat denial while jailed (configurable)
• Automatic teleportation to jail on world join for persistent enforcement
• Unjail players and teleport them back to their original location
• All jail restriction messages are fully translatable in config

Inventory & backpack inspection

• View any online player's full inventory (storage, hotbar, armor, and utility slots)
• View any online player's backpack contents
• Accessible via commands or directly from the Admin Panel UI

Powerful admin commands

• Vanish Mode – Become completely invisible to players, the world map, and the tab list
• Admin Chat – Toggle a private, secure chat mode for staff-only communication
• Clear Chat – Instantly wipe the global chat for all players to remove toxicity or spam
• Freeze System – Restrict player movement (persists through rejoin)
• Word Blacklist – Manage a custom dictionary of blocked words directly through a custom Hytale UI

Community reporting system

• Player Reporting – Submit detailed reports on offenders via /hyreport
• Bug Reporting – Capture technical issues and suggestions via /hybugreport
• Discord Sync – Every report broadcast to your staff channels in real-time
• Admin Review GUIs – Clean dashboards for admins to review and act on pending reports

Optional command aliases

Config toggle useShortAliases: true enables short-form commands: /ban, /mute, /vanish, /jail, /freeze, etc.

Breathtaking Hytale UI

Custom-made Hytale UI interfaces for History, Admin management, and Blacklist control. Redesigned Admin Panel with live player search, column headers, and online player count. Color-coded Player Actions page (red for bans, amber for mutes, blue for utility). Modern, clean, and intuitive design that fits perfectly within the Hytale aesthetic.

Multi-server synchronization

Full MySQL/MariaDB support included. Synchronize punishments across your entire network instantly. Secure and optimized database handling.

Premium smart styling system

No more messy config files! Smart Styling automatically applies professional colors and prefixes. Automatic highlighting of placeholders ({player}, {reason}, {until}) for a high-end feel. Dark-mode aesthetics by default.

Advanced web interface (optional add-on)

A modern, professional web portal for your server. Real-time punishment logs and player search. Responsive design with detailed evidence. Preview: bans.hyronix.eu

Why choose Vanguard?

Vanguard isn't just a punishment tool; it's a statement of quality for your server. Developed by a team with over 40,000+ downloads on our CurseForge mods, we bring proven experience and reliability to the Hytale ecosystem.

Support Discord: discord.gg/DRxwt8Qg2W

Plugin installation

1. Download the Vanguard.jar and place it into your server's mods folder.
2. Restart your Hytale server to generate the configuration files.
3. Open mods/Hyronix_Vanguard/config.json and enter your MySQL/MariaDB credentials.
4. (Optional) Customize messages and timezones in the config.
5. Restart or use /hylist reload to apply changes.
6. (Optional) Download the Website Addon at hyronix.eu/mod.php?id=vanguard to set up your web portal.

Discord setup tutorial

Maximize your moderation efficiency with our native Discord integration:

1. Bot Creation – Create an application at the Discord Developer Portal. Create a Bot, reset the token, and enable the "Server Members" and "Message Content" Gateway Intents.
2. Invite the Bot – Use the OAuth2 URL generator to invite your bot to your server with Administrator permissions.
3. Database Setup – Ensure all servers in your network are connected to the same MySQL database in config.json.
4. Discord Configuration – Open discordconfig.json and enter your Bot Token.
5. Channel IDs – Right-click your desired Discord channels to copy their IDs and paste them into statusChannelId and logsChannelId.
6. Network Mode – To track all servers in one message, set statusMode to "GLOBAL" and give each server a unique serverId.
7. Refresh – Use /hylist reload or restart the server. Your network status will appear automatically.

Website installation (optional add-on)

Requirements: PHP 7.4+, Web Server (Apache/Nginx/Litespeed), PDO MySQL extension.

1. Download the Vanguard Website from the link above and extract it.
2. Upload all files from the website folder to your web server (e.g. /public_html/bans).
3. Open inc/settings.php to configure the database connection.
4. Set $this->username and $this->password to your MySQL credentials.
5. Ensure table_prefix in settings.php matches tablePrefix in your plugin config.

This guide provides a comprehensive walkthrough for setting up the Discord Bot module in Vanguard v1.1.1, including single-server and global network configurations.

Part 1: Discord Bot Creation (The Foundation)

1. Visit the Developer Portal – Go to discord.com/developers/applications
2. Create Application – Click "New Application" and give it a name (e.g. "Vanguard Bot")
3. Generate Token:
   • Go to the "Bot" tab in the left sidebar
   • Click "Reset Token" and copy it immediately. This is your token for the config
4. Enable Intents (CRITICAL):
   • Scroll down to the "Privileged Gateway Intents" section
   • Toggle ON: "Server Members Intent" (needed for player lookups)
   • Toggle ON: "Message Content Intent" (needed for slash commands)
   • Click "Save Changes"
5. Invite the Bot:
   • Go to OAuth2 → URL Generator
   • Select "bot" and "Administrator" (or Send Messages, Embed Links, etc.)
   • Copy the generated URL into your browser and invite the bot to your server

Part 2: Configuration Breakdown

Open mods/Hyronix_Vanguard/discordconfig.json:

Basic settings

• enabled – (true/false) Master switch for the Discord module
• token – Your bot token from Part 1
• guildId – The ID of your Discord server
• logsChannelId – Channel where every Ban, Mute, Kick, etc. is logged in real-time
• statusChannelId – Channel where the live player count/server status message lives

Network modes (multiple servers)

• statusMode:
  • SERVER_ONLY – Default. Shows status only for the local server instance
  • GLOBAL – Aggregates all servers in your network into one single Discord message
• serverId – The name of this instance (e.g. "Lobby-1")
• serverIp – The IP/Host of this instance to display in the status list

Appearance & styling

• serverIconUrl – An image link used in the embed thumbnails
• statusTitle – The header of your status message
• statusFooter – Small text at the bottom of the status message
• checkFooter – Small text at the bottom of /check results

Part 3: Multi-Server Setup (Global Mode)

To sync multiple Hytale servers to a single Discord bot:

1. Shared Database – Every server must be connected to the same MySQL/MariaDB database in your config.json
2. Master Bot – Only one server needs to have the bot token and configuration enabled (usually your Lobby server)
3. Heartbeat Config – On all servers (including those without the bot):
   • Set statusMode to GLOBAL
   • Give each server a unique serverId (e.g. "Survival", "Creative")
   • Set serverIp to the actual address players use to join that specific mode
4. Outcome – The Master server will read the heartbeats of all other servers from the database and generate a cluster breakdown in Discord

Part 4: How to Use (Slash Commands)

Once the bot is online, use these commands in Discord:

• /check [player] – View a player's full punishment history
  • Features dynamic relative time (e.g. "Expires in 3 days")
  • Categorizes items as [TEMP-BAN], [WARN], [JAIL], etc.
  • Interactive pagination buttons for long histories
• Status Updates – The bot automatically posts a status message in your statusChannelId. It updates every 30 seconds to show the most current player counts.

Troubleshooting

• Bot is Offline – Double-check your token. Ensure the server has internet access.
• Commands don't work – Ensure both Gateway Intents are enabled in the Developer Portal.
• Status isn't showing other servers:
  • Check if the other servers are connected to the same MySQL table
  • Verify that statusMode is set to GLOBAL on the reporting servers
  • Ensure you used a unique serverId for each one

Support Discord: discord.gg/DRxwt8Qg2W
Documentation: hyronix.eu/mod.php?id=vanguard

Commands & permissions

Punishment Commands

Command	Permission
/hyban <player> [reason]	vanguard.ban
/hytempban <player> <time> [reason]	vanguard.tempban
/hybanip <player/ip> [reason]	vanguard.banip
/hyunban <player/ip>	vanguard.unban
/hymute <player> [reason]	vanguard.mute
/hytempmute <player> <time> [reason]	vanguard.tempmute
/hyunmute <player>	vanguard.unmute
/hywarn <player> [reason]	vanguard.warn
/hykick <player> [reason]	vanguard.kick

Action & Status Commands

Command	Permission
/hyfreeze <player>	vanguard.freeze
/hystatus or /hybotstatus	vanguard.status

Jail Commands

Command	Permission
/hysetjail <name>	vanguard.jail.set
/hyjail <player> <jail> [duration] [reason]	vanguard.jail
/hyunjail <player>	vanguard.jail.unjail
/hydeljail <name>	vanguard.jail.del

Inspection Commands

Command	Permission
/hyinvsee <player>	vanguard.invsee
/hybacksee <player>	vanguard.backsee

Community Reporting

Command	Permission
/hyreport (Alias: /report)	Default
/hybugreport (Alias: /bugreport)	Default
/hyreportlist (Alias: /reportlist)	vanguard.admin
/hybuglist (Alias: /buglist)	vanguard.admin

Lookup & History

Command	Permission
/hycheck <player>	vanguard.check
/hyhistory <player> [type]	vanguard.history
/hybanlist [page]	vanguard.history

Admin & Utility

Command	Permission
/hylist or /hyadmin (Opens Admin/History UI)	vanguard.admin
/hylist reload	vanguard.admin
/hyvanish	vanguard.vanish
/hyunvanish	vanguard.vanish
/hycc (Clear global chat)	vanguard.admin.clearchat
/hyac (Toggle Admin Only chat)	vanguard.admin.chat
/hyblacklist (Word blacklist UI)	vanguard.admin.blacklist

Hytale UI assets

Vanguard includes a custom Hytale UI for managing bans. The server automatically extracts assets to mods/Vanguard on startup. Ensure players have this mod enabled or bundled in your server's asset pack. Without it, moderation still works, but the custom /hylist menu will not display.

Technical synchronization

Vanguard uses a "Single Source of Truth" database system. When staff run a command in Hytale, data is pushed to MySQL. The website pulls directly from that MySQL database in real-time. Multiple Hytale servers can share the same database for global moderation across your network.

Plugin configuration (config.json)

Vanguard is built to be almost entirely configuration-driven. You can customize nearly every aspect of the plugin to better suit your server's needs.

Database settings

• Full MySQL/MariaDB connection details (Host, Port, Credentials)
• Customizable Table Prefix to keep your database organized

Server & localization

• Server Name & Scope – For multi-server setups
• Global Timezone Support – Ensure players see accurate expiration times
• Support Link – Direct players to your Discord or Website for appeals
• Dynamic Translation Keys – For 'Reason', 'Expires', and 'Support' labels

Discord integration (discordconfig.json)

Full control over the standalone Discord Bot module:

• Bot Token & Gateway Intents – Securely connect your bot to the plugin
• Channel Mapping – Dedicated IDs for Network Status and Admin/Punishment Logs
• Global Network Mode – Toggle cluster-wide aggregation across multiple server instances
• Dynamic Timestamps – Enable/Disable relative time formatting for punishment history
• Custom Footers & Metadata – Personalize every embed sent to your Discord channel

Jail settings

• Toggle jail restrictions individually: deny chat, deny block breaking, deny block placing
• Set maximum distance from jail location before players are pulled back
• All jail denial messages are fully translatable for multi-language servers

Notifications & broadcasts

• Toggle Broadcasts on/off globally
• Set punishments to be "Silent" by default for stealthy moderation
• Fully customizable Chat Messages for every action (No permission, Player offline, etc.)
• Custom Broadcast Strings with full placeholder support ({player}, {executor}, {reason}, {until})

Smart styling & messaging

• Edit Default Punishment Messages (the text players see when they are banned/muted)
• Customizable Usage/Help messages for every single command
• Smart Auto-Styling handles the "premium" formatting so your config stays clean

Technical specifications

• Optimized for Hytale Server API
• Minimal performance footprint
• Robust error handling and logging
• Support for Hytale's latest permission systems

Website customization (inc/settings.php)

• Colors – Edit $this->navbar_classes or $this->badge_classes
• Logo/Name – Edit $this->name
• Timezone – Edit $this->timezone to match your server
• Avatars – Change $this->avatar_source or size
• Pagination – Change $this->limit_per_page
• Filtering – Toggle $this->show_inactive_bans to show or hide expired data

Troubleshooting

• Website blank? Enable $this->error_reporting = true; in inc/settings.php
• No data on site? Ensure plugin tablePrefix and website table_prefix match exactly
• UI not opening? Check console logs for "Asset extraction" errors