# --------------------------------------------------------------------------
#           Welcome to the main configuration of ChatControl PRO
# --------------------------------------------------------------------------
#
# For support and updates, visit the official site:
# https://spigotmc.org/resources/10258
# --------------------------------------------------------------------------
#
# Following tips applies to all ChatControl's files, so they are not
# mentioned multiple times.
#
# 1) Color codes are supported with the '&' character, see
#    http://minecraftwiki.net/wiki/Formatting_codes for usage
#
# 2) To not display a message, set it to 'none'.
#
# 3) Unicode /special characters/ only work when files are saved in
#    UTF-8 encoding. Tested on Notepad++, WordPad on Windows is broken.
#
# 4) JSON is supported. To use it, prepend the message with '[JSON]'.
#    NB: Please use either quotes (a.), write the json on a new line (b.).
#        or send a tellraw command in rules. (c.) Examples:
#        a) Warn_Message: '[JSON] {"text": "Hello World"}'
#        b) Example_Message: |-
#           [JSON]
#           {"text": "Hover Me","hoverEvent": {"action": "show_text","value": {"text": "Hey there!"}}}
#        c) then console tellraw {"text": "Hello world!"}
#
# 5) For placeholder list, visit the variables/global.txt file.
#
# Most of the messages (warnings, etc) are found in the localization.
# To customize it, make a new file in "localization/messages_LOCALE.yml"
# (Replace LOCALE with the actuall locale name, by default 'en'). It will
# be filled with all default values and kept with sync on updates.
#
# --------------------------------------------------------------------------

# ----------------------------------------
# Reduce the impact of spamming bots
# ----------------------------------------
Anti_Bot:

  # Delay between player logging in again in seconds.
  Rejoin_Delay_Seconds: 4

  # Actions that are blocked until players moves from their join location.
  Block_Actions_Until_Moved:

    # To be able to chat (player still can execute commands)
    Chat: true

# ---------------------------------------
# Prevent writing messages IN BIG LETTERS
# ---------------------------------------
Anti_Caps:
  Enabled: true
  Enabled_In_Commands: false
  Warn_Player: true

  # Commands to be checked for caps. Only works if Enabled_In_Commands is true.
  # Purpose of whitelist is to prevent corrupting arguments in some commands.
  Commands_To_Apply:
    - /msg
    - /tell

  # [NOTICE] Only works if Points are enabled.
  # Controls how many points to give to player when they trigger anti-caps.
  # To disable, set "Amount" to 0
  Points:
    Warn_Set: spam

    # You can write a valid mathematical expression here. The result will be rounded to whole number (without decimals).
    Amount: 4 * (%capsPercentage / 2)

  # Ignore names of the players online?
  # [NOTICE] Can cause a little lag on large servers with 100+ players
  Ignore_Usernames: false

  Min_Message_Length: 5
  Min_Caps_Percentage: 50
  Min_Caps_In_A_Row: 5
  Whitelist:
  - OMG
  - LOL
  - WTF
  - WOW
  - ROFL

# ---------------------------------------------------------
# Prevent flooding the chat with junk / repetitive messages
# ---------------------------------------------------------
Anti_Spam:
  Similarity_Check:

    # [NOTICE] If you are running non-english server, please disable it.
    Ignore_Special_Characters: true

    Ignore_Duplicate_Characters: false

    # If enabled, first and second argument in commands will be ignored.
    # This makes the check less annoying in messages like "/tell <player> message"
    # wherein "/tell" and "<player>" would not be counted as repetitive.
    Ignore_First_Arguments_In_Commands: true

  Commands:

    # Delay in seconds between commands. Set to 0 to disable.
    Delay_Between_Commands: 0

    Delay_Points:
      Warn_Set: fastmessages

      # The %delay is the delay between the current and last command (in seconds)
      Amount: 0

    # Block repetitive commands if they are similar to the previous one, in percent.
    # Set to 0 or 100 to disable.
    Similar_Percentage_Block: 0

    Similarity_Points:
      Warn_Set: spam
      Amount: 4 * (%similarityPercentage / 2)

    # If enabled, *ONLY* the commands listed in white-list will be checked.
    Whitelist_Works_Like_Blacklist: false

    # Commands ignored from the similarity check, meaning player can run the same commands multiple times after each other.
    Whitelist_Similarity:
    - tell
    - pm
    - t
    - w
    - r
    - home

    # Commands ignored from the delay check, meaning player must not wait before executing the command.
    Whitelist_Delay:
    - spawn
    - hello

    # Following commands will be handled as chat completely, including
    # anti-spam, rules, writer, points, etc. (all like it would be a chat message)
    # Anti-caps, capitalizing and dot will also be applied.
    Handle_As_Chat:
    - me

  Chat:

    # Delay in seconds between messages. Set to 0 to disable.
    Delay_Between_Messages: 1

    Delay_Points:
      Warn_Set: fastmessages

      # The %delay is the delay between the current and last message (in seconds)
      Amount: 3 - %delay

    # Block repetitive messages if they are similar to the previous one, in percent.
    # Set to 0 or 100 to disable.
    Similar_Percentage_Block: 80

    # Instead of checking just last message, check multiple previous messages of the player, which will
    # increase the antispam effectiveness and preventing spam like this:
    # <player> t
    # <player> lol
    # <player> t
    # <player> lol
    Similarity_Message_Check_Count: 2

    Similarity_Points:
      Warn_Set: spam
      Amount: 4 * (%similarityPercentage / 2)

    # Enable regular expressions in "Whitelist_Similarity" and "Whitelist_Delay"?
    # [NOTICE] Can lead to unexpected behavior, it is advised not to use them.
    Regex_In_Whitelist: false

    # A message that starts with following will be ignored from the similarity check.
    Whitelist_Similarity:
    - hello
    - hey

    # A message that starts with following will be ignored from the delay check.
    Whitelist_Delay:
    - test

# --------------------------------------------------------
# Customize chat format and auto-correct player's grammar.
# [TIP] See variables.txt for variables (placeholders).
# --------------------------------------------------------
Chat:

  # [NOTICE] Vault required.
  Formatter:
    Enabled: false

    # Works *ONLY* on Spigot 1.7.10 or greater
    # Disable if any other chat formatter plugin (e.g. DeluxeChat) is installed
    # See chat.yml for configuration.
    Interactive:
      Enabled: false
      Format: Example_Format

      # You can create your own different format in chat.yml
      # Only works when writing to global chat and ranged mode is enabled, more info below.
      Global_Format: Example_Format

      # Used in "/chc ach" command which sends staff chat messages.
      # It is highly recommended to see the default chat.yml file because it contains preconfigured
      # format called 'Admin_Chat', which you won't receive since you already have the file chat.yml.
      Admin_Chat_Format: Example_Format

      # [NOTICE] You must have BungeeCords support enabled to use this.
      # Used in "/chc global" command which sends messages over bungee.
      # It is highly recommended to see the default chat.yml file because it contains preconfigured
      # format called 'Admin_Chat', which you won't receive since you already have the file chat.yml.
      Bungee_Chat_Format: Example_Format

    # The standard formatter, used if Interactive formatter is disabled.
    Static:

        # Default chat format.
        Message_Format: '%pl_prefix%player:%pl_suffix %message'

        # Global chat format. Only works if Ranged_Mode is enabled and messages starts with "!"
        # [NOTICE] Player must have the 'chatcontrol.chat.global' permission to be able to speak into the global chat.
        Global_Message_Format: '&8[GLOBAL]&f %pl_prefix%player:%pl_suffix %message'

        # If Ranged_Mode is enabled, this format is used when the player with 'chatcontrol.chat.spy' permission receives ranged message
        # that he normally should't see. Useful for admins.
        # [TIP] To spy on private messages (e.g. /tell or /mail), use Essentials /socialspy feature.
        Spy_Message_Format: '&8SPY: [%world&8]&f %pl_prefix%player:%pl_suffix %message'

        # Effective on "/chc ach" command
        Admin_Chat_Format: '&8[&2A-Chat %player&8]&2 %message'

        # Effective on "/chc global" command
        Bungee_Chat_Format: '&8[&fG&8] %player &7>&f %message'

    # If enabled, other player's message will only be sent to other players
    # within distance of the player specified in Range
    Ranged_Mode: false

    # [TIP] If you want the range for entire world, give everyone 'chatcontrol.chat.overrideranged' permission.
    Range: 100.0

  # [NOTICE] Numbers and URLs are automatically ignored.
  Grammar:

    # Punctualize every sentence (inserts dot at the end).
    Insert_Dot:
      Enabled: true
      Min_Message_Length: 5

    # Capitalize sentences (makes the first letter uppercase).
    Capitalize:
      Enabled: true
      Min_Message_Length: 5

# ----------------------------------------------------------------
# Remove all messages from chat with "/chatcontrol clear" command.
# ----------------------------------------------------------------
Clear:

  # Broadcast that the chat was cleared?
  Broadcast: true

  Do_Not_Clear_For_Staff: true

  # Amount of blank lines to be printed to the console.
  Console_Lines_To_Clear: 300

# -------------------------------------------------------
# Send messages to staff with "/chatcontrol ach" command.
# -------------------------------------------------------
Admin_Chat:
  Log_To_Console: true

  # Write to logs/admin-chat.txt ?
  Write_To_File: true

# -------------------------------------------------------------
# Send messages over Bungee with "/chatcontrol global" command.
# -------------------------------------------------------------
Bungee_Chat:
  Log_To_Console: true

  # Write to logs/bungee-chat.txt ?
  Write_To_File: true

# -----------------------------------------------------------
# Customize in-game messages or broadcast timed announcements.
# -----------------------------------------------------------
Messages:

  # Use 'default' to not modify, 'hide' to not display or write a custom message
  # Example: Join: '&6%player &7has joined the server!'
  # [TIP] See variables.txt for variables (placeholders).
  Join: default
  Quit: default
  Kick: default

  # [NOTICE] Requires AuthMe.
  # Should the quit message be only displayed when the player was logged in?
  # [TIP] To disable join message, enable 'delayJoinMessage' in AuthMe's configuration.
  Show_Quit_Only_When_Logged: true

  # Automatic message broadcaster.
  Timed:
    Enabled: false
    Random_Order: false

    # If random order is enabled, messages won't repeat themselves until every message has been broadcasted.
    Random_No_Repeat: true

    # Prefix and suffix supports variables %player (player name) and %world (world name)
    Prefix: '&8[&2Tip&8]&2'

    Suffix: ''
    Delay_Seconds: 180

    # [TIP] It is possible to display different messages in worlds.
    Message_List:

      # Messages displayed in all worlds.
      global:
      - Hey, %player, did you know that we are running ChatControl?
      - 'Check out &ahttps://spigotmc.org/resources/10258'

      # In this world will be displayed both global messages and these specified below.
      hardcore:
      - Grief is not permitted what-so-ever and every griefer will be banned.
      - Can you survive the night on %world world?

      # In this world will be displayed messages included from hardcore world.
      hardcore_nether:
      - includeFrom hardcore

      # No messages will be broadcasted in this world.
      ignored-world:
      - excludeGlobal

      # No global messages will be displayed here.
      creative:
      - excludeGlobal
      - Welcome on Creative world. Enjoy your gamemode :)
      - |-
        This is an example of multi-line.
        Use it if the new line character
        is not working for you

# ------------------------------------------------------------------
# Stop people from writing to chat with "/chatcontrol mute" command.
# ------------------------------------------------------------------
Mute:

  # Broadcast that the chat has been muted?
  Broadcast: true

  Prevent:
    Writing_Books: false
    Placing_Signs: true

  # Hide following messages when chat is muted
  Silence:
    Join_Messages: true
    Quit_Messages: true
    Kick_Messages: true
    Death_Messages: true

  Disabled_Commands_During_Mute:
  - me
  - tell
  - msg
  - r
  - w

# ------------------------------------------------------------------
# Announce important messages with "/chatcontrol announce" command.
# You can customize the format in localization.
# ------------------------------------------------------------------
Announcer:
  Log_To_Console: true

  # Do not broadcast to self?
  Ignore_Self: false

  # Usage: <bukkitSoundName>, <volume>, <pitch>
  Sound: SUCCESSFUL_HIT, 1.0, 0.1

# -----------------------------------------------------------
# Features that will only work when ProtocolLib is installed.
# -----------------------------------------------------------
Packets:

  # Enable all features that requires ProtocolLib
  # e.g. packet rules, tab complete
  Enabled: true

  # Prevent using TAB to complete a message. Can prevent revealing sensitive server information.
  Tab_Complete:
    Disable: false

    # Allow TAB completing in messages?
    Disable_Only_In_Commands: false

    # Allow if the message/command contains space (' ') ?
    Allow_When_Message_Has_Space: true

    # Allow when the message length is above specific number.
    # Not recommended as it might still reveal your server setup.
    Allow_When_Length_Above: 1

# -----------------------------------------------------------
# Custom user-defined rules that will catch certain messages.
# [TIP] See "rules/" folder for configuration.
# -----------------------------------------------------------
Rules:

  # Enabled in chat?
  Check_Chat: true

  # Enabled on commands?
  Check_Commands: true

  # Enabled on signs?
  Signs:
    Check: true

    # Check the sign text from top to bottom and from bottom to top.
    Both_Directions: true

  # Enabled on books?
  Books:
    Check: true

    # If rule has changed the title, should we replace it? If false, denies creation.
    Replace_Title: true

    # If rule has changed pages, should we replace them? If false, denies creation.
    Replace_Pages: true

  # Enabled on items?
  Items:
    Check_Anvil: true

    # If rule has changed the name, should we replace it? If false, denies creation.
    Replace_Name: true

  # [NOTICE] ProtocolLib required.
  # Check messages against rules/packets.txt ? Also catches messages from bukkit or other plugins.
  Packets:
    Check: true

    # Since Minecraft 1.7x, every message is a chat component. Unpacking it will bring better/more expected results.
    # Disable if experiencing issues with chat formatting plugins. Messages with hover/click effects won't be checked.
    Deserialize_Json: true

  # Players are able to choose which messages (caught be a rule) they want/do not want to see.
  # Example: Can be used for example to allow players decide if they will see swear words.
  Chat_Ignorer:
    Enabled: false

    # You have to create a set here in order to be able to ignore it. Create as many sets as you want.
    # It is possible to limit which sets can be toggled by whom, by giving 'chatcontrol.ignoreset.<setName>' permission.
    Sets:

      # Only players with permission 'chatcontrol.ignoreset.swear' will be able to toggle this set for themselves.
      swear:

      exampleSet:

        # Do not ignore by default. Player have to use "/chc ignore anotherSet" to make it effective for him.
        Ignored_By_Default: false

      # You do not need to specify any parameters
      anotherSet:


# ------------------------------------------
# Remove unwanted messages from the console.
# ------------------------------------------
Console:
  Filter:
    Enabled: true

    # Remove certain messages from console.
    # Does not need to be whole message, just a part of the message you want to block.
    Filter_Console_Messages:
    - Reached end of stream for
    - Connection reset
    # The following is commented out as they cause issues with Multicraft.
    #- UUID of player
    #- lost connection

# -----------------------------------
# Various settings that affect signs.
# -----------------------------------
Signs:
  Duplication:

    # Player will be unable to place two signs with same text.
    Deny_Signs_With_Same_Text: false
    Alert_Staff: true

    # Block sign creation when rule matches its text.
    Block_When_Violates_A_Rule: true
    Drop_Sign: true

# -------------------------------------------------
# Play a sound to a player that has been mentioned.
# -------------------------------------------------
Sound_Notify:
  Enabled: true

  # [NOTICE] Requires Essentials.
  Notify_Only_When_Afk: true

  # Play a sound only when someone writes following character before player's name.
  # Example: "Hello @kangarko, are you there?"
  # Set to "none" to play a sound always when player's name is mentioned.
  Notify_Only_If_Prefixed_With: '@'

  # Format: bukkit_sound_name, volume (float), pitch (float)
  Sound: CHICKEN_EGG_POP, 1F, 1.5F
  Enabled_In_Commands:
  - msg
  - tell
  - t
  - w
  - r

# -----------------------------------------------------------
# Set different settings for people with certain permissions.
# -----------------------------------------------------------
Groups:
  Enabled: false

  # If you add a player/group permission (e.g via PermissionsEx: /pex user <nick> add <perm>)
  # then you will not need to reload ChatControl with "/chc reload" to apply the effects.
  # [NOTICE] Can have performance impact.
  Always_Check_Updates: false

  Group_List:

    # Example usage. Give the player 'chatcontrol.group.trusted' to make it working.
    # As you can see, if you do not specify the value, the default will be used.
    trusted:
      Message_Delay: 0

    guest:
      Message_Delay: 4
      Command_Delay: 6

    vip:

      # [NOTICE] If you are an OP, you need to negate those permissions
      # otherwise it will be applied on you, too!
      Join_Message: "&6[VIP] &e%player has joined the game"
      Leave_Message: "&6[VIP] &e%player has left the game"
      Kick_Message: none

    #admin:
    #  Interactive_Format: Admin_Chat_Format
    #  Interactive_Global_Format: Admin_Global_format

# ------------------------------------------------------
# Give player warning points for violatin rules/actions.
# ------------------------------------------------------
Points:
  Enabled: false

  # Shall the last action be repeated until the reset task gets scheduled?
  Repeat_Last_Action: true

  # Should player only get ONE warning (the one from warning set) and not both from rules and warning sets.
  Smart_Warnings: true

  # Once upon a time, players' points are subtracted.
  Reset_Task:

    # Specify the delay between taking points in seconds.
    # Set 0 to disable (player will only lose points when plugin or server is reloaded)
    # [TIP] If this is disabled, enable Repeat_Last_Action
    Repeat_Every_Seconds: 20

    # How much points to take from different sets
    # If you do not specify, no points will be taken
    Remove_Points_Amount:
      global: 5
      spam: 1

  # To punish player in different ways for doing specific thing, you can create multiple warning sets.
  Warn_Sets:

    # [NOTICE] This is a special set. Unless removed, all points will go there if you do not specify the set name.
    # example: you don't need to write "then points global 5", but just "then points 5" (in rules)
    global:

      # Specify the commands to execute if player reaches specific amount of points. Can be multiple commands.
      # Use operator "warn" to send message directly to the player.
      5:
        - "warn &7Please obey the &2rules &7otherwise you will be &4punished&7."
      15:
        - "warn &c**** &lHey &c%player ****\n &7-> &cThis is your &6final &cwarning!"
        #- "mute %player 5m Do not observing warnings" # Only works if you have a mute plugin
      30:
        - "kick %player &cKicked for breaking the rules"

    swear:
      4:
        - "warn &cYou have received first warning for swearing."
      6:
        - "warn &cPlease do not swear, otherwise an action will be taken!"
      8:
        - "kick %player &cInappropriate language (last warning)"
      20:
        - "tempban %player 30m autoban for swearing" # This requires compatible third party plugin installed

    spam:
      6:
        - "warn &cPlease do not act like spammer."
      10:
        - "warn &cPlease do not spam, otherwise you will be banned."
      12:
        - "kick %player &cSpamming the chat (last warning)"
      26:
        - "tempban %player 10m autoban for chat spam" # This requires compatible third party plugin installed

    fastmessages:
      6:
        - "warn &cPlease slow down chat messages."
      10:
        - "warn &cSlow down chat, otherwise you will be banned."
      14:
        - "kick %player &cSlow down chat (last warning)"
      30:
        - "tempban %player 10m autoban for chat spam" # This requires compatible third party plugin installed

# -----------------------------------------------------------------------------------------------
# Create own placeholders (like %ping) to get properties from any plugin (and even server).
# [NOTICE] Requires Java 8 or greater!
# [TIP] See global/variables.txt file for more information.
# -----------------------------------------------------------------------------------------------
Variables:
  Enabled: false

  # Where should the placeholders be applied?
  Apply_On:
    Chat_Formatter: true

    # Join, Kick and Quit messages
    Player_Messages: true

    # Rules for chat, commands, signs, books etc.
    Rules: true

# ----------------------------------------------------------------------------
# Save chat communication to see what happened in chat while you were offline.
# ----------------------------------------------------------------------------
Writer:

  Write_Chat_Communication: true

  # Do not save messages from following players.
  Ignore_Players:
  - ignoredAdmin

  # Commands that will be saved with chat messages.
  Write_Commands:
  - me
  - msg
  - m
  - tell
  - t
  - reply
  - r
  - mail

# -------------------------------------------------------------------------------------------
# Integration with BungeeCords (https://spigotmc.org/threads/392)
# You need BungeeControlBridge on your bungee network. (https://spigotmc.org/resources/13079)
# -------------------------------------------------------------------------------------------
BungeeCords:
  Enabled: false

  Enabled_In:
    Rule_Alerts: true
    Handler_Alerts: true
    Admin_Chat: true

  # The prefix used in front of all messages coming from other servers.
  Prefix: "&5[Bungee/%servername] &7"

# ----------------------------------------------------
# Get to know if a new version of plugin is available.
# ----------------------------------------------------
Updater:
  Enabled: true
  Notify: true
  Download: true

# ----------------------------------------------------------------------------------------
# Advanced users only: There is absolutely no need to change unless you
# a) Know what you are doing (http://wiki.bukkit.org/Event_API_Reference#Event_Priorities)
# b) Was advised to change it by the developer
# ----------------------------------------------------------------------------------------
Listener_Priority:
  Formatter: NORMAL
  Checker: NORMAL

# ---------------------------------------------------------------------------------------
# Tells detailed info in the console about various events/configurations.
# [TIP] Don't be afraid to turn this on, it will help you understand how the plugin sees
# what you have set up and thus enabling you to solve issues by yourself.
# ---------------------------------------------------------------------------------------
Debugger:

  # Global debug displays various messages across different sections of the plugin.
  Global: false

  # Log to the console? Global debug will always be logged no matter this setting.
  Log_To_Console: true

  # Write to log/debug.txt ?
  Save_To_File: true

  # What sections in this file to debug? Have to be exact name of a configuration section. Example:
  # Enabled_In:
  #   - Points
  #   - Updater
  # Current supported sections:
  # - Points
  Enabled_In: []

# Only check commands and chat when there is more than specified amount of players.
Minimum_Players_To_Enable_Checks: 0
Op_Has_Permissions: true

# If you have non-english server, this will make checks (rules and anti-spam) more effective.
# Example: Characters with accents will internally be handled as without.
Translate_Diacritical_Marks: true

# Prevent malformed regular expressions to crash / freeze the server when they take more time then specified (in milliseconds).
Regex_Timeout_Milis: 100

# Read the header of this file for tutorial on customizing localizations.
# Currently available: en (english), de (german), sk (slovak), cz (czech), es (spanish), fr (french), nl (dutch) cn (chinese)
Locale: en

# Time of some plugin's operations is measured.
# Print a message in the console if they take more then specified amount of time in milliseconds.
# Set 0 to disable.
Log_Lag_Over_Milis: 100

# If rules catches a message, print information to the console.
# It is possible to hide individual packet rules from appearing
# with "dont verbose" operator.
Verbose_Rules: true

# Removes certain messages of ChatControl from startup (reduce spam in the console)
# If you are having any issues, disable this and enable Verbose and Debug.
Silent_Startup: true

# Remove all colors from the checked message to increase regex effectiveness.
# Disabling might/will break some filters, while enabling you to get the caught message with its colors
Regex_Strip_Colors: true

# Plugin saves some player data, such as their last message or command + date of writing them, for antispam to use.
# You can decide if these data should be reset when the player quits. Recommended in lobby (when on bungee), but not elsewhere.
Reset_Cache_On_Quit: false

# The server name used in %servername variable. If set to 'default', the 'server-name' property from server.properties is used instead.
# Used for example in functions related to BungeeCords, but not necessarily. Colors are supported.
Server_Name: default

# Do not change this value, otherwise it will corrupt your plugin installation!
Version: 12