ChatManager Reloaded

##########
#######
####

# Possible placeholders in this plugin
# PLACEHOLDERS
# {PLAYER} = returns to the name of the player who is related to event
# {MESSAGE} = returns to the message from player

##################################
#          Player Swear          #
##################################


# replace the words by a character
# not that if this is enabled,
# the letter of the word will be replace to the character you input
replace : true

# the character to replace to a word test = "****"
replacement : '*'

# Block player from chat if they swear
block : false


######################################
#          Chat Cooldown             #
######################################

chatCooldown : true

# Input chat interval ( seconds )
chatInterval : 3

######################################
#             Anti Spam              #
######################################

# After having 5 counts of message it will give a delay
chatLimit : 5

# seconds delay
chatDelay : 3

######################################
#            Staff Chat              #
######################################

staffChat : true

staffChatFormat : '&8 [ &6StaffChat&8 ] &6 { PLAYER } : &r{MESSAGE}'

######################################
#            Broadcast               #
######################################

# {PLAYER} might be console if the sender of the command is console
broadcastFormat : '&8 [ &6Broadcast&8 ] &6 { PLAYER } : &r{MESSAGE}'

######################################
#           Clear Chat               #
######################################

# Clear chat output message will be given to player if it is enabled
# You can always modify the output message in lang.yml

clearChatOutputMessage : true

######################################
#            ChatColor               #
######################################

# enable this if you want to colorize chat when it contains color codes
# for color code list : http://www.minecraftforum.net/forums/support/server-support/tutorials-and-faqs/1940467-bukkit-colour-codes
chatColorEffect : true

######################################
#            Anti Ads                #
######################################

# enable this if you want to add anti advertisement
antiAd : true

# if a player chat something match this with dots (.)
# will be cancelled and known as advertising
# such as play.test.test
# mc.com.org
# and so on
websiteMatcher :
- 'com'
- 'org'
- 'net'
- 'mc'
- 'play'

######################################
#          Chat Format               #
######################################

# Enable this plugin to format your chat if you want
chatFormatting : true

# the format
# {PLAYER} , {RANK} = PEX rank or GroupManager rank
# {MESSAGE} returns to player message
# {DISPLAYNAME} returns to player displayname
# {LOCALIZATION} for changing this one go to the lowest part of the config
# Localization has no need to add space or color
chatFormat : ' { LOCALIZATION } &7 { PLAYER } &7 : &f{MESSAGE}'

# format based on the permission
groupFormat :

  # chatmanager.op is default, this will check if the player is op not the permission
  op : ' { LOCALIZATION } &8 [ &cOperator&8 ] &c { PLAYER } &7 : &f{MESSAGE}'

  # else if the player is not op check other permission
  # giving a permission chatmanager.builder will give them this prefix
  builder : ' { LOCALIZATION } &8 [ &1Builder&8 ] &a { PLAYER } &7 : &f{MESSAGE}'

  # If the player is not permitted it will direct to the default chatFormat

######################################
#          Join And Quit             #
######################################

# Make it false if you do not want to enable this feature
# PlaceHolders
# {PLAYER} return to player name
# {DISPLAYNAME} return player displayname
# {SERVER} return to server name
# {MAXPLAYER} return to max player count
# {ONLINE} return to online players
# {WORLD} return to world name
joinListener : true

# Color code is supported
# if the player is not permitted with custom join message
# then this is the default one
joinMessage : '&bWelcome back &7 { DISPLAYNAME } &benjoy your day'

# First join message
firstJoinMessage :

  # This is for default player
  default : '&bWelcme &7 { DISPLAYNAME } &bto the server'

  # I assume that you want a custom one for specific player so input their name
  LifeonBlack : '&bWelcome developer : ) '

# having no permission below will fire the joinMessage above
customJoinMessage :

  # This is only for op
  op : '&bWelcome the operator of the server'

  # This is for permitted chatmanager.join.owner
  owner : '&bWelcome the owner of the server'

quitListener : true

# Color code is supported
# if the player is not permitted with custom quit message
# then this is the default one
quitMessage : '&7 [ - ] { DISPLAYNAME } '

# having no permission below will fire the quitMessage above
customQuitMessage :

  # This is for only op
  op : '&cOperator left'

  # This is for permitted chatmanager.quit.owner
  owner : '&cThe owner left'

######################################
#          Auto Broadcast            #
######################################

# enable this feature if you want
autoBroadcast : true

# broadcast delay
# delay is equivalent to minutes
broadcastDelay : 4

# the broadcast messages
broadcastMessage :
 - '&bFirst message'
  - '&bSecond message'
  - '&bThird message'

######################################
#             Anti Caps              #
######################################

antiCaps :

  enable : true

  # action may be block or warn
  action : 'block'

  # if blocked
  block : '&cYou cannot chat with too many caps'

  # if warn
  warn : '&cExcessive use of caps'

  # make the message lowercase
  lowercase : true

######################################
#            Local Chat              #
######################################

# Whether this feature enable or not
localChat : true

# Radius where local chat can be sent
chatRadius : 30

# {LOCALIZATION} is a local and can be used as placeholder on changing the format above
# Input replacement
Local : ' [ L ] &r'
Global : '&6 [ Shout ] &r'

######################################
#           Player Poke              #
######################################

# Whether this feature enable or not
playerPoke : true

# Change the color of tagged player
pokeName : '&6&l@ { PLAYER } '

# Send a sound to tagged player
# For list of sounds https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
Sound :
  enable : true
  type : 'ENTITY_CHICKEN_EGG'
  volume : 1.0
  pitch : 1.0

[ /FONT ] ############

########

####


# input your language here

language : 'English'


english :


  noPermission : '&8 [ &bChatManager&8 ] &cYou have no permission to do that'

  reloadSuccess : '&8 [ &bChatManager&8 ] &aAll files reloaded successfully'

  noSwear : '&8 [ &bChatManager&8 ] &cSwearing is not allowed in this server'

  unknownCommand : '&8 [ &bChatManager&8 ] &cUnknown command'

  chatCooldown : '&8 [ &bChatCooldown&8 ] &cYou cannot send message right now'

  broadcastCorrectUsage : '&8 [ &bChatManager&8 ] &c/ { COMMAND } { MESSAGE } '

  clearMessage : '&8 [ &bChatManager&8 ] &aYour chat has been cleared'

  onlyForPlayer : '&8 [ &bChatManager&8 ] &cYou must be a player to do that'

  targetOffline : '&8 [ &bChatManager&8 ] &cPlayer is not online'

  targetClearChat : '&8 [ &bChatManager&8 ] &aSuccessfully cleared { PLAYER } ''s chat'

  addWordSuccessfully : '&8 [ &bChatManager&8 ] &aWord { WORD } added successfully'

  removeWordSuccessfully : '&8 [ &bChatManager&8 ] &aWord { WORD } remove successfully'

  wordAlreadyExist : '&8 [ &bChatManager&8 ] &aWord { WORD } already exist'

  wordNotFound : '&8 [ &bChatManager&8 ] &aWord { WORD } did not exist'

  noAdvertise : '&8 [ &bChatManager&8 ] &cAdvertising in this server is not allowed'

  forbiddenUseOfNumber : '&8 [ &bChatManager&8 ] &cYou cannot use numbers on chat'

  chatSlowDown : '&8 [ &bChatManager&8 ] &cSlow down, spamming in this server is not allowed'

  lockedChat : '&8 [ &bChatManager&8 ] &cYour chat has been locked'

  unLockedChat : '&8 [ &bChatManager&8 ] &aYour chat has been unlocked'

  noReceiveAbility : '&8 [ &bChatManager&8 ] &cYou cannot receive any message'

  receiveAbility : '&8 [ &bChatManager&8 ] &aYou can now receive any message'

  muted : '&8 [ &bChatManager&8 ] &cYou are now muted'

  unMute : '&8 [ &bChatManager&8 ] &aYou are now unmuted'

  playerChatLock : '&8 [ &bChatManager&8 &cYour chat is locked'

  playerChatMute : '&8 [ &bChatManager&8 &cYou are muted' [ FONT=Tahoma ]

###############

#########

#####


# input all words to be banned

BannedWords :

  - lifeonblack

  - is

  - cute

commands :

  chatmanager :

    description : main command for this plugin

    aliases : [ cm ]

  broadcast :

    description : broadcast something to the server

    aliases : [ say, shout, all ]

  clearchat :

    description : clear player chat

    aliases : [ cc ]

permissions :

  chatmanager.admin : { description : ability to reload configs add word and remove word , default : false }

  chatmanager.broadcast : { description : ability to use /broadcast command, default : false }

  chatmanager.clearchat.self : { description : ability to clear own chat, default : false }

  chatmanager.clearchat.others : { description : ability to clear ones chat, default : false }

  chatmanager.clearchat.all : { description : ability to clear all chat, default : false }

  chatmanager.staffchat.send : { description : ability to send to staff chat, default : false }

  chatmanager.staffchat.receive : { description : ability to receive from staff chat, default : false }

  chatmanager.bypass.swear : { description : bypass from anti swear, default : false }

  chatmanager.bypass.cooldown : { description : bypass from chat cooldown, default : false }

  chatmanager.chat.effect : { description : ability to use effect codes from chat, default : false }

  chatmanager.chat.color : { description : ability to use color codes from chat, default : false }

  chatmanager.bypass.antiad : { description : ability to bypass anti ad, default : false }

  chatmanager.bypass.antispam : { description : ability to bypass anti spam, default : false }

  chatmanager.chat.numbers : { description : ability to chat numbers, default : false }


  chatmanager.* :

    children :

     chatmanager.admin : true

     chatmanager.broadcast : true

     chatmanager.clearchat.self : true

     chatmanager.clearchat.others : true

     chatmanager.clearchat.all : true

     chatmanager.staffchat.send : true

     chatmanager.staffchat.receive : true

     chatmanager.bypass.swear : true

     chatmanager.bypass.cooldown : true

     chatmanager.chat.effect : true

     chatmanager.chat.color : true

     chatmanager.bypass.antiad : true

     chatmanager.chat.numbers : true

     chatmanager.bypass.antispam : true


  chatmanager.clearchat.* :

    children :

     chatmanager.clearchat.self : true

     chatmanager.clearchat.all : true

     chatmanager.clearchat.others : true


  chatmanager.staffchat.* :

    children :

     chatmanager.staffchat.send : true

     chatmanager.staffchat.receive : true


  chatmanager.bypass.* :

    children :

     chatmanager.bypass.swear : true

     chatmanager.bypass.cooldown : true

     chatmanager.bypass.antiad : true

     chatmanager.bypass.antispam : true


  chatmanager.chat.* :

    children :

     chatmanager.chat.color : true

     chatmanager.chat.effect : true

     chatmanager.chat.numbers : true

// must check first if the chat manager is loaded

ApiManager apiManager = ChatManager. getApi ( ) ;

apiManager. removeWord ( String word ) ; // this will remove a banned word

apiManager. addWord ( String word ) ; // this will add a banned word

apiManager. clearWords ( ) ; // this will definitely clear all words

apiManager. getLanguage ( ) . getString ( "path" ) // will get message from language file.

apiManager. getWords ( ) ; // this will get the list of words.

.. and so on

// saving and getting word to config

Word word = new Word ( String string ) ;

config. set ( "path" , word ) ;


// getting

Word word = ( Word ) config. get ( "path" , word ) ;

// word object could be helpful

Word word = new Word ( String string ) ;

word. toString ( ) // will return to string

word. colorize ( ) // will return to string that is colorize with minecraft color codes

word. removeColor ( ) ; // will remove all color from string

  // this will listen for every time a player swear

// it contains:

Player getPlayer ( ) // this will return to the player that is related to the event

List < String > getWords ( ) , // words is a collection of words that player said ( Banned Words )


setCancelled ( boolean b ) // this will block player from sending the message

// these two will listen for every time a plugin remove a word or add a word

String getWord ( ) // return to string of a word that is related to the event

boolean wordExist ( ) // return true if the word is added already on the banned words

void setCancelled ( boolean value ) // cancel adding or removing word