# !-----------------------------------------------------------------------------------------!
#                  Welcome to ChatControl's Chat Formatting Configuration
#
#   In this configuration you can setup how the message in the chat should look like.
#
#   Since we support different message formats per different permissions,
#   per channels, or many other places in the plugin, you can create a so-called
#   formats that can be reused multiple times.
#
#   For configuration, see:
#   - https://github.com/kangarko/ChatControl-Pro/wiki/Formats
#
#   For variables, see:
#   - https://github.com/kangarko/ChatControl-Pro/wiki/Variables
#
#   Remember, you can remove or edit all formats below, and create your own ones!
#
# !-----------------------------------------------------------------------------------------!

# -----------------------------------------------------------------------------------------
# Enable chat formatting?
# -----------------------------------------------------------------------------------------
Enabled: true

# -----------------------------------------------------------------------------------------
# Integration with other plugins
# -----------------------------------------------------------------------------------------
Integration:
  #
  # Requires DiscordSRV.
  #
  # Send your normal chat message to your DiscordSRV channel? If so, set the name of the
  # channel to which we shall send the message.
  #
  Discord_Channel: "creative"

# -----------------------------------------------------------------------------------------
# Configuration of the default chat types in the game.
# -----------------------------------------------------------------------------------------
Formatting:
  #
  # The default chat format applied over all worlds.
  #
  Default: Chat
  #
  # If range mode is enabled, used if the ranged message starts with and "!".
  # Such messages are send to everyone (if the sender has "chatcontrol.chat.globalrange" permission).
  #
  Global: Global_Chat
  #
  # A format used in the /me command.
  #
  Me: Me
  #
  # If range mode is enabled, used to send messages to players with "chatcontrol.chat.spy"
  # permission that they normally shouldn't see (because it's outside their range).
  #
  # To spy on private messages (e.g. /tell or /mail), use /spy feature.
  #
  Spy: Spy_Chat
  #
  # If party chat is enabled, you can then spy on the messages with "chatcontrol.chat.spy" permission.
  # Requires mcMMO.
  #
  Party_Spy: Spy_Party_Chat
  #
  # Used in admin chat via "/chc ach" command, used by staff to communicate with each other.
  #
  Admin: Admin_Chat
  #
  # Used in "/chc bungeechat" command which sends messages over bungee.
  #
  # Requires BungeeCord support.
  #
  Bungee: Bungee_Chat

# -----------------------------------------------------------------------------------------
# If TownyChat is installed, let it format your Towny channels while letting ChatControl
# format the normal chat.
# -----------------------------------------------------------------------------------------
Towny_Chat:
  #
  # Should formatting for listed channels be handled by Towny or ignored?
  # (Channels not listed will do the opposite)
  #
  Channel_Mode_Replace: true
  #
  # What channels should we format (or not format)?
  # The * channel is a placeholder for when a player is not speaking in a channel
  #
  Channels:
    - '*'
    - general

# -----------------------------------------------------------------------------------------
# You can optionally enable or disable the formatter depending on the world
# that the player speaking is in
# -----------------------------------------------------------------------------------------
World_Settings:
  #
  # Should the listed worlds be the only worlds where the formatter runs?
  # The default (false) treats the listed worlds as a list of where the formatter does not run.
  #
  Use_As_Whitelist: false
  #
  # List of worlds to disable (or enable) the formatter
  #
  Worlds:
    - World_to_disable_formatter_on

# -----------------------------------------------------------------------------------------
# Ranged mode limits the reach of player's message.
#
# For per-world chat, give everyone 'chatcontrol.chat.overrideranged' permission.
# -----------------------------------------------------------------------------------------
Range:
  #
  # Enable ranged mode?
  #
  Enabled: false
  #
  # Send a ranged message everywhere if it begins with the letter below and player has
  # the chatcontrol.chat.globalrange permission.
  #
  # Set to none to disable. Traditionally, this used to be "!"
  #
  Global_Shortcut: "none"
  #
  # How many blocks around the sender should the players see their message?
  #
  Distance: 100.0
  #
  # Worlds that shares the same chat.
  #
  # If the receiver is in a different world, we ignore the Distance above,
  # and he will see the message.
  #
  Linked_Worlds:
    normal:
      - world
      - world_nether
    skyland:
      - skyland
      - skyland_nether

# -----------------------------------------------------------------------------------------
# Here are the actual formats. A format represents how a message should look like.
# Each format consists of Parts (each part is configured individually).
#
# You can re-use them in different parts of the plugin, for example in chat channels.
#
# For tutorial, see https://github.com/kangarko/ChatControl-Pro/wiki/Formats
# -----------------------------------------------------------------------------------------
Formats:
  #
  # This is a very basic format named "Chat" used by default to format your main chat.
  #
  # You can name this whatever you want, however you will use
  # the name in other places of the plugin if you call 'Chat'.
  #
  Chat:
    # The first part (you can name all parts whatever you want)
    # that simply renders players prefix, and also contains
    # some fancy hover and click elements.
    First_Part:
      # The message that is shown in the chat.
      # In this case the variable ends with +, meaning we insert a
      # space " " automatically if prefix is not empty. Note only few variables
      # have this special feature, see our GitHub.
      Message: "&7{pl_prefix+}"
      # This part contains hover event which display an optional
      # message when you move your mouse over that chat part.
      #
      # Unlike the part name, you must name this "Hover_Event"
      Hover_Event:
        # What action should happen when you put your mouse on this part?
        Action: SHOW_TEXT
        # The messages that are shown to you in game.
        Values:
          - "&8*-----* &f{player} &8*-----*"
          - "&7Prefix&8: &7{pl_prefix}"
          - "&7Group&8: &b{pl_group}"

    # The second part simply displays the player's name.
    Second_Part:
      # The message that is shown in the chat.
      # If you want to show player's nick instead, use {nick}
      Message: "{player}&7: &f"
      # And show some fancy hover text, see above.
      Hover_Event:
        Action: SHOW_TEXT
        Values:
          - "&7Message issued: &b{timestamp}"
          - "&7Click to send a message"
      # This part also contains click event feature that will
      # write /msg <playername> into your chat when clicked.
      #
      # Unlike the part name, you must name this "Click_Event"
      Click_Event:
        # What action should happen when you click on this part?
        Action: SUGGEST_COMMAND
        # The message or value when action is fired.
        Value: '/msg {player} '

    # The third part that simply renders the actual chat message.
    Third_Part:
      # The message that is shown in the chat
      Message: "{message}"

  #
  # This example format is used in private messages for the sender.
  #
  Private_Message_Sender:
    Everything:
      Message: "&3✉ &bYou &3&l⇒ &b{player}&7: &f{message}"
      Hover_Event:
        Action: SHOW_TEXT
        Values:
          - "     &8~ &3Private Message &8~     "
          - "&8&oSent {timestamp}"
          - "&3Receiver: &f{receiver}"
          - "&3Body: &f{message}"
      Click_Event:
        Action: SUGGEST_COMMAND
        Value: "/tell {player} "
  #
  # This example format is used in private messages for the receiver.
  #
  Private_Message_Receiver:
    Everything:
      Message: "&3✉ &b{player} &3&l⇒ &bYou&7: &f{message}"
      Hover_Event:
        Action: SHOW_TEXT
        Values:
          - "     &8~ &3Private Message &8~     "
          - "&8&oReceived {timestamp}"
          - "&3Sender: &f{sender}"
          - ""
          - "&7Click for a reply."
      Click_Event:
        Action: SUGGEST_COMMAND
        Value: "/r "
  #
  # This example format is used in admin chat with "/chc ach".
  #
  Admin_Chat:
    Bracket_Start:
      Message: "&3[&b"
    Player:
      Message: "{pl_prefix}&7{player}{pl_suffix}"
    Bracket_End:
      Message: "&3]&b "
    Message:
      Message: "{message}"
  #
  # This example format is used in global bungee chat with "/chc g".
  #
  Bungee_Chat:
    Everything:
      Message: "&3C&8 ┃ {pl_prefix}&7{nick}{pl_suffix}{deluxetags_tag}&3 »&7 {message}"
  #
  # This example format is used when you send a message from Discord.
  # Only works if you have DiscordSRV plugin installed and configured properly.
  #
  Discord_Chat:
    Everything:
      Message: "&3Discord&8 ┃ {pl_prefix}&7{nick}{pl_suffix}{deluxetags_tag}&3 »&7 {message}"
  #
  # This example format is used in global chat when ranged mode is enabled.
  #
  Global_Chat:
    Everything:
      Message: "&3C&8 ┃ {pl_prefix}&7{nick}{pl_suffix}{deluxetags_tag}&3 »&7 {message}"
  #
  # This example format is used in spy chat for admins, when ranged mode is enabled.
  #
  Spy_Chat:
    Everything:
      Message: "&8SPY: [Creative&8]&f {pl_prefix}{player}{pl_suffix}&3 »&7 {message}"
  #
  # This example format is used in spy chat when party mode is enabled.
  #
  Spy_Party_Chat:
    Everything:
      Message: "&8SPY: [{party}&8]&f {pl_prefix}{player}{pl_suffix}: {message}"
  #
  # This example format is used in /me
  #
  Me:
    Vip:
      Message: "&6* "
      Condition: 'player.hasPermission("chatcontrol.groups.vip")' # Consider using Sender_Permission key instead for better performance
      Hover_Event:
        Action: SHOW_TEXT
        Values:
          - "&6This player is VIP"
          - "&6Check out &e/web &6to obtain VIP"
    Normal:
      Message: "&f* "
      Condition: '!player.hasPermission("chatcontrol.groups.vip")'
    Player:
      Message: "{player} "
      Click_Event:
        Action: SUGGEST_COMMAND
        Value: "/tell {player} "
    The_Rest:
      Message: "{message}"
  #
  # This example format is used for admins when an advertising message is caught.
  #
  Ad_Info:
    Info:
      Message: |-
        &6&m----------------------------------------------
        &r              &7&o(( Advertisement! ))

          &6x &ePlayer: &f{player}
          &6x &eMessage: &f{message}

    More_Info:
      Message: |-
        &r
          &8[&9x&8] Hover for more information."
        &6&m----------------------------------------------
      Hover_Event:
        Action: SHOW_TEXT
        Values:
          - "     &8~ &3Information &8~     "
          - "&3Time: &f{timestamp}"
      Click_Event:
        Action: SUGGEST_COMMAND
        Value: "/tempban {player} 10m Advertising is not allowed!"