Minecraft plugin EssentialsDiscord

🔌 About EssentialsX Discord

EssentialsX Discord (distributed as the EssentialsDiscord module) is an official EssentialsX module that integrates a Minecraft server with a Discord server. It runs as a plugin jar alongside the core EssentialsX module and connects to Discord via a configured bot token to relay chat, events, and provide Discord-side interactions backed by a small API.

🎯 Purpose

The module's core purpose is twofold: relay selected Minecraft chat/events to Discord channels and relay selected Discord messages/commands into the Minecraft server. It is intended for server administrators who want direct, configurable communication and limited remote control between Discord and an EssentialsX-backed Minecraft server.

⚙️ Features

• Configurable channel mapping for different message types (chat, join/leave, staff, etc.).
• Relay of Minecraft chat to Discord and optional relay of Discord messages into Minecraft chat.
• Discord-side slash commands that can execute console commands, message players, and show player lists (configurable and restricted by roles).
• Fine-grained message-type system and per-type formatting defined in the plugin config.
• Developer API for registering custom message types and Discord interaction commands via a provided DiscordService API.

🧩 Who It Is For

• Server owners running EssentialsX who want Discord ↔ Minecraft chat synchronization.
• Staff teams that want private staff channels bridged to in-game staff members.
• Plugin developers who want to expose simple Discord interactions or custom message hooks to Discord.

🏗️ Example Use Cases

• Forward global chat to a dedicated Discord channel while sending staff-only Discord messages to in-game staff.
• Allow verified Discord roles to run configured server queries or commands via slash commands without exposing them publicly.
• Have another plugin send structured notifications to Discord by registering a custom message type with the EssentialsX Discord API.

⌨️ Commands

EssentialsX Discord exposes configurable Discord-side slash commands (registered with Discord) rather than typical Minecraft chat commands. Those commands (examples shown in the official docs) run from Discord and can execute console commands, message players, or show player lists. Command availability and elevated features are controlled by role/ID configuration in the plugin config.

🔐 Permissions

⚙️ Installation

📥 Setup

• Download the EssentialsX Discord module jar and place it in your server plugins/ directory alongside the core EssentialsX jar.
• Start the server to generate the module's config, then stop the server.
• Configure the bot token, channel IDs, message-types, and command role settings in plugins/EssentialsDiscord/config.yml as documented, then restart.

📦 Dependencies

• EssentialsX (core) — the module runs as an add-on to the EssentialsX plugin suite.

🧠 Technical Notes

• The module provides a service API (DiscordService) for other plugins to register custom message types and to send messages into configured Discord channels.
• Discord-side commands are controlled by roles/IDs configured in the plugin config rather than by standard Minecraft permission nodes.
• Admin-style configuration (bot token, channel IDs, message formatting, command role IDs) is done in the module config file created on first run.

🤝 When This Plugin Is Useful

When you need managed, configurable two-way communication between a Discord community and an EssentialsX-backed Minecraft server (including role-restricted Discord commands and developer hooks), EssentialsX Discord provides a focused module that handles message mapping and a small API for integrations.