Configuration
Full config breakdown for HyDiscordX.json — tokens, channels, bridges, linking, announcements, and multi-server.
Table of Contents
Jump to a section
Overview
What it is, features, and goals
›
Installation
Install steps + recommended setup
›
Commands
Command list + examples
›
Permissions
Permission nodes and rank setup
›
Configurations
Config options and details
›
Tutorials
Common setups and how-to guides
›
Author & Support
Contact, bugs, feedback, links
›
Config Reference
Search + copy tools included. This page is config-focused.
can you retry you lost connection on Configuration
Filters across all configuration sections. Use copy buttons to copy any key.
Tip: search "cooldown", "tpa", "warp", "mute", "custom."
Copy buttons use your clipboard
Config path:
mods/HyDiscordX/HyDiscordX.json
⚙️ discord
| Key | Description |
|---|---|
discord.token Copy |
Discord bot token used to connect to Discord. |
discord.channelId Copy |
Discord channel ID for chat relay and announcements. |
discord.commandChannelId Copy |
Discord channel ID for discord commands |
discord.startStopChannelId Copy |
Discord channel ID for server start and stop messages. If left blank will send to the chat bridge channel discord.channelId |
discord.liveStatsChannelId Copy |
Discord channel ID for server stats message. If left blank it will be disabled |
discord.multiServerEnabled Copy |
When enabled, totals players across servers and displays the total in Discord presence. |
discord.mainServer Copy |
Only the main server updates Discord presence when multi-server is enabled (useful when running on multiple servers with one bot token). |
📢 discordAnnounce
Placeholders:
{player}, {count}| Key | Description |
|---|---|
discordAnnounce.enabled Copy |
Enable/disable join/leave/start/stop messages to Discord. |
discordAnnounce.serverStart Copy |
Message sent on server start. |
discordAnnounce.serverStop Copy |
Message sent on server stop. |
discordAnnounce.playerJoin Copy |
Message sent when a player joins. Supports {player} and {count}. |
discordAnnounce.playerLeave Copy |
Message sent when a player leaves. Supports {player} and {count}. |
🌐 multiServer
| Key | Description |
|---|---|
multiServer.pollSeconds Copy |
How often to poll remote servers for player counts (seconds). |
multiServer.servers
Copy
|
List of servers to poll.
|
Each remote server should expose the web query endpoint:
/Nitrado/Query on the configured port.
🔗 linking
| Key | Description |
|---|---|
linking.codeLength Copy |
Length of the link code generated by /link. |
linking.grantRoleId Copy |
This discord role ID of the role you want assigned on discord when a user links their hytale account./link. |
linking.codeTtlSeconds Copy |
Link code expiry in seconds. |
🧾 Link Storage
| Key | Description |
|---|---|
storage.type Copy |
Where the linked player data is store it can be stored in the following formatsFile, MySQL, MariaDB. |
storage.host Copy |
The ip for your SQL database. |
storage.port Copy |
The port for your SQL database. |
storage.database Copy |
The name of your SQL database. |
storage.username Copy |
The username for your SQL database. |
storage.password Copy |
The password for the user on your SQL database. |
storage.table Copy |
The name of the table made in the database SQL database. There is no need to change this. |
storage.jdbcUrl Copy |
For advanced users only leave blank. |
storage.params Copy |
For advanced users only leave blank. |
storage.useSsl Copy |
Sets if your SQL database uses SSL. |
💬 bridge
| Key | Description |
|---|---|
bridge.discordTagText Copy |
Tag shown for Discord messages in Hytale. |
bridge.discordTagColor Copy |
Color of the Discord tag text in Hytale. |
bridge.defaultNameColor Copy |
Default name color for Discord messages shown in Hytale (used when no role formatting rule matches). |
bridge.defaultMessageColor Copy |
Default message color for Discord messages shown in Hytale (used when no role formatting rule matches). |
bridge.roleDefaultMessageColor Copy |
Fallback message color used by role formatting rules when a role format does not specify its own message color. |
Tip: Role formatting is configured under
discordToHytale.roleFormats.
➡️ discordToHytale
| Key | Description |
|---|---|
discordToHytale.enabled Copy |
Enable/disable relaying Discord messages into Hytale chat. |
discordToHytale.roleFormats Copy |
Optional role-based formatting rules for Discord messages. Each rule can set prefix text, name color, and message color based on Discord roles. |
Common fields inside each role format entry (names may vary by build):
roleId, prefix, prefixColor, nameColor, messageColor.
⬅️ hytaleToDiscord
| Key | Description |
|---|---|
hytaleToDiscord.enabled Copy |
Enable/disable relaying Hytale chat into Discord. |
hytaleToDiscord.sanitizeMentions Copy |
Strip/escape @mentions when relaying to Discord to prevent ping spam. |
🌐 liveStats
| Key | Description |
|---|---|
liveStats.showPlayerCount Copy |
Enable/disable Showing player count on live stats message. |
liveStats.showServerTps Copy |
Enable/disable Showing TPS of the server on live stats message. |
liveStats.showMemoryUsedPercent Copy |
Enable/disable Showing ram usage of the server on live stats message. |
liveStats.showUptime Copy |
Enable/disable Showing uptime of the server on live stats message. |
liveStats.showServerIp Copy |
Enable/disable Showing the IP of the server on live stats message. |
liveStats.showVersion Copy |
Enable/disable Showing the version of the server on live stats message. |
liveStats.showNextRestart Copy |
Enable/disable Showing the next restart time of the server on live stats message. |
liveStats.serverIp Copy |
Set the ip shown on the live stats message. |
liveStats.restartTimes Copy |
Set the times you restart the server on the live stats message. This plugin does not auto restart your server. |
liveStats.titleOnline Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.titleOffline Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelPlayers Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelTps Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelMemory Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelUptime Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelServerIp Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelVersion Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.labelNextRestart Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.valueNotSet Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.valueUnknown Copy |
Change the wording or use your own launguage for the livestats message |
liveStats.showThumbnail Copy |
Enable/disable Image on the livestats message |
liveStats.thumbnailUrl Copy |
Set a custom image to be shown on the livestats message uses a URL to set. If left blank it will use your Discord servers image. |
liveStats.messageId Copy |
Do not change this is so the bot can keep track of the live stats message between restarts. |
📍 Helpful Links
| Item | Description |
|---|---|
| Discord Developer Portal |
Where to create a bot and get your token.
https://discord.com/developers/applications
Copy
|
| Link Storage |
Linked accounts are stored in:
mods/HyDiscordX/links.json
Copy
|