Skip to content

Groups

You can group players by certain permission and have ChatControl treat them differently. Such as VIP players can type faster in the chat, etc.

Configuring Groups

Open settings.yml and see "Groups" section. You can place, edit or remove all subsections at your will. Each subsection is a group with its options, such as the "admin" group has no message delay below:

Group configuration example

You apply this group by giving players "chatcontrol.group.{groupName}" permission, in this case "chatcontrol.group.admin".

Group Options

ChatControl offers several group options to customize how different player groups interact with the chat system:

OptionDescriptionExample Value
Max_Read_ChannelsMaximum number of channels a player can read simultaneously3
Message_DelayTime delay required between chat messages for this group"2 seconds"
Message_SimilarityMinimum allowed difference between consecutive messages (prevents spam)"50%"
Command_DelayTime delay required between commands for this group"3 seconds"
Command_SimilarityMinimum allowed difference between consecutive commands"50%"
Sound_Notify_FormatColor for Sound Notify when tagging other players"&6" (gold)
Format_MotdName of the format that displays the message of the day when player joins"vip_motd"

Common Group Setups

Below are some example group configurations for different player types:

VIP Players Configuration

yaml
Groups:
  vip:
    Message_Delay: "1 second"
    Command_Delay: "1 second"
    Max_Read_Channels: 3
    Sound_Notify_Format: "&6"
    Format_Motd: "vip_motd"

Permission: chatcontrol.group.vip

Staff Configuration

yaml
Groups:
  staff:
    Message_Delay: "0 seconds"
    Command_Delay: "0 seconds"
    Max_Read_Channels: 5
    Sound_Notify_Format: "&c"
    Format_Motd: "staff_motd"

Permission: chatcontrol.group.staff

Best Practices

When configuring groups, consider these recommendations:

  1. Progressive Privileges: Create a hierarchy of groups with progressively better chat privileges
  2. Balance Restrictions: Set reasonable delay and similarity values based on your server's activity
  3. Test Thoroughly: Always test your configurations to ensure they're working as expected
  4. Documentation: Keep notes on which groups have which permissions for easier management