Messages Configuration

The messages.yml file contains all user-facing text displayed by PrimeChat, allowing complete customization of plugin messages, notifications, and feedback.

File Location

plugins/PrimeChat/messages.yml

Structure Overview

Main Components

  • Prefix: Common prefix for all messages

  • Chat Messages: Public chat related notifications

  • Private Messages: Direct messaging system text

  • Security Messages: Anti-spam, word filter, advertising alerts

  • Admin Messages: Staff command feedback

  • Game Messages: Chat games notifications

  • Error Messages: Problem notifications

Global Settings

Message Prefix

# Global prefix used in most messages
prefix: "&#FF6B6B&l[&#FFE66D&lPrimeChat&#FF6B6B&l]&r "

# Alternative prefixes for different contexts
prefixes:
  error: "&#FF4500&l[&#FF6B6B&lERROR&#FF4500&l]&r "
  success: "&#32CD32&l[&#90EE90&lSUCCESS&#32CD32&l]&r "
  warning: "&#FFD700&l[&#FFFF00&lWARNING&#FFD700&l]&r "
  info: "&#87CEEB&l[&#ADD8E6&lINFO&#87CEEB&l]&r "

Color Schemes

# Predefined color schemes for consistency
colors:
  primary: "&#FF6B6B"
  secondary: "&#FFE66D"
  success: "&#32CD32"
  error: "&#FF4500"
  warning: "&#FFD700"
  info: "&#87CEEB"
  text: "&#FFFFFF"
  accent: "&#888888"

Chat Messages

Basic Chat Operations

chat:
  # Chat cleared notification
  cleared: "%prefix%&#32CD32Chat has been cleared by an administrator!"
  
  # Chat lock notifications
  locked: "%prefix%&#FF6B6B Chat is now locked! Only staff can speak."
  unlocked: "%prefix%&#32CD32Chat is now unlocked! Everyone can speak again."
  
  # When player tries to speak in locked chat
  currently-locked: "%prefix%&#FFD700Chat is currently locked. Please wait for it to be unlocked."
  
  # Configuration reload notification
  reloaded: "%prefix%&#32CD32Configuration has been reloaded successfully!"
  reload-error: "%prefix%&#FF4500Error reloading configuration: %error%"

Formatting Messages

chat:
  # Color permission messages
  no-color-permission: "%prefix%&#FF4500You don't have permission to use color codes!"
  no-hex-permission: "%prefix%&#FF4500You don't have permission to use hex colors!"
  no-gradient-permission: "%prefix%&#FF4500You don't have permission to use gradient colors!"
  
  # Format error messages
  invalid-format: "%prefix%&#FF4500Invalid chat format detected. Using fallback format."
  placeholder-error: "%prefix%&#FFD700Some placeholders could not be processed."

Private Messaging

Message Delivery

private-messaging:
  # Message sent confirmation
  sent: "%prefix%&#32CD32Message sent to &#FFFFFF%receiver%&#32CD32!"
  
  # Message received notification (optional)
  received: "%prefix%&#87CEEBYou have a new message from &#FFFFFF%sender%&#87CEEB!"
  
  # Reply system messages
  no-reply-target: "%prefix%&#FF4500You have no one to reply to!"
  reply-target-offline: "%prefix%&#FF4500%player% is no longer online!"
  
  # Self-messaging prevention
  cannot-message-self: "%prefix%&#FF4500You cannot send messages to yourself!"
  
  # Player not found
  player-not-found: "%prefix%&#FF4500Player &#FFFFFF%player%&#FF4500 is not online!"
  
  # Message too long
  message-too-long: "%prefix%&#FF4500Your message is too long! Maximum length: %max% characters."

Social Spy

spy:
  # Spy mode toggle messages
  enabled: "%prefix%&#32CD32Social spy mode &#FFFFFFenabled&#32CD32!"
  disabled: "%prefix%&#FF6B6BSocial spy mode &#FFFFFFdisabled&#FF6B6B!"
  
  # Spy message format
  format: "&#FFD700[SPY] &#FFFFFF%sender% &#888888→ &#FFFFFF%receiver%&#888888: &#D3D3D3%message%"
  
  # No spy permission
  no-permission: "%prefix%&#FF4500You don't have permission to use spy mode!"

Security Messages

Anti-Spam System

security:
  # Spam cooldown warning
  spam-warning: "%prefix%&#FFD700Please wait %time% seconds before sending another message!"
  
  # Spam detection notification (for admins)
  spam-detected: "%prefix%&#FF4500Spam detected from %player%: %message%"
  
  # Extended cooldown warning
  extended-cooldown: "%prefix%&#FF4500You're sending messages too quickly! Please wait %time% seconds."

Blocked Words Filter

security:
  # Blocked word detection
  blocked-word: "%prefix%&#FF4500Your message contains inappropriate language!"
  
  # Blocked word notification (for admins)
  blocked-word-admin: "%prefix%&#FF4500Blocked word detected from %player%: %word%"
  
  # Word replacement notification
  word-replaced: "%prefix%&#FFD700Some words in your message have been censored."

Anti-Advertising

security:
  # Advertising detection messages
  advertising-detected: "%prefix%&#FF4500✖ Advertising is not allowed on this server!"
  
  # Specific detection types
  ip-detected: "%prefix%&#FF4500IP addresses are not allowed in chat!"
  domain-detected: "%prefix%&#FF4500Website domains are not allowed in chat!"
  link-detected: "%prefix%&#FF4500Links are not allowed in chat!"
  
  # Admin notifications
  advertising-admin: "%prefix%&#FF4500Advertising attempt by %player%: %content%"
  
  # Whitelist bypass message
  whitelisted-domain: "%prefix%&#32CD32Domain %domain% is whitelisted and allowed."

Command Messages

Permission Errors

commands:
  # No permission for command
  no-permission: "%prefix%&#FF4500You don't have permission to use this command!"
  
  # Command disabled
  command-disabled: "%prefix%&#FF4500This command is currently disabled!"
  
  # Invalid usage
  invalid-usage: "%prefix%&#FF4500Usage: %usage%"
  
  # Command cooldown
  command-cooldown: "%prefix%&#FFD700Please wait %time% seconds before using this command again!"

Help Messages

help:
  # Main help header
  header: 
    - "&#FFD700&m―――――――――――――――――――――――――――――――――――――――――"
    - "&#FF6B6B&l         PRIMECHAT HELP"
    - "&#FFD700&m―――――――――――――――――――――――――――――――――――――――――"
  
  # Command list
  commands:
    chat: "&#FFE66D/chat &#FFFFFF- Main plugin command"
    msg: "&#FFE66D/msg <player> <message> &#FFFFFF- Send private message"
    reply: "&#FFE66D/reply <message> &#FFFFFF- Reply to last message"
    gui: "&#FFE66D/chat gui &#FFFFFF- Open admin GUI"
    lock: "&#FFE66D/chat lock &#FFFFFF- Lock the chat"
    unlock: "&#FFE66D/chat unlock &#FFFFFF- Unlock the chat"
    clear: "&#FFE66D/chat clearchat &#FFFFFF- Clear the chat"
    spy: "&#FFE66D/chat spy &#FFFFFF- Toggle spy mode"
    reload: "&#FFE66D/chat reload &#FFFFFF- Reload configuration"
  
  # Help footer
  footer:
    - "&#FFD700&m―――――――――――――――――――――――――――――――――――――――――"
    - "&#87CEEB For more help, visit: &#FFFFFFhttps://discord.gg/XTcKTG6vZP"
    - "&#FFD700&m―――――――――――――――――――――――――――――――――――――――――"

Chat Games Messages

Game Notifications

games:
  # Game question format
  question: "&#FFD700⚡ &#FFFF00CHAT GAME &#FFD700⚡ &#FFFFFF%question%"
  
  # Category display
  category: "&#9370DB📚 Category: &#FFFFFF%category%"
  
  # Difficulty indicator
  difficulty: "&#FF6347🌟 Difficulty: %difficulty%/5"
  
  # Time limit warning
  time-limit: "&#FFD700⏰ You have %time% seconds to answer!"
  
  # Game timeout
  timeout: "&#FF6B6B⏰ Time's up! The answer was: &#FFFFFF%answer%"
  
  # Winner announcement
  winner: "&#32CD32🎉 &#FFFFFF%player% &#32CD32won! Answer: &#FFFFFF%answer% &#32CD32| Reward: &#FFFFFF%reward%"
  
  # Multiple correct answers
  multiple-winners: "&#32CD32🎉 Winners: &#FFFFFF%players% &#32CD32| Answer: &#FFFFFF%answer%"

Game Management

games:
  # Game manually sent
  game-sent: "%prefix%&#32CD32Chat game sent successfully!"
  
  # No games available
  no-games-available: "%prefix%&#FF4500No chat games are currently available!"
  
  # Game cooldown
  game-cooldown: "%prefix%&#FFD700Please wait %time% seconds before sending another game!"
  
  # Game already active
  game-active: "%prefix%&#FFD700A chat game is already active! Wait for it to finish."
  
  # Invalid game configuration
  invalid-game: "%prefix%&#FF4500Error loading game: %error%"

Admin Messages

GUI Messages

gui:
  # GUI opened
  opened: "%prefix%&#32CD32Admin GUI opened successfully!"
  
  # GUI access denied
  no-access: "%prefix%&#FF4500You don't have permission to access the admin GUI!"
  
  # Setting updated
  setting-updated: "%prefix%&#32CD32Setting &#FFFFFF%setting%&#32CD32 updated to: &#FFFFFF%value%"
  
  # Setting update failed
  setting-failed: "%prefix%&#FF4500Failed to update setting &#FFFFFF%setting%&#FF4500: %error%"
  
  # Confirmation required
  confirm-action: "%prefix%&#FFD700Are you sure you want to %action%? Click again to confirm."

Administrative Actions

admin:
  # Player management
  player-muted: "%prefix%&#32CD32Player &#FFFFFF%player%&#32CD32 has been muted!"
  player-unmuted: "%prefix%&#32CD32Player &#FFFFFF%player%&#32CD32 has been unmuted!"
  
  # Chat management
  chat-locked-by: "%prefix%&#FF6B6BChat locked by &#FFFFFF%admin%&#FF6B6B!"
  chat-unlocked-by: "%prefix%&#32CD32Chat unlocked by &#FFFFFF%admin%&#32CD32!"
  chat-cleared-by: "%prefix%&#32CD32Chat cleared by &#FFFFFF%admin%&#32CD32!"
  
  # Configuration management
  config-backed-up: "%prefix%&#32CD32Configuration backed up successfully!"
  config-restored: "%prefix%&#32CD32Configuration restored from backup!"

Error Messages

System Errors

errors:
  # Plugin initialization errors
  initialization-failed: "%prefix%&#FF4500Failed to initialize PrimeChat: %error%"
  config-load-failed: "%prefix%&#FF4500Failed to load configuration: %error%"
  
  # Database errors
  database-connection-failed: "%prefix%&#FF4500Database connection failed: %error%"
  database-query-failed: "%prefix%&#FF4500Database query failed: %error%"
  
  # Integration errors
  placeholderapi-not-found: "%prefix%&#FFD700PlaceholderAPI not found. Some features may be limited."
  vault-not-found: "%prefix%&#FFD700Vault not found. Economy features disabled."
  
  # File system errors
  file-not-found: "%prefix%&#FF4500File not found: %file%"
  file-permission-denied: "%prefix%&#FF4500Permission denied accessing file: %file%"
  backup-failed: "%prefix%&#FF4500Failed to create backup: %error%"

User Errors

errors:
  # Command errors
  unknown-command: "%prefix%&#FF4500Unknown command: %command%"
  missing-arguments: "%prefix%&#FF4500Missing required arguments!"
  too-many-arguments: "%prefix%&#FF4500Too many arguments provided!"
  
  # Player errors
  player-offline: "%prefix%&#FF4500Player %player% is not online!"
  player-not-found: "%prefix%&#FF4500Player %player% was not found!"
  invalid-player: "%prefix%&#FF4500Invalid player name: %player%"
  
  # General errors
  internal-error: "%prefix%&#FF4500An internal error occurred. Please contact an administrator."
  feature-disabled: "%prefix%&#FF4500This feature is currently disabled!"

Placeholder Reference

Available Placeholders

# Placeholders available in messages
placeholders:
  # Player information
  "%player%": "Player's username"
  "%sender%": "Message sender's username"  
  "%receiver%": "Message receiver's username"
  
  # Message content
  "%message%": "The message content"
  "%answer%": "Correct answer for games"
  "%question%": "Game question"
  
  # System information
  "%time%": "Time remaining/elapsed"
  "%error%": "Error description"
  "%setting%": "Setting name"
  "%value%": "Setting value"
  
  # Administrative
  "%admin%": "Administrator username"
  "%command%": "Command name"
  "%usage%": "Command usage format"
  
  # Security
  "%word%": "Blocked word detected"
  "%content%": "Detected advertising content"
  "%domain%": "Domain name"
  
  # Games
  "%category%": "Game category"
  "%difficulty%": "Game difficulty level"
  "%reward%": "Game reward description"
  "%players%": "List of winning players"

Formatting Guidelines

Color Usage

# Recommended color usage
formatting:
  # Success messages - green tones
  success: "&#32CD32"  # Lime Green
  success-accent: "&#90EE90"  # Light Green
  
  # Error messages - red tones  
  error: "&#FF4500"  # Orange Red
  error-accent: "&#FF6B6B"  # Light Red
  
  # Warning messages - yellow tones
  warning: "&#FFD700"  # Gold
  warning-accent: "&#FFFF00"  # Yellow
  
  # Info messages - blue tones
  info: "&#87CEEB"  # Sky Blue
  info-accent: "&#ADD8E6"  # Light Blue
  
  # Text content - neutral tones
  text: "&#FFFFFF"  # White
  accent: "&#888888"  # Gray

Message Structure

# Standard message structure
structure:
  prefix: "%prefix%"
  color: "&#COLOR_CODE"
  content: "Message content"
  placeholder: "%placeholder%"
  
# Example
example: "%prefix%&#32CD32Player &#FFFFFF%player%&#32CD32 has been unbanned!"

Multi-Language Support

Language Configuration

# Language settings
language:
  # Default language
  default: "en"
  
  # Available languages
  available:
    - "en"  # English
    - "es"  # Spanish  
    - "fr"  # French
    - "de"  # German
    - "zh"  # Chinese
  
  # Auto-detect player language
  auto-detect: true
  
  # Fallback to default if translation missing
  use-fallback: true

Language Files

# Language file structure
# messages_en.yml (English)
# messages_es.yml (Spanish)
# messages_fr.yml (French)

# Each file contains the same structure with translated content

Message Customization Tips

Best Practices

  1. Consistency: Use consistent color schemes across messages

  2. Clarity: Keep messages clear and informative

  3. Branding: Include your server's branding colors

  4. Accessibility: Ensure colors are readable

  5. Context: Provide enough context for user actions

Testing Messages

# Test message formatting
test:
  # Command to test all message formats
  test-all: true
  
  # Show color codes in console
  debug-colors: false
  
  # Test with dummy data
  use-dummy-data: true
PreviousMain ConfigurationNextGUI Configuration

Last updated