DiscordWebhook

A Hytale server plugin that links in-game events to a Discord channel using a webhook. This plugin automatically sends player join, leave, deaths, and chat messages to your Discord server.

Current Features

• Event Configuration System: Individual configuration files for each event type
• Placeholder System: Dynamic placeholders like {player}, {message}, {deathCause}, etc.
• Multiple Webhook Channels: Route different events to different Discord channels
• Message Customization: Full control over message format (embeds, plain text, or both)
• Event Toggling: Enable or disable individual events
• Update Check: Check Github releases for updates and notifies you if there is one
• Hot Reload: Reload configuration without restarting the server using /dw-reload

Current Events

• Player Join Events: Sends customizable notifications when a player joins the server
• Player Leave Events: Sends customizable notifications when a player leaves the server
• Player Death Events: Sends customizable notifications when a player dies on the server
• Player Chat: Forwards all player chat messages to Discord with full customization

Installation

1. Download the latest release from the releases page
2. Place the DiscordWebhook-x.x.x.jar file into your Hytale server's mods folder
3. Start your server to generate the configuration files
4. Edit the Jemsire_DiscordWebhook/WebhookConfig.json file and add your Discord webhook URL(s)
5. (Optional) Customize individual event configs in Jemsire_DiscordWebhook/events/ folder
6. In-game type /dw-reload to hot reload the config to start the plugin

Note: Default event configurations are automatically created on first launch. You can customize them or leave them as-is.

Configuration

After first launch, configuration files will be created in your mods folder. The plugin uses a two-tier configuration system:

1. WebhookConfig.json: Main configuration with webhook URLs and channels
2. events/: Individual event configuration files

Getting a Discord Webhook URL

1. Open your Discord server settings
2. Go to Integrations → Webhooks
3. Click New Webhook or select an existing webhook
4. Copy the webhook URL
5. Paste it into your WebhookConfig.json file

Main Configuration File (WebhookConfig.json)

The main configuration file is located at Jemsire_DiscordWebhook/WebhookConfig.json:

{
  "WebhookLink": "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL_HERE",
  "Version": 2,
  "UpdateCheck": true,
  "WebhookChannels": {
    "default": "https://discord.com/api/webhooks/YOUR_DEFAULT_WEBHOOK_URL",
    "staff": "https://discord.com/api/webhooks/YOUR_STAFF_WEBHOOK_URL"
  }
}

Configuration Options:

• WebhookLink: Default webhook URL (used as fallback)
• Version: Configuration version (currently 2)
• UpdateCheck: Enable/disable automatic update checking
• WebhookChannels: Map of channel names to webhook URLs (e.g., "default", "staff", "admin")

Event Configuration Files

Each event has its own configuration file in Jemsire_DiscordWebhook/events/. Default configs are automatically created on first launch:

• PlayerChat.json - Player chat messages
• PlayerReady.json - Player join events
• PlayerDisconnect.json - Player leave events
• PlayerDeath.json - Player death events

#### Event Configuration Structure

{
  "Enabled": true,
  "WebhookChannel": "default",
  "MessageJson": "{\"content\": \"💬 **{player}**: {message}\"}"
}

Configuration Options:

• Enabled: Enable or disable this event (true/false)
• WebhookChannel: Which webhook channel to use (must match a key in WebhookChannels from main config)
• MessageJson: Raw Discord webhook JSON with placeholders (see below)

#### Message Format Examples

Plain Text Message:

{
  "Enabled": true,
  "WebhookChannel": "default",
  "MessageJson": "{\"content\": \"💬 **{player}**: {message}\"}"
}

Embed Message:

{
  "Enabled": true,
  "WebhookChannel": "default",
  "MessageJson": "{\"embeds\": [{\"title\": \"📥 Player Joined\", \"description\": \"{player} has entered the world!\", \"color\": 65280}]}"
}

Combined (Text + Embed):

{
  "Enabled": true,
  "WebhookChannel": "default",
  "MessageJson": "{\"content\": \"New player!\", \"embeds\": [{\"title\": \"Player Joined\", \"description\": \"{player} joined the server\", \"color\": 65280}]}"
}

#### Available Placeholders

Placeholders are replaced at runtime with actual values. Use {placeholderName} in your JSON strings.

• {player} - Player's username
• {playerUsername} - Player's username (alias)
• {message} - Chat message content
• {content} - Chat message content (alias)
• {playerUuid} - Player's UUID (if available)
• {deathCause} - Formatted death message
• {deathMessage} - Formatted death message (alias)
• {deathMessageRaw} - Raw death message (if available)

Note: Some Placeholders wont work in some events. Placeholders are automatically escaped for JSON, so special characters won't break your webhook payload.

Commands

• /dw-reload - Reloads the plugin configuration without restarting the server
• Permission: discordwebhook.reload
• Usage: Only reloads if the configuration has changed

This project is open-source:

Feel free to contribute or spin it into your own system! Check out the Github

Want to get updates for all my projects?

Join the discord! Join Now!