💬 AuryxDiscord - Lightweight Minecraft-Discord Integration
AuryxDiscord is a lightweight, high-performance Minecraft-Discord integration plugin built without JDA. Using modern HTTP clients (OkHttp + Jetty), it provides seamless two-way communication between your Minecraft server and Discord with minimal resource usage.
✨ Key Features
💬 Two-Way Communication
- Minecraft → Discord - Chat messages, events, notifications via webhooks
- Discord → Minecraft - Messages from Discord appear in-game via HTTP server
- Real-time sync - Instant message delivery with async processing
- No JDA dependency - Lightweight HTTP-only implementation
🎮 Server Events Integration
- Join/Leave Messages - Player connection notifications with custom formats
- Death Messages - Death notifications with cause and custom formatting
- Chat Synchronization - Full chat integration with AuryxChat support
- Punishment Alerts - Ban/mute/kick notifications for moderation teams
- Server Status - Startup/shutdown notifications
🎨 Rich Formatting & Customization
- Discord Embeds - Beautiful rich messages with colors and timestamps
- Player Avatars - Automatic player head integration via Minotar
- Custom Formats - Fully customizable message templates for each event type
- Placeholder Support - PlaceholderAPI and AuryxCore placeholder integration
- Emoji Support - 🟢 Join, 🔴 Leave, ☠️ Death, ⚠️ Punishments
🔧 Advanced Configuration
- Multiple Webhooks - Separate channels for chat, logs, deaths, punishments
- Event Filtering - Enable/disable specific event types
- Message Queuing - Anti-spam protection with configurable queue limits
- HTTP Server - Built-in Jetty server for Discord → MC communication
🎮 Commands Overview
| Command |
Description |
Permission |
/auryxdiscord |
Main plugin command |
auryxdiscord.admin |
/auryxdiscord reload |
Reload configuration |
auryxdiscord.reload |
/auryxdiscord test [message] |
Send test message to Discord |
auryxdiscord.test |
/auryxdiscord info |
View plugin status and integration info |
auryxdiscord.info |
🔄 How It Works
Minecraft → Discord Flow
- Event Detection - Listeners capture chat, join/leave, death events
- Message Formatting - Apply custom templates with placeholders
- Webhook Delivery - Send via OkHttp to Discord webhook URLs
- Queue Management - Async processing prevents server lag
Discord → Minecraft Flow
- HTTP Server - Built-in Jetty server receives Discord webhooks
- Message Processing - Parse and validate incoming Discord messages
- Chat Integration - Forward to AuryxChat or broadcast directly
- Security - Webhook signature verification for safety
📋 Message Examples
Discord Notifications
🟢 **Sqrilizz** joined the server (Players: 5/20)
[MC] Sqrilizz: Hello everyone from Minecraft!
☠️ Sqrilizz was slain by Zombie
⚠️ **Admin** banned **Griefer**: Griefing spawn area
✅ **Server started** - Players can now join!
Minecraft Chat
[Discord] DiscordUser: Hello from Discord!
[Discord] Moderator: Server restart in 5 minutes
⚙️ Configuration Highlights
Webhook Setup (config.yml)
webhooks:
chat: "https://discord.com/api/webhooks/YOUR_CHAT_WEBHOOK"
log: "https://discord.com/api/webhooks/YOUR_LOG_WEBHOOK"
death: "https://discord.com/api/webhooks/YOUR_DEATH_WEBHOOK"
punishment: "https://discord.com/api/webhooks/YOUR_MOD_WEBHOOK"
Event Configuration
events:
join-leave: true
deaths: true
punishments: true
console: false
startup-shutdown: true
Message Formats
formats:
join: "🟢 **{player}** joined the server (Players: {online}/{max})"
leave: "🔴 **{player}** left the server"
death: "☠️ {death_message}"
ban: "⚠️ **{staff}** banned **{player}**: {reason}"
HTTP Server (Discord → MC)
server:
enabled: true
port: 8080
path: "/discord-webhook"
secret: "your-webhook-secret"
🌐 Platform Compatibility
| Platform |
Status |
Features |
| Paper |
✅ Full Support |
All features available |
| Folia |
✅ Full Support |
Thread-safe implementation |
| Spigot |
✅ Compatible |
Core features work |
| Bukkit |
✅ Compatible |
Basic functionality |
| Purpur |
✅ Enhanced |
Additional optimizations |
| Velocity |
✅ Supported |
Cross-server integration |
🔗 Integration & Dependencies
Required Dependencies
Optional Integrations
Developer API
// Get AuryxDiscord API
AuryxDiscordAPI api = AuryxDiscord.getAPI();
// Send messages to Discord
api.sendChatMessage(player, "Hello Discord!");
api.sendLogMessage("Server event occurred");
api.sendEmbed("Title", "Description", "#5865F2");
// Check integration status
boolean enabled = api.isDiscordEnabled();
boolean chatSync = api.isChatEnabled();
🚀 Performance & Technical Details
Lightweight Architecture
- No JDA - Uses OkHttp for HTTP requests (much lighter)
- Async Processing - All Discord operations are non-blocking
- Smart Queuing - Message queue prevents spam and rate limiting
- Memory Efficient - Minimal RAM usage compared to bot-based solutions
HTTP Components
- OkHttp Client - Modern, efficient HTTP requests to Discord
- Jetty Server - Embedded HTTP server for receiving Discord messages
- Gson JSON - Fast JSON processing for webhook payloads
- Shaded Dependencies - No conflicts with other plugins
Cross-Version Support
- Single JAR - Works on Minecraft 1.8.8 through 1.21.10
- API Compatibility - Adapts to different Bukkit/Paper API versions
- Legacy Support - Maintains compatibility with older server versions
📊 Setup Guide
1. Installation
- Download AuryxCore (required)
- Download AuryxDiscord from Modrinth
- Place both JARs in your
plugins/ folder
- Restart your server
2. Discord Webhook Setup
- Go to your Discord server settings
- Navigate to Integrations → Webhooks
- Create webhooks for different channels:
#minecraft-chat - For player chat messages#server-logs - For join/leave/death events#moderation - For punishment notifications
- Copy webhook URLs to
config.yml
3. Configuration
# Basic setup - just add your webhook URLs
webhooks:
chat: "https://discord.com/api/webhooks/123456789/abcdefg"
log: "https://discord.com/api/webhooks/987654321/hijklmn"
# Enable desired events
events:
join-leave: true
deaths: true
punishments: true
# Optional: Enable Discord → Minecraft
server:
enabled: true # Allows Discord users to send messages to MC
port: 8080
secret: "change-this-secret"
4. Testing
/auryxdiscord info # Check integration status
/auryxdiscord test # Send test message to Discord
🎯 Use Cases
🏰 Roleplay Servers
- Immersive Discord integration for RP communities
- Character death notifications
- Staff moderation alerts
🏃 Survival Servers
- Player activity monitoring
- Community chat bridge
- Achievement sharing
🎮 Mini-game Networks
- Cross-server announcements via Velocity
- Tournament notifications
- Player statistics sharing
🛡️ Moderated Communities
- Real-time punishment notifications
- Staff communication bridge
- Server status monitoring
🔧 Advanced Features
Message Placeholders
# Available placeholders in message formats:
{player} # Player name
{displayname} # Player display name
{message} # Chat message content
{server} # Server name
{online} # Current online players
{max} # Maximum players
{balance} # Player balance (AuryxCore)
{death_message} # Full death message
{staff} # Staff member name
{reason} # Punishment reason
# PlaceholderAPI support:
%player_name% # Player name
%server_online% # Online count
%auryxcore_balance% # Player balance
# + 1000+ other PAPI placeholders
Webhook Security
- Signature Verification - Validates incoming Discord webhooks
- Secret Keys - Configurable webhook secrets
- IP Filtering - Optional IP whitelist for HTTP server
- Rate Limiting - Built-in protection against spam
Multi-Channel Setup
webhooks:
chat: "https://discord.com/api/webhooks/chat-webhook"
log: "https://discord.com/api/webhooks/log-webhook"
death: "https://discord.com/api/webhooks/death-webhook"
punishment: "https://discord.com/api/webhooks/mod-webhook"
# Events automatically route to appropriate channels
# Falls back to 'log' webhook if specific webhook not configured
📞 Support & Community
🆚 Why Choose AuryxDiscord?
vs Traditional Discord Bots:
- ✅ No Bot Hosting - Runs directly on your Minecraft server
- ✅ Lower Resource Usage - No JDA, just HTTP requests
- ✅ Easier Setup - No bot tokens or permissions needed
- ✅ Better Integration - Direct access to server events and data
vs Other Discord Plugins:
- ✅ Modern Architecture - Built for Paper/Folia with async processing
- ✅ Lightweight - 6MB vs 20MB+ for JDA-based plugins
- ✅ Two-Way Communication - Most plugins only do MC → Discord
- ✅ Rich Formatting - Embeds, avatars, and advanced placeholders
vs EssentialsX Discord:
- ✅ Better Performance - Async processing and message queuing
- ✅ More Features - HTTP server, multiple webhooks, embeds
- ✅ Active Development - Regular updates and new features
- ✅ Modern Codebase - Java 21, latest APIs, clean architecture
📄 License
AuryxDiscord is licensed under the MIT License. See LICENSE for details.
Made with ❤️ by Auryx Studio
Requires AuryxCore for full functionality. Part of the complete Auryx server management suite!
🚀 Quick Start
- Install: Download AuryxCore + AuryxDiscord
- Configure: Add Discord webhook URLs to config
- Test: Use
/auryxdiscord test command
- Enjoy: Seamless Minecraft-Discord integration!
Transform your server communication today! 🎊💬
