Configuration (config.yml)

Messages

Chatting

• enabled: true/false - Whether chat messages will be annouced globally on the proxy
• format: "%prefix% <b>%player%:</b> %message%" - How the chat messages will look (Placeholders supported)
• allow-mini-message: true/false - Whether players will be able to use mini message tags in their messages.
• muted-message: "<red>You are muted! You cannot send messages." - The message to send when a muted player tries to send a message (Placeholders supported, Mute Plugins integration)

Joining

• enabled: true/false - Whether join messages will be annouced globally on the proxy
• format: "<dark_gray>(<green>+<dark_gray>) <gray>%player%" - How the join messages will look (Placeholders supported)

Leaving

• enabled: true/false - Whether leave messages will be annouced globally on the proxy
• format: "<dark_gray>(<red>-<dark_gray>) <gray>%player%" - How the leave messages will look (Placeholders supported)

Switching servers

• enabled: true/false - Whether server switch messages will be annouced globally on the proxy
• format: "<dark_gray>(<gold>•<dark_gray>) <gray>%player% <dark_gray>(<gold>%old_server%→%new_server%<dark_gray>)" - How the server switch messages will look (Placeholders supported)

Commands

Broadcast (/broadcast, /bcast, /bc)

• The broadcast command broadcasts a custom message on the network.
• enabled: true/false - Whether the broadcast command will be registered or not
• format: "<bold><#00ffff>Server:<reset> %message%" # Default: "<bold><#00ffff>Server:<reset> %message%" - How the broadcast messages will look

Message & Reply Commands (/message, /msg, /tell, /whisper, /w + /reply, /r)

• The message command allows players to communicate privately on the network.
• The reply command allows players to quickly reply to their last received message
• enabled: true/false - Whether the message command will be registered or not
• format.sender: "<b>(<#00ffff>You </#00ffff>→ <#00ffff>%receiver%</#00ffff>): </b>%message%" - How the private message will look for the person sending it
• format.receiver: "<b>(<#00ffff>%sender% </#00ffff>→ <#00ffff>You</#00ffff>): </b>%message%" - How the private message will look for the person receiving it
• enable-reply-command: true/false - Whether the reply command will be registered
• allow-mini-message: true/false - Whether players will be able to use mini message tags in their private messages.

Custom LuckPerms meta

• You may use this to add additional luckperms meta values
• You can then use them in placeholder format like this: &custom_name& [AMPERSAND not PERCENT]

luck-perms-meta
  custom_name: "meta_key" # Use: &custom_name&
  custom_name2: "meta_key2" # Use: &custom_name2&

• You can edit the placeholder names freely.

Server Aliases

• You may use this to make server names present more elegantly

server-aliases
  lobby1: "Lobby" # lobby1 will show up as just Lobby
  lobby2: "Lobby" # lobby2 will show up as just Lobby

Backup Config

• This option is here for users upgrading from pre-1.8 vMessage versions to ensure their config won't get corrupted.

config.yml

messages:
  chat:
    enabled: true
    
    # %player% - Player
    # %message% - Message
    # %server% - Player's Current Server
    # %prefix% - LuckPerms Prefix
    # %suffix% - LuckPerms Suffix
    format: <b>%player%:</b> <gray>%message%</gray>
    
    # The message to send when a muted player tries to send a message
    # %player% - Player
    # %message% - Message
    # %server% - Player's Current Server
    # %prefix% - LuckPerms Prefix
    # %suffix% - LuckPerms Suffix
    # %reason% - Reason for muting
    # %end-date% - End date of the mute
    # %moderator% - Moderator who muted the player
    muted-message: <red>You are muted! You cannot send messages.
    
    # Whether to allow players to use MiniMessage in their messages
    allow-mini-message: false
  join:
    enabled: true
    
    # %player% - Player
    # %server% - Player's Current Server
    # %prefix% - LuckPerms Prefix
    # %suffix% - LuckPerms Suffix
    format: <dark_gray>(<green>+<dark_gray>) <gray>%player%
  leave:
    enabled: true
    
    # %player% - Player
    # %server% - Player's Last Server
    # %prefix% - LuckPerms Prefix
    # %suffix% - LuckPerms Suffix
    format: <dark_gray>(<red>-<dark_gray>) <gray>%player%
  change:
    enabled: true
    
    # %player% - Player
    # %old_server% - Player's Previous Server
    # %new_server% - Player's New Server
    # %prefix% - LuckPerms Prefix
    # %suffix% - LuckPerms Suffix
    format: <dark_gray>(<gold>•<dark_gray>) <gray>%player% <dark_gray>(<gold>%old_server%→%new_server%<dark_gray>)
commands:
  # /broadcast, /bcast, /bc
  broadcast:
    enabled: true
    
    # %message% - Message
    format: <bold><#00ffff>Server:<reset> %message%!!!
  
  # /message, /msg, /whisper, /w
  message:
    enabled: true
    
    # %sender% - Sender
    # %receiver% - Receiver
    # %message% - Message
    # %sender-server% - Sender's Current Server
    # %receiver-server% - Receiver's Current Server
    # %sender-prefix% - Sender's LuckPerms Prefix
    # %sender-suffix% - Sender's LuckPerms Suffix
    # %receiver-prefix% - Receiver's LuckPerms Prefix
    # %receiver-suffix% - Receiver's LuckPerms Suffix
    # Custom meta placeholders are currently not supported for this option
    format:
      sender: '<b>(<#00ffff>You </#00ffff>→ <#00ffff>%receiver%</#00ffff>): </b>%message%??'
      receiver: '<b>(<#00ffff>%sender% </#00ffff>→ <#00ffff>You</#00ffff>): </b>%message%??'
    allow-minimessage: false
    
    # Whether to enable the /reply command
    # It will reply to the last person who sent you a message
    enable-reply-command: true
    
    # Whether to allow players to use MiniMessage in their private messages
    allow-mini-message: false

# If you want to use additional LuckPerms meta values you can add them here
# You can then use them in placeholder format like this: &custom_name& [AMPERSAND not PERCENT]
luck-perms-meta: 
  custom-name1: meta_key1 
  custom-name2: meta_key2

# If you want to display a different name for a server you can add it here
# It will then be used in the messages above instead of the server's actual name
server-aliases:
  lobby: Lobby
  lobby1: Lobby
  lobby2: Lobby

# This option is here for safety when updating the plugin from an older version
# WARNING: This will overwrite the previous backup (config.yml.bak)
backup-config: false