Skip to content

GGLVXD/MinecraftStateMessages

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

5 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

MinecraftStateMessages

Version Minecraft Discord

A powerful Minecraft server plugin that sends real-time server status notifications to Discord via webhooks with customizable embeds.

Features โ€ข Installation โ€ข Configuration โ€ข Support


๐Ÿ“‹ Features

  • ๐Ÿ”” Real-time Notifications - Instant Discord notifications when your server starts or stops
  • ๐ŸŽจ Customizable Embeds - Beautiful, fully customizable Discord embeds with color coding
  • ๐Ÿ”ง Flexible Configuration - Easy-to-use YAML configuration with sensible defaults
  • ๐ŸŽฏ Lightweight - Minimal performance impact on your server

๐Ÿ“ฆ Installation

  1. Download the latest MinecraftStateMessages.jar from the releases page
  2. Place the JAR file in your server's plugins/ directory
  3. Restart your server
  4. Configure the plugin by editing plugins/MinecraftStateMessages/config.yml
  5. Run /reload or restart the server to apply changes

โš™๏ธ Configuration

After the first run, a config.yml file will be generated in plugins/MinecraftStateMessages/. Here's a detailed breakdown of all configuration options:

Basic Settings

# Message sent to Discord when the server starts
server-start-message: "Server has been started!"

# Message sent to Discord when the server stops
server-stop-message: "Server has been stopped!"

# Your Discord webhook URL - get this from Discord Server Settings > Integrations > Webhooks
discord-webhook-url: "https://discord.com/api/webhooks/your-webhook-url"

Embed Settings

# Enable or disable Discord embeds (if false, sends plain text messages)
embed-enabled: true

# Color for server start notifications
# Supported: green, red, blue, yellow, orange, purple, gray/grey, black, white
# Or use hex codes: "#2ECC71" or "2ECC71"
embed-start-color: "green"

# Color for server stop notifications
embed-stop-color: "red"

# Title displayed at the top of the embed
# Leave empty ("") to hide the title completely
embed-title: "Minecraft Server"

๐ŸŽจ Color Reference

Color Name Hex Code Preview
green #2ECC71 ๐ŸŸข Perfect for start messages
red #E74C3C ๐Ÿ”ด Perfect for stop messages
blue #3498DB ๐Ÿ”ต General information
yellow #FFFF00 ๐ŸŸก Warnings
orange #E67E22 ๐ŸŸ  Alerts
purple #9B59B6 ๐ŸŸฃ Special events
gray/grey #95A5A6 โšช Neutral
black #23272A โšซ Discord dark theme
white #FFFFFF โšช Bright

You can also use any custom hex color:

embed-start-color: "#FF6B6B"  # Custom coral red
embed-stop-color: "4ECDC4"    # Custom turquoise (# is optional)

Configuration Examples

Example 1: Minimal Setup (No Title)

server-start-message: "โœ… Server Online"
server-stop-message: "โŒ Server Offline"
discord-webhook-url: "https://discord.com/api/webhooks/123456789/abcdefg"
embed-enabled: true
embed-start-color: "green"
embed-stop-color: "red"
embed-title: ""  # Empty = no title shown

Example 2: Branded Server

server-start-message: "๐ŸŽฎ The server is now online and ready for players!"
server-stop-message: "๐Ÿ›‘ The server is now offline for maintenance."
discord-webhook-url: "https://discord.com/api/webhooks/123456789/abcdefg"
embed-enabled: true
embed-start-color: "#00FF00"
embed-stop-color: "#FF0000"
embed-title: "๐ŸŒŸ AwesomeCraft Network"

Example 3: Simple Text Messages (No Embeds)

server-start-message: "[SERVER] Started successfully!"
server-stop-message: "[SERVER] Shutting down..."
discord-webhook-url: "https://discord.com/api/webhooks/123456789/abcdefg"
embed-enabled: false  # Sends plain text instead of embeds
embed-start-color: "green"
embed-stop-color: "red"
embed-title: ""

๐Ÿ”— Setting Up Discord Webhook

  1. Open your Discord server
  2. Go to Server Settings โ†’ Integrations โ†’ Webhooks
  3. Click New Webhook or Create Webhook
  4. Customize the webhook name and channel
  5. Click Copy Webhook URL
  6. Paste the URL into discord-webhook-url in your config.yml

๐Ÿ› ๏ธ Advanced Usage

Title Visibility

The embed-title field has special behavior:

  • Set to any text: Displays that text as the embed title
    embed-title: "My Awesome Server"
  • Set to empty string ("")): No title will be shown
    embed-title: ""
  • Not specified/removed: No title will be shown (same as empty)

Multiple Webhooks (Advanced)

Want to send notifications to multiple Discord channels? You can modify the webhook URL dynamically or create multiple configurations. For advanced setups, consider forking this plugin and adding multi-webhook support.

๐Ÿ” Troubleshooting

Webhook not sending

Problem: No messages appear in Discord

Solutions:

  • โœ… Verify your webhook URL is correct
  • โœ… Ensure discord-webhook-url is not set to the default placeholder
  • โœ… Check server console for error messages
  • โœ… Confirm the webhook hasn't been deleted in Discord
  • โœ… Test the webhook URL using a tool like webhook.site

Colors not working

Problem: Embeds show wrong colors or no color

Solutions:

  • โœ… Use supported color names (see Color Reference)
  • โœ… If using hex codes, ensure format is correct: "#FF0000" or "FF0000"
  • โœ… Reload the plugin after changing colors

Title showing when it shouldn't

Problem: Title appears even when set to empty

Solutions:

  • โœ… Ensure embed-title: "" is exactly like this (empty quotes)
  • โœ… Remove any spaces between quotes: โŒ " " โ†’ โœ… ""
  • โœ… Reload/restart server after config changes

๐Ÿค Support & Links

Get Help & Stay Connected

Discord Support Developer Fryde

  • ๐Ÿ’ฌ Support Server: dsc.gg/gglvxd - Get help, report bugs, or suggest features
  • ๐Ÿ‘จโ€๐Ÿ’ป Developer: gglvxd.net - Visit the developer's website
  • ๐Ÿข Organization: Fryde - Powered by Fryde

๐Ÿ“ Permissions

This plugin requires no special permissions. It only needs:

  • File system access for config management
  • Network access for webhook requests

๐Ÿ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Credits

Developed with โค๏ธ by gglvxd


Made with ๐Ÿ’œ by gglvxd | Powered by Fryde

If you like this plugin, consider giving it a โญ and joining our Discord!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages