Configuration

config.yml

Version: 10.1
Settings:
  Modules:

The header. Any functionality of BungeeChat is grouped into modules, which can generally be enabled or disabled Please do not change anything on the Version: label unless you are having a deeper understanding. Please keep in mind all defined command aliases in this config.yml might block local MC command calls on the local server nodes with the same command call.

Alert

  Alert:
      enabled: true
      aliases:
        - broadcast
        - bc
        - balert
        - bbc

added in version: before 2.0

An alert is a message broadcasted to any connected node, almost same function as bungee vanilla style alerting. Aliases for executing the command can be defined.

AntiAdvertising

    AntiAdvertising:
      enabled: true
      whitelisted:
        - www.google.com

added in version: before 2.0

Any type of chat will be checked for certain patterns and filtered out if tested positive against advertisement.
Exceptions can be defined with the option Whitelisted.

- message types applied to filtering
- wildcardstring (*/?/R=foo(bar|baz))

AntiDuplication

    AntiDuplication:
      enabled: true
      checkPastMessages: 5

added in version: before 2.0

Any type of chatmessage will checked for a repetition within a defined amount of last messages by the same user defined by checkPastMessages .

- message types applied to dupechecking

AntiSwear

    AntiSwear:
      enabled: true
      freeMatching: false
      leetSpeak: false
      ignoreSpaces: false
      ignoreDuplicateLetters: false
      words:
        - fuck
        - kut
        - tyfus
      replacement: "****"

added in version: before 2.0

Any type of chat will be checked for excluded words and filtered out if tested positive against the excluded-words- list defined by the option words:
The procedures freeMatching leetSpeak ignoreSpaces ignoreDuplicateLetters can be enabled to detect those unwanted words sligthly changed.
More details about text patterns research can be found here

- link for antiswear filter features ?

AutoBroadcast

    AutoBroadcast:
      enabled: false
      random: false
      interval: 20
      messages:
       - "Message 1"
       - "Message 2\nwith newline!"
       - "&6Message 3 &lwith &4colors &band &r&0Formats &mtoo!"

added in version: 2.1.0 (config version 10.0)
This modules broadcasts chat messages defined under messages:automatically in a frequency defined by interval: in seconds.
The order of the broadcasted messages can be defined for successive or random rotation with random:

- wie alert

ChatLock

    ChatLock:
      enabled: true
      emptyLinesOnClear: 20
      aliases:
        - lockchat

added in version: before 2.0

the entire public chat (Local,Global,Staff) can be locked out by executing the chatlock command. emtyLinesonCLear: defines the number of lines which will be written to clean up the chat window.

ChatLogging

    ChatLogging:
      enabled: true
      privateMessages: true
      console: true
      file: true
      logFile: "logs/%year%-%month%-%day%-chat.log"
      filteredCommands:
        - login
        - help
        - pagination

updated in version: 2.1.4 (config version 10.1)

This features logs any chat input generated by users. Output to bungeecord console can be enabled by using console: true and/or into a logfile defined by file: true and logFile:. If private message logging is not needed it can be switched off with privateMessages: false. filtercommands: defines a set of commands which are not logged into the logile, mostly for security or ressource reasons.

ClearChat

    ClearChat:
      enabled: true
      emptyLines: 20
      aliases:
        - cc
        - chatclear

added in version: 2.0.5 (config version x.x)

Staff can clear public chats for an amount of lines defined with empyLines:. The used command alias can be defined with aliases:

GlobalChat

    GlobalChat:
      enabled: true
      passToClientServer: false
      aliases:
        - g
      default: false
      symbol:
        enabled: false
        symbol: "!"
      serverList:
        enabled: false
        list:
          - Hub1
          - Hub2
          - Hub3

added in version: before 2.0

Needed Permission | Description

Global chat delivers messages to the entire bungee network (if serverList: \enabled: false) or to a set of defined servers (if serverList: \enabled: true). The set of servers can be defined with serverList: \list:. passToClientServer: defines if the global chat messages are delivered to the local server nodes, default: defines if GlobalChat is the default type of messaging (instead of localchat). symbol: \enabled: true can be used for activating a shortcut command to use GlobalChat instead of any currently activated Chattype defined by symbol.

HelpOp

    HelpOp:
      enabled: true
      aliases:
        - ahelp
        - helpme

added in version: before 2.0

Players can ask for help by the staff. Messages initiated by that command are marked and will only be received from players having the certain permission. Command can be modified by aliases:.

Ignoring

    Ignoring:
      enabled: true
      aliases: []

added in version: before 2.0

Ignores a certain player's private messages. Command can be modified by aliases:.

JoinMessage

    JoinMessage:
      enabled: true

added in version: before 2.0

Players will be announced on Join if having the needed permission.

LeaveMessage

    LeaveMessage:
      enabled: true

added in version: before 2.0

Players will be bid farewell on leave if having the needed permission

LocalChat

    LocalChat:
      enabled: true
      passToClientServer: false

added in version: before 2.0

Chat messages will be delivered only to players connected to the same servers as the message sender. This is the default message type. If passToClientServer: true is set, the message will be delivered to the local server for further processing.

Messenger

    Messenger:
      enabled: true
      filterMessages: false
      aliases:
        message:
          - msg
          - tell
          - m
          - w
          - whisper
        reply:
          - r
        msgtoggle:
          - mtoggle

added in version: before 2.0

Messenger messages are private messages transmitted to a certain player. filterMessages: true defines if message filtering is enabled or not. aliases: defines the commands used for the certain functions.

MOTD

    MOTD:
      enabled: true
      message:
        - "This is line 1"
        - "This is line 2"
        - "Placeholders do work in here %name%"
        - "&6Color&4codes &land &r&0Formats &mtoo!"

added in version: 2.1.0 (config version 10.0)

This function can be used to send message(s) to a player joining into the network.

Muting

    Muting:
      enabled: true
      aliases:
        mute:
          - silence
        unmute:
          - unsilence
        tempmute:
          - tempsilence
      blockedcommands:
        - message
        - msg
        - whisper
        - m
        - tell
        - t
        - w
        - global
        - g
        - reply
        - r
      ignoreBukkitLocalChat: false
      disableWithOtherMutePlugins: true

added in version: before 2.0

Bad or annoying players can be made silent with that commands. blockedcommand: defines the list of disabled commands if muting is applied to the punished players.

-ignoreBukkitLocalChat
-disableWithOtherMutePlugins

ServerSwitchMessages

    ServerSwitchMessages:
      enabled: true

added in version: before 2.0

Players server switch will be announced if having the needed permissions.

Spy

    Spy:
      enabled: true
      aliases:
        socialspy:
        - sspy
        localspy:
        - lspy

added in version: before 2.0

This feature shifts a player having the needed right into the position to intercept any delivered private message if socialspy is used or only to the current connected server by using localspy .

StaffChat

    StaffChat:
      enabled: true
      passToClientServer: false
      aliases:
        - sc
        - s
        - schat

added in version: before 2.0

Delivers group messages to any player in the entire bungeecord network having the needed permission to receive. passToClientServer: defines if the StaffChat messages will be delivered to the local server nodes.allias: defines the commands aliases to execute GlobalChat

TabCompletion

    TabCompletion:
      enabled: true

added in version: before 2.0

Completes commands by pressing the [TAB] key like minecraft ingame chat or bash shell

Vanish

    Vanish:
      enabled: true
      aliases:
        - bhide

added in version: before 2.0

Players can hide their messages to other players, but to considered players.

VersionChecker

    VersionChecker:
      enabled: true
      checkOnAdminLogin: true

added in version: before< 2

This module will check for a new BungeeChat plugin version and will hint to that new version if available.

WelcomeMessage

    WelcomeMessage:
      enabled: true
      message:
        - "This is line 1"
        - "This is line 2"
        - "Placeholders do work in here %name%"
        - "&6Color&4codes &land &r&0Formats &mtoo!"

added in version: 2.1.0 (config version 10.0)

If a player joins for the first time to BungeeChat any annoucements defined under message: will be deliveres to the player.

PermissionsManager

  PermissionsManager:
    defaultPrefix: "&7[Member]"
    defaultSuffix: "&r"

added in version: before 2.0

_If a Prefix or Suffix can't be found defaultPrefix: and defaultSuffix will be used.

ServerAlias

  ServerAlias:
    lobby: "Lobby"
    game1: "Survival Games"
    hub: "H"

added in version: 2.1.4 (config version 10.1) local server nodes names' can be renamed with that feature, this only affects to the cosmetic representation of the server's name