UltimateShout Pro

UltimateShout Pro adds a WorldGuard flag called allow-shout which allows you to define if shout in a specific region is allowed or not.

If you want to allow shout in all worlds but don't want to add the name of every world you can just add 'all' to the allowedWorlds list.

UltimateShout Pro makes use of Adventure's MiniMessage. You can find more information on it's format here

/shout
/shout <message>
/usp reload
/usp test <format>
/usp formats

ultimateshoutpro.shout.use # To make use of shout.
ultimateshoutpro.shout.<format> # This specifies your format.
ultimateshoutpro.shout.nocooldown # With this permission you bypass cooldown
ultimateshoutpro.shout.reload # With this permission you can reload the configurations files.
ultimateshoutpro.chatcolor # Gives permission to allow color codes in shout messages

# Shows the player how to use the command.
help : '<gray>Please use <gold>/shout <message>'

# The message the players receive when they are in cooldown
cooldownMessage : '<gold>You''ll have to wait <cooldown> before shouting again.'

# With the shortcut you can allow players to just use <shortcut><message> in chat.
# Example: !I'm shouting a nice message. If the shortcut is empty this feature is disabled
shortcut : '!'

logShouts : false

allowedWorlds :
 - world
  - world_nether
  - world_the_end
  - all

shoutNotAllowedWorld : '<red>Shout is not allowed in this world <world>.'

timeunits:
  days : 'days'
  day : 'day'
  hours : 'hours'
  hour : 'hour'
  minutes : 'minutes'
  minute : 'minute'
  seconds : 'seconds'
  second : 'second'

customKeywords:
  '[pos]' : '<gold>World : <white><player_world> <gold>X:<white><player_x> <gold>Y:<white><player_y> <gold>Z:<white><player_z>'
  '[ping]' : '<papi:player_colored_ping> ms'
  ':heart:' : '<dark_red>❤'

# You can use the following placeholders in the formats:
# <playername>
# <displayname>
# <player_world>
# With Vault you can use:
# <vault_prefix>
# <vault_suffix>
# <vault_rank>
# <vault_prefix_color>
# <vault_suffix_color>
# If you have PlaceholderAPI installed you can use any available placeholder from PlaceholderAPI in here as well. Example: <papi:player_world>

# Note that sounds can differ with versions, so make sure that the sound you're using works on your server version.
# You can find the sounds for the latest spigot version here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html

# MiniMessage documentation: https://docs.adventure.kyori.net/minimessage/format.html

formats:
  default:
    messageFormat: '<shout_prefix> <reset><displayname_with_click> <dark_gray><arrow_right> <reset><message>'
    playSound: 'BLOCK_NOTE_BLOCK_PLING'
    cooldown: 300
    priority: 100

# Placeholders you can create to use in the chat format.
# This will help you keep your chat formats clean and simple.
placeholders:
  shout_prefix: '<red><bold>|| <dark_red>SHOUT <red><bold>||'
  displayname_with_click: '<click:suggest_command:"/msg <playername> "><yellow><displayname></click>'
  arrow_right: »
  arrow_left: «

hooks:
  ChatControl:
    enabled : true
    checkMuted : true
    checkIgnore : true
    chatIsMuted : <red>You cannot shout while the chat is muted!
  CMI:
    enabled : true
    checkMuted : true
    checkIgnore : true
    chatIsMuted : <red>You cannot shout while the chat is muted! The Chat is still
      muted for <time>!
  Essentials:
    enabled : true
    checkMuted : true
    checkIgnore : true
  NetworkManager:
    enabled : true
    checkMuted : true
    checkIgnore : true
    usePlaceholderAPI : true
    filter:
      antiswear : false
      anticaps : false
      antispam : false
      antiad : false
  PlaceholderAPI:
    enabled : true
  Vault:
    enabled : true
  WorldGuard:
    enabled : true
    notAllowed : <red>Shouting is not allowed in this region!