myMotd 2.0 - Plugin Guide
Overview
myMotd 2.0 is a powerful MOTD plugin for Paper (1.21.x) and BungeeCord/Waterfall servers, designed to enhance your server's appearance in the Minecraft server list. With support for PlaceholderAPI, HEX colors, dynamic favicons, centered text, and more, myMotd makes your server stand out while being easy to configure and use.
Features
- PlaceholderAPI Integration: Use dynamic placeholders like %player_name% or %vault_rank% in your MOTD (Paper).
- PAPIProxyBridge Support: Extend PlaceholderAPI placeholders to BungeeCord for network-wide consistency.
- HEX Colors: Add vibrant colors using HEX codes (e.g., #00FF00) in MOTD.
- Dynamic Favicon: Set a custom server icon (PNG) for Paper servers.
- Centered MOTD: Optionally center-align MOTD text for a polished look.
- Max Players: Configure the maximum player count displayed in the server list.
- Config Reload: Update settings with /motdreload without restarting.
- Custom Placeholders: Built-in %online% and %max% placeholders.
- Robust Error Handling: Clear logs for issues with dependencies or configuration.
Requirements
- Paper Servers:
- PlaceholderAPI (required for placeholders).
- Paper 1.21.x or compatible forks (e.g., Purpur).
- BungeeCord/Waterfall:
- PAPIProxyBridge or Hangar (required for placeholders).
- PlaceholderAPI installed on at least one connected Paper server.
- Optional:
- PlaceholderAPI expansions (e.g., Vault, LuckPerms) for additional placeholders.
- A 64x64 PNG file for the favicon (Paper only).
Installation
- Download: Get the myMotd-2.0.jar from the SpigotMC resource page.
- Install:
- Paper: Place myMotd-2.0.jar in the plugins/ folder of your Paper server.
- BungeeCord: Place myMotd-2.0.jar in the plugins/ folder of your BungeeCord/Waterfall proxy.
- Dependencies:
- Install PlaceholderAPI on Paper servers.
- Install PAPIProxyBridge on BungeeCord.
- Optionally, add PlaceholderAPI expansions (e.g., /papi ecloud download Vault).
- Start Servers: Launch your Paper and/or BungeeCord servers to generate config.yml in the plugins/myMotd/ folder.
Configuration
The config.yml file allows you to customize the MOTD, max players, favicon, and text alignment. Below is an example configuration with explanations.
Code (Text):
# myMotd Configuration
motd:
- "<gold>Welcome, %player_name%! <#00FF00>Join now!</#00FF00> Rank: %vault_rank% Players: %online%/%max%"
- "<blue>Rank: %vault_rank%!</blue> <#FFFF00>Click to join!</#FFFF00> Online: %online%"
- "<red>Survival & Creative!</red> <#FFFFFF>Play today!</#FFFFFF> Slots: %online%/%max%"
max-players: 100
favicon: "server-icon.png" # Path to favicon (PNG, 64x64, Paper only)
center-motd: true # Center-align MOTD text
- motd: List of MOTD messages displayed randomly. Supports:
- HEX colors (e.g., <#00FF00>text</#00FF00>).
- PlaceholderAPI placeholders (e.g., %player_name%, %vault_rank%).
- Custom placeholders (%online%, %max%).
- max-players: Maximum players shown in the server list (default: 100).
- favicon: Path to a 64x64 PNG file in plugins/myMotd/ (Paper only, e.g., server-icon.png).
- center-motd: Set to true to center-align MOTD text, false to disable.
Commands
- /motdreload
- Description: Reloads config.yml, updating MOTD, max players, favicon, and centering.
- Permission: motd.reload (default: op on Paper, required on BungeeCord).
- Usage: /motdreload
Permissions
- motd.reload:
- Description: Allows use of /motdreload.
- Default: op (Paper), none (BungeeCord).
Testing and Verification
- Join your server via the Minecraft server list and check the MOTD.
- Verify that HEX colors (e.g., #00FF00) and placeholders (e.g., %vault_rank%) display correctly.
- If center-motd: true, ensure the MOTD is centered.
- On Paper, confirm the favicon (if set) appears in the server list.
- Run /motdreload and verify that changes in config.yml apply instantly.
- On BungeeCord, check that PAPIProxyBridge placeholders (e.g., %vault_rank%) work.
Troubleshooting
- MOTD not updating?
- Ensure config.yml is valid YAML (use an online YAML validator).
- Run /motdreload after changes.
- Placeholders not working?
- Confirm PlaceholderAPI is installed on Paper and PAPIProxyBridge on BungeeCord.
- Check for required PlaceholderAPI expansions (e.g., /papi ecloud download Vault).
- Favicon not showing?
- Verify the favicon is a 64x64 PNG in plugins/myMotd/.
- Check server logs for favicon loading errors.
- Errors in console?
- Look for logs about missing dependencies or configuration issues.
- Report issues in the SpigotMC discussion thread with full error logs.
Notes
- Favicon support is Paper-only; BungeeCord requires manual proxy configuration for server icons.
- Some PlaceholderAPI placeholders (e.g., %player_name%) may not work on BungeeCord without a player context. Use server-wide placeholders (e.g., %vault_rank%).
- The centering feature approximates text width; results may vary with complex formatting.
Thank you for choosing myMotd 2.0! For support, post in the SpigotMC discussion thread or contact us directly.