ClearChat Documentation: Configuration and Usage Guide


This guide details all settings and commands for the ClearChat plugin.



1. Configuration Guide (config.yml)


This file controls all moderation settings, formats, and messages. All colors use standard Minecraft formatting (the & character).



ANTI-SPAM SETTINGS

• anti-spam.chat-cooldown: Sets the minimum time (in seconds) a player must wait between messages (e.g., 2.5).
  
  
• anti-spam.block-repetition: If set to true, blocks players from sending the same message twice in a row.
  

SWEAR FILTER SETTINGS

• swear-filter.enabled: Toggles the swear filtering system on or off.
  
  
• swear-filter.replacement-char: The character used to mask blocked words (e.g., *).
  
  
• swear-filter.blocked-words: A list of words that will be censored.
  

FORMATS

• formats.global: The format used for standard global chat messages. Use %player% and %message% placeholders.
  
  
• formats.private-send: Format for the sender of a private message. Use %target%.
  
  
• formats.private-receive: Format for the recipient of a private message. Use %sender%.
  
  
• formats.pm-spy-format: Format for private messages seen by staff using /cc spy.
  

MESSAGES

• messages.prefix: The prefix used before most plugin messages (e.g., &7[&6Chat&7] ).
  

2. Command Reference


This is a list of all commands and their purpose.

• /clearchat OR /cc: Main administration command.
  
  • /cc all: Clears the chat history for all players on the server.
    
    
  • /cc player <name>: Clears the chat history for the specified player only.
    
    
  • /cc me: Clears the command sender's own chat (Admin shortcut).
    
    
  • /cc mute: Toggles the global chat mute on/off.
    
    
  • /cc spy: Toggles PM Spy mode for the sender.
    
    
  • /cc broadcast <message>: Sends a formatted, server-wide broadcast.
    
    
  • /cc reload: Reloads the config.yml file.
    
• /msg OR /tell OR /w: Used to send a private message to another player. Usage: /msg <player> <message>
  
  
• /reply OR /r: Used to quickly reply to the last person who messaged you. Usage: /reply <message>
  

3. Permissions Reference


Permissions are managed via a plugin like LuckPerms. These are the nodes required to use or bypass features.

• clearchat.admin: Grants access to all /cc commands and bypasses most restrictions. (Default: op)
  
  
• clearchat.spy: Allows staff to use /cc spy and view private messages. (Default: op)
  
  
• clearchat.color: Allows a player to use color codes (&) in chat and messages. (Default: false)
  
  
• clearchat.swear.bypass: Bypasses the word censor/swear filter. (Default: op)
  
  
• clearchat.spam.bypass: Bypasses the anti-spam cooldowns and repetition checks. (Default: op)
  
  
• clearchat.clear.all: Allows use of /cc all. (Default: op)
  
  
• clearchat.clear.player: Allows clearing another player's chat. (Default: op)
  
  
• clearchat.clear.me: Allows clearing your own chat using /cc me. (Default: true)
  
  
• clearchat.broadcast: Allows sending server broadcasts. (Default: op)
  
  
• clearchat.mute: Allows toggling the global chat mute. (Default: op)