Configuration

View the Configuration Files for Chat.

#
#    ___ ___ _____   __   ___ _         _
#   / __|_ _| __\ \ / /  / __| |_  __ _| |_
#  | (__ | || _| \ V /  | (__| ' \/ _` |  _|
#   \___|___|_|   |_|    \___|_||_\__,_|\__|
#
# CIFYChat - v1.0
# Developed by https://codeitforyou.com/
#

# Here you can configure the primary functions of the plugin.
settings:
  # This is the formatting used for the %timestamp% placeholder.
  timestamp_format: "dd/MM/yy HH:mm:ss"

  # This is a toggle as to whether the plugin should function
  # across the BungeeCord network or not.
  bungee: false

# This area is merely for the private messaging system (/msg).
messaging:

  # You can toggle this on and off.
  enabled: true

  # This setting defines whether players may use this across the network.
  # This is overridden by the bungeecord toggle within the settings.
  bungee: false

  # These are the 2 formats for the private messaging.
  to_sender:
    # These are the sections for this PM format, sections can be
    # added and removed as desired - there's no limit!
    sections:
      sender:
        # This is the display of this desired section.
        display: "&8[&aYou"

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Hi! It's me."
      divider:
        # This is the display of this desired section.
        display: " &8-> "

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip: []
      target:
        # This is the display of this desired section.
        display: "&b%target%&8]"

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Hi %target%!"
      suffix:
        # This is the display of this desired section.
        display: "&8: "

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip: []
      message:
        # This is the display of this desired section.
        display: "&7%message%"

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: "[RUN] /me Hi!"

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Timestamp: %timestamp%"
  from_sender:
    sections:
      sender:
        # This is the display of this desired section.
        display: "&8[&a%target%"

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Hi! It's %target%."
      divider:
        # This is the display of this desired section.
        display: " &8-> "

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip: []
      target:
        # This is the display of this desired section.
        display: "&bYou&8]"

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Hi! It's me."
      suffix:
        # This is the display of this desired section.
        display: "&8: "
        click_command: ""
        tooltip: []
      message:
        # This is the display of this desired section.
        display: "&7%message%"

        # This is the click command for the section, you may use:
        # = [RUN] <COMMAND> - Run this desired command.
        # = [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # = [URL] <WEBSITE> - Open this website URL for the player.
        click_command: "[RUN] /me Hi!"

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Timestamp: %timestamp%"

# You may configure these channels for private messaging.
channels:

  # This is the default channel, you cannot rename this!
  # Players will automatically have permission to this channel.
  default:
    # This is the channels prefix, available with %channel_prefix% in the plugin.
    prefix: "&8[&a&lG&8]"

  # This is an example channel, available with the cifychat.channels.staff permission.
  staff:
    # This is the channels prefix, available with %channel_prefix% in the plugin.
    prefix: "&8[&c&lS&8]"

    # This is the channels shortcut, used at the start of a message to quickly
    # send a message into the desired channel without needing to /channel <ID>.
    shortcut: "!"

    # This setting allows for making this channel available throughout the
    # BungeeCord Network. Any players on other servers will still need the permission
    # in order to see it.
    global: true

# You may configure these formats for chatting.
formats:
  # These are the chat formats available, players can be given access
  # to a format using the permission node: cifychat.format.<ID>.
  #
  # You CANNOT delete the default format, and is automatically given
  # to players if they have no other format.
  default:
    # This is the priority for the desired format, the highest one
    # takes priority first.
    priority: 1
    # These are the sections for this chat format, sections can be
    # added and removed as desired - there's no limit!
    sections:
      channel:
        # This is the display of this desired section.
        display: "%channel_prefix% "

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: "[URL] https://google.com/"

        # These are a set of 'actions' which run upon clicked, you may use:
        # = [CONSOLE] <COMMAND> - Run this command from console.
        # = [PLAYER] <COMMAND> -  Run this command from the player.
        # = [BROADCAST] <MESSAGE> - Send a message to the entire server.
        # = [MESSAGE] <MESSAGE> - Send a message to the player who clicked.
        # = [CHAT] <MESSAGE> - Force the player to send a chat message.
        click_actions:
          - '[CONSOLE] tm msg %player% &7CIFYChat!\n&aThis is a CIFYChat Channel'
          - "[MESSAGE] &7This is a channel!"
          - "[BROADCAST] &f%player% &7clicked a chat channel :o"

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Channel: &b%channel_id%"
          - "&7&oClick to switch channel!"
      prefix:
        # This is the display of this desired section.
        display: "&f%vault_prefix%"

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7This is my rank!"
      name:
        # This is the display of this desired section.
        display: "&f%player%"

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: "[SUGGEST] /msg %player% "
        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Hi! It's me."
      suffix:
        # This is the display of this desired section.
        display: "&8: "

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip: []
      message:
        # This is the display of this desired section.
        display: "&7%message%"

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: "[RUN] /me Hi!"

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Timestamp: %timestamp%"
  staff:
    priority: 10
    sections:
      channel:
        # This is the display of this desired section.
        display: "%channel_prefix% "

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: "[URL] https://google.com/"

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7This is a channel."
      name:
        display: "&c%player%"

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Hi! I'm a Staff Member."
      suffix:
        # This is the display of this desired section.
        display: "&8: "

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip: []
      message:
        # This is the display of this desired section.
        display: "&7%message%"

        # This is the click command for the section, you may use:
        # [RUN] <COMMAND> - Run this desired command.
        # [SUGGEST] <COMMAND> - Suggest this desired command to the player.
        # [URL] <WEBSITE> - Open this website URL for the player.
        click_command: ""

        # This is the message shown upon hover for the desired section.
        tooltip:
          - "&7Timestamp: %message_timestamp%"

Adding Custom Sections

Unlike competitors, you're not tied down to the traditional prefix, name and suffix options - instead you may add as many as you desire! Simply create a new section above or beneath with your chosen placeholders and that's it.

Sections will automatically disappear if the placeholder is blank, useful for showing a tooltip for a selected tag, and not showing it when not present.