Messages Configuration

Messages Configuration

The messages.yml file contains all plugin messages, including the prefix and various notification messages. This guide will help you customize every message in the plugin.

File Overview

The messages file is located at:

plugins/CustomCommands/messages.yml

Prefix Configuration

Setting the Prefix

prefix: "&#00FFAA[CustomCommands] "

The prefix is automatically replaced in all messages that contain {prefix}. You can use:

• Color codes - &a, &c, &6, etc.
• Hex colors - &#FF8800, &#00FFAA, etc.
• Formatting - &l (bold), &o (italic), &n (underline)

Prefix Examples

# Simple prefix
prefix: "&a[CustomCommands] "

# Colored prefix with hex
prefix: "&#00FFAA[CustomCommands] "

# Fancy prefix with formatting
prefix: "&6&l[&eCustom&6&l] &r"

# Minimal prefix
prefix: "&7[CC] "

Message Categories

General Messages

These messages appear when the plugin is enabled/disabled:

welcome: "`{prefix}`&aWelcome to the Custom Commands plugin!"
plugin_enabled: "`{prefix}`&aPlugin has been enabled successfully!"
plugin_disabled: "`{prefix}`&cPlugin has been disabled!"

Variables:

• {prefix} - Plugin prefix (automatically replaced)

Customization Examples:

# Friendly welcome message
welcome: "`{prefix}`&a&lWelcome to Custom Commands! &7Create amazing commands with ease!"

# Professional enabled message
plugin_enabled: "`{prefix}`&a&l✓ &aCustom Commands has been successfully enabled!"

# Warning disabled message
plugin_disabled: "`{prefix}`&c&l⚠ &cCustom Commands has been disabled!"

Reload Messages

Messages related to the reload command:

reload_start: "`{prefix}`&eReloading configuration files..."
reload_success: "`{prefix}`&aConfiguration files reloaded successfully!"
reload_error: "`{prefix}`&cFailed to reload configuration files! Check console for details."
reload_no_permission: "`{prefix}`&cYou don't have permission to reload the plugin!"

Variables:

• {prefix} - Plugin prefix

Customization Examples:

# Detailed reload messages
reload_start: "`{prefix}`&e&l🔄 &eReloading all configuration files..."
reload_success: "`{prefix}`&a&l✓ &aAll configurations reloaded successfully!"
reload_error: "`{prefix}`&c&l✗ &cFailed to reload! Check console for error details."
reload_no_permission: "`{prefix}`&c&l⚠ &cYou need &eOP &cpermission to reload the plugin!"

Command Messages

General command-related messages:

command_not_found: "`{prefix}`&cCommand not found: {command}"
command_no_permission: "`{prefix}`&cYou don't have permission to use this command!"

Variables:

• {prefix} - Plugin prefix
• {command} - The command that was not found

Customization Examples:

# Helpful error messages
command_not_found: "`{prefix}`&c&l✗ &cUnknown command: &e{command} &7- Use &e/help &7for available commands"
command_no_permission: "`{prefix}`&c&l⚠ &cAccess denied! You need permission to use this command."

Custom Command Messages

Messages for custom command execution:

custom_command_executed: "`{prefix}`&aCustom command '{command}' executed by {player}!"
custom_command_cooldown: "`{prefix}`&cYou must wait {time} seconds before using this command again!"
custom_command_disabled: "`{prefix}`&cThis command is currently disabled!"

Variables:

• {prefix} - Plugin prefix
• {command} - Command name
• {player} - Player name
• {time} - Remaining cooldown time

Customization Examples:

# Detailed execution message
custom_command_executed: "`{prefix}`&a&l✓ &aCommand &e{command} &aexecuted by &b{player}&a!"

# Friendly cooldown message
custom_command_cooldown: "`{prefix}`&c&l⏰ &cPlease wait &e{time} &cseconds before using this command again!"

# Clear disabled message
custom_command_disabled: "`{prefix}`&c&l⚠ &cThis command is currently disabled by an administrator!"

Info Messages

Information display messages:

info_version: "`{prefix}`&eCustom Commands v{version}"
info_author: "`{prefix}`&eAuthor: {author}"
info_help: "`{prefix}`&eUse /customcommands help for available commands"

Variables:

• {prefix} - Plugin prefix
• {version} - Plugin version
• {author} - Plugin author

Customization Examples:

# Detailed version info
info_version: "`{prefix}`&6&lCustom Commands &ev{version} &7by &bZenith-Studios"
info_author: "`{prefix}`&7Developed by &b{author} &7from &6Zenith-Studios"
info_help: "`{prefix}`&7Need help? Use &e/customcommands help &7or join our &bDiscord&7!"

Support Messages

Support and help information:

support_info: "`{prefix}`&6=== Support Information ==="
support_discord: "&eDiscord Server: &bhttps://discord.gg/2qCMn6KHj4"
support_help: "&7Join our Discord for support and updates!"
support_footer: "`{prefix}`&6=============================="

Variables:

• {prefix} - Plugin prefix (only in support_footer)

Customization Examples:

# Professional support section
support_info: "`{prefix}`&6&l=== &eSupport &6&l==="
support_discord: "&7• &eDiscord: &bhttps://discord.gg/2qCMn6KHj4"
support_help: "&7• &eHelp: &7Join our Discord for support and updates!"
support_footer: "`{prefix}`&6&l=============================="

# Minimal support info
support_info: "`{prefix}`&6Support"
support_discord: "&7Discord: &bhttps://discord.gg/2qCMn6KHj4"
support_help: "&7Need help? Join our Discord!"
support_footer: "`{prefix}`&6================"

Help Messages

Help command display:

help_header: "`{prefix}`&6=== Custom Commands Help ==="
help_reload: "&e/customcommands reload &7- Reload configuration files"
help_help: "&e/customcommands help &7- Show this help message"
help_version: "&e/customcommands version &7- Show plugin version"
help_support: "&e/customcommands support &7- Show support information"
help_footer: "`{prefix}`&6=============================="

Variables:

• {prefix} - Plugin prefix (only in header and footer)

Customization Examples:

# Detailed help with emojis
help_header: "`{prefix}`&6&l=== &eCustom Commands Help &6&l==="
help_reload: "&7• &e/customcommands reload &7- &aReload all configuration files"
help_help: "&7• &e/customcommands help &7- &aShow this help message"
help_version: "&7• &e/customcommands version &7- &aShow plugin version information"
help_support: "&7• &e/customcommands support &7- &aShow support information"
help_footer: "`{prefix}`&6&l=============================="

# Simple help format
help_header: "`{prefix}`&6Help Commands:"
help_reload: "&e/customcommands reload &7- Reload configs"
help_help: "&e/customcommands help &7- Show help"
help_version: "&e/customcommands version &7- Show version"
help_support: "&e/customcommands support &7- Show support"
help_footer: "`{prefix}`&6================"

Advanced Message Features

Color Code Support

The plugin supports all Minecraft color codes and hex colors:

# Traditional color codes
message: "&aGreen text &cRed text &6Gold text"

# Hex colors
message: "&#FF8800Orange text &#00FFAACyan text"

# Combined formatting
message: "&l&aBold green &o&cItalic red &n&bUnderlined aqua"

Special Formatting

Small Caps

message: "&6%smcaps%SMALL CAPS TEXT%smreset% &7normal text"

Clickable Links

message: "&7Visit: (Discord)[<https://discord.gg/2qCMn6KHj4>]"

Multi-line Messages

message:
  - "&6&l=== Title ==="
  - "&7Line 1 of your message"
  - "&7Line 2 of your message"
  - "&7&oItalic footer text"

Variable Usage

Available Variables

• {prefix} - Plugin prefix
• {player} - Player name
• {command} - Command name
• {time} - Cooldown time
• {version} - Plugin version
• {author} - Plugin author

Variable Examples

# Using player variable
welcome: "`{prefix}`&aWelcome &e{player}&a!"

# Using command variable
command_not_found: "`{prefix}`&cCommand &e{command} &cnot found!"

# Using time variable
cooldown: "`{prefix}`&cWait &e{time} &cseconds!"

Message Customization Tips

Best Practices

1. Keep it Short - Long messages can be overwhelming
2. Use Colors Wisely - Too many colors can be distracting
3. Be Consistent - Use the same color scheme throughout
4. Test Changes - Use /customcommands reload to test
5. Backup Original - Keep a backup of working messages

Common Customizations

Server Branding

prefix: "&6&l[&eYourServer&6&l] &r"
welcome: "`{prefix}`&aWelcome to &eYourServer&a!"

Professional Look

prefix: "&7[&bCustomCommands&7] "
reload_success: "`{prefix}`&a&l✓ &aConfiguration reloaded successfully"

Fun and Colorful

prefix: "&d&l[&5CustomCommands&d&l] &r"
welcome: "`{prefix}`&d&l✨ &aWelcome to the amazing Custom Commands plugin! &d&l✨"

Testing Your Messages

Reload Command

After making changes, use:

/customcommands reload

Test Commands

Test your messages with:

/customcommands help
/customcommands version
/customcommands support

Check Logs

Monitor the logs for any issues:

plugins/CustomCommands/logs/latest.log

Troubleshooting

Common Issues

Messages Not Updating

• Use /customcommands reload after changes
• Check for YAML syntax errors
• Verify file permissions

Color Codes Not Working

• Ensure proper color code format (&a, not §a)
• Check for typos in color codes
• Verify hex color format (&#RRGGBB)

Variables Not Replacing

• Check variable spelling ({prefix}, not {Prefix})
• Ensure variables are in the correct context
• Verify the variable is supported in that message

---

Next Steps

Now that you understand message configuration:

1. Read the Commands Guide - Learn about available commands
2. Check out Examples - See practical message examples
3. Explore Permissions - Set up proper permission systems

For support and updates, join our Discord server.