StaffOnline | GUI / MESSAGE | MESSAGE PLAYERS THROUGH GUI | REQUEST STAFF HELP | 100% CUSTOMIZABLE!

# ---------------------------------------------------------------------------------------------------------------

# STAFFONLINE CONFIGURATION - By Gonfonix (Euro)

# PLACEHOLDERS: %staffon%, (MSG AND GUI) %prefix%, (MSG AND GUI) %online_staff%, (MSG AND GUI) %online_players%, %playerson%, (GUI) %staff_member%, (GUI) %username%, (GUI) %player_rank%, (GUI) %time_left%, (GUI) %notifications_status%, (GUI) %recipient%, (GUI) %composer%, (GUI) %composed_message%

# NOTE: To reload the config, do "/staffonline reload" in-game.

# ---------------------------------------------------------------------------------------------------------------

pluginStuff :

  # The plugin's prefix, represented with the placeholder "%prefix%".
  pluginPrefix : '&8 [&6STAFFONLINE&8 ] &7>&f'

  # Customize the message displayed when typing "/staffonline" OR "/staffon".

  # NOTE: The "%ifHasPermStaff%" for example means the user will only see that line if they have the permission to do that command.
  # For "%ifPluginInfoIsOn%", if plugin info is off then that message won't be displayed obviously.
  helpMessage :
   - |-
      &f&m ---------------------------------
      &6StaffOnline&7 : &fAll commands and their descriptions that you have access to
      %ifHasPermStaff%&7/&astaff &8- &fShows all staff online on the server.
      %ifHasPermStaffList%&7/&alist &8- &fShows all players online on the server.
      %ifHasPermNotifications%&7/&astaffonline notifications &8- &fEnable / Disable help request notifications.
      %ifHasPermNotifications%&7&oAliases: /staffon notifications
      %ifHasPermStaffReload%&7/&astaffonline reload &8- &fReloads the config.yml file.
      %ifHasPermStaffReload%&7&oAliases: /staffon reload
      &7/&astaffonline &8- &fView this help page.
      &7&oAliases : /staffon
      %ifPluginInfoIsOn%&7/&astaffonline about &8- &fView information prior to the plugin.
      %ifPluginInfoIsOn%&7&oAliases: /staffon about
      &f&m ---------------------------------

  # ---------------------------------------------------------------------------------------------------------------
  # The current ranks on your server. This is for displaying what rank a player is in the GUI's on the lore of the player head (if this feature is on).

  # To have a player's rank appear on their head when hovered on, make sure they have the permission node: staffonline.rank."RANK".
  # Or it will not show their rank.
  # Example: staffonline.rank.admin (NOT case sensitive, however, you can NOT add spaces in rank names (unless your permission's plugin allows it).

  # Also the ranks below work as in an hierarchy.
  # Example: If the player has the permission node "staffonline.rank.admin" then it will display their rank as Admin. However, if you give them "staffonline.rank.officer" then it
  # will still display Admin as their rank because it is higher in the list of ranks specified below.

  # Feel free to add and remove ranks from the list below as you wish. Just make sure it looks like what is below!
  # If you remove everything below, then it will just disable the feature. To properly disable the rank feature, toggle it from TRUE to FALSE in the GUI settings.
  # ---------------------------------------------------------------------------------------------------------------
  serverRanks :
   - |-
      Owner
      Admin
      Mod
      Helper
      Officer
      Guest

  # If a player types in a command regarding StaffOnline, but it is not registered.
  unknownCommand : ' %prefix% Unknown Command. Type &7/&astaffonline &ffor a list of commands.'

  # When a player types "/staffonline about" OR "/staffon about", it will display information about the plugin.
  displayPluginInformation : true

  # If a player doesn't have access to a certain command, then this is the message that will appear prior than.
  noPermissionMessage : ' %prefix% &cYou do not have permission!'

  # When reloading the plugin, this is the message that will be displayed.
  reloadMessage : ' %prefix% &aConfiguration successfully reloaded!'

staffOnline :

  # When enabled, if a player does "/staff", it will open the GUI rather than displaying the message below.
  useGuiInstead : true

  # Customize the message displayed when typing "/staff" (IF GUI IS DISABLED).
  staffListMessage :
   - |-
      &f&m ---------------------------------
      &6Staff Members&7 : &a%online_staff% &fare currently online.
      %space%
      &aOnline&7 :
     &f %staffon%
      %space%
      &f&m ---------------------------------

  # If no staff members are online, then this message will be displayed below "Online:" instead.
  noStaffOn : '&cThere are no staff online.'

playersOnline :

  # When enabled, if a player does "/list", it will open the GUI rather than displaying the message below.
  useGuiInstead : true

  # Customize the message displayed when typing "/list" (IF GUI IS DISABLED).
  playerListMessage :
   - |-
      &f&m ---------------------------------
      &6Players Online&7 : &a%online_players% &fare currently online.
      %space%
      &aOnline&7 :
     &f %playerson%
      %space%
      &f&m ---------------------------------

  # If no players are online, then this message will be displayed below "Online:" instead.
  noPlayersOn : '&cThere are no players online.'

# ---------------------------------------------------------------------------------------------------------------
# GUI Configuration: If you do NOT want to use the GUI feature, then disable it above and reload the config.
# ---------------------------------------------------------------------------------------------------------------

staffOnlineGUI :

    # Change the name of the GUI when a player opens the Staff GUI.
   guiName : 'Staff Online'

    # Change the name of the book at the top of the GUI.
   bookName : '&cInformation'

    # When hovering over the Staff Member's book, this is the text that will be displayed.
   bookHoverText : '&6Staff Online&7 : &a%online_staff%'

    # Change the color of the Staff Member's name displayed.
   nameColor : '&a'

    # If the maximum number of slots are hit inside in the Staff List, add an option to go to a second page. Change the text color here.
   nextPageText : '&a'

    # Change the color of the nextPage lore text.
   nextPageLoreText : '&c'

    # When the player attempts to go to another page but that page no longer exists (because staff have left).
   maximumStaffPagesHit : ' %prefix% &cSorry but some staff have left, therefore, there is no page beyond the one you were on. Resetting menu...'

    # ---------------------------------------------------------------------------------------------------------------
    # The Help Request Feature: Allow players to request help from Staff Members.

    # To disable, change the value below from TRUE to FALSE.
    # ---------------------------------------------------------------------------------------------------------------

   enableHelpRequest : true

    # When hovering over a Staff Member's head, this is the text that will be displayed.
   nameHoverText : '&6Currently %notifications_status%&6. Click for assistance!'

    # When TRUE, underneath the Staff Member's availability, it will display their current rank on the server.
   displayCurrentRank : true

    # If the above is TRUE, this is the text that will be displayed following the Staff Member's rank.
   displayCurrentRankText : '&cRank&7 : &f%player_rank%'

    # When clicking on a Staff Member's head, a Book and Quil will appear allowing you to write a message to them.

    # This is what the book will be called.
   bookAndQuilTitle : '&cAsk For Help'

    # When hovering over the book, this is the message that will be displayed.
   helpMessageHoverText : '&6Click to get help!'

    # When submitting the help request, this is the message the player will receive if it succeeds in sending.
   helpRequestSuccessful : '&aYour help request to %staff_member% has been receieved!'

    # When a staff member tries requesting staff help to their self.
   sillyMistake : '&cYou cannot request staff help to yourself, silly!'

    # This is the message the staff member will receive.
   helpRequestMessage : ' %prefix% &a%username% &fneeds staff assistance!'

    # When a staff member receives a help request, it will make this sound. Make sure to follow what to use at this link: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html

    # Or the sound will NOT happen and an message telling you so will be printed to the console.

    # To disable the sound feature, change the value below from TRUE to FALSE.
   helpRequestSoundsEnabled : true

    # The sound played when a staff member receives a help request.
   helpRequestReceivedSound : 'BLOCK_ANVIL_FALL'

    # When submitting the help request, this is the message the player will receive if it fails in sending (staff member has notifications OFF) OR if the staff member left the server.
   helpRequestUnSuccessful : '&cCould not send help request to %staff_member% as they are not available right now!'

    # If a player is requesting help when another player is in the process of getting a staff members help, then they will get a message and this is what they will see.
   helpRequestInUse : '&cSorry but currently someone is in the process of getting a staff members help. Please wait a bit and try again.'

    # When a player request help from a staff member, there will be a delay until a player can contact another staff member. To NOT use this feature, simply set the number below to 0.

    # NOTE: The number below is calculated in seconds.
   helpRequestTimer : 60

    # The message displayed when the help request timer is active.
   helpRequestTimerMessage : '&cA player has recently requested staff help. Please wait %time_left% seconds before you can request help!'

    # The message displayed if a staff member disables OR enables help request notifications. By default, they are turned on when the server starts and re-enable if a staff member logs off and logs back in.

    # ---------------------------------------------------------------------------------------------------------------
    # Change the item for when notifications are enabled/disabled.

    # Use this link for a full list of materials to use: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
    # ---------------------------------------------------------------------------------------------------------------

    # When the user has notifications enabled, this is the item that will appear.
   helpRequestNotificationsEnabledMaterial : LIME_DYE

    # When the user has notifications disabled, this is the item that will appear.
   helpRequestNotificationsDisabledMaterial : GRAY_DYE

    # A staff member can disable their notifications if they do "/staffonline notifications" - Keep mind that in order to do this command, they need the permission node "staffonline.notifications"
   helpRequestNotifications : ' %notifications_status% help request notifications!'

    # A staff member can disable notifications within the GUI. This is the title of the dye.
   helpRequestNotificationsGUITitle : '&cStaff Notifications'

    # A staff member can disable notifications within the GUI. This is the lore of the dye.
   helpRequestNotificationsGUIHoverText : '&6Click to %notifications_status% &6notifications!'

playersOnlineGUI :

    # Change the name of the GUI when a player opens the Player GUI.
   guiName : 'Players Online'

    # Change the name of the book at the top of the GUI.
   bookName : '&cInformation'

    # When hovering over the Player's Online book, this is the text that will be displayed.
   bookHoverText : '&6Players Online&7 : &a%online_players%'

    # Change the color of the Player's Online name displayed.
   nameColor : '&a'

    # If the maximum number of slots are hit inside in the Player List, add an option to go to a second page. Change the text color here.
   nextPageText : '&a'

    # Change the color of the nextPage lore text.
   nextPageLoreText : '&c'

    # When the player attempts to go to another page but that page no longer exists (because players have left).
   maximumPlayerPagesHit : ' %prefix% &cSorry but some players have left, therefore, there is no page beyond the one you were on. Resetting menu...'

    # ---------------------------------------------------------------------------------------------------------------
    # The Message Player Feature: Allow players to message other players from within the GUI

    # To disable, change the value below from TRUE to FALSE.
    # ---------------------------------------------------------------------------------------------------------------

   enableMessage : true

    # When hovering over a Player's head, this is the text that will be displayed.
   nameHoverText : '&6Click to start a conversion.'

    # When TRUE, underneath the "Click to start a conversion", it will display player's current rank on the server.
   displayCurrentRank : true

    # If the above is TRUE, this is the text that will be displayed following the Player's rank.
   displayCurrentRankText : '&cRank&7 : &f%player_rank%'

    # The text displayed upon clicking on a player's head.
   promptText : ' %prefix% &aType what you want to say to &6%recipient%&a. Do &7-&6%message_closing% &ato %message_closing% the messaging.'

    # If TRUE, when a player clicks on a player in the Player's GUI, they can infinitely chat with them until they do "-cancel"

    # If FALSE, then when a player clicks on a player in the Player's GUI, they will NOT infinitely chat with them. Instead they must go back into the GUI, click on their name again
    # and re-message them. They can then do "-cancel" to cancel their messages.
   useChatroom : true

    # The message that appears on the player's screen who received a message telling them what to do, to message the player back.
   messagingStarted : '&a %composer% has started a conversion with you. Do &7/&6list &aand click on their head to message them back.'

    # The message that appears on the player's screen who composed the message.
   messageSent : '&6✉ &aYou &7- &a %recipient% &8> &f&o%composed_message%'

    # When a player tries messaging their self.
   sillyMistake : '&cYou cannot message yourself, silly!'

    # The message that appears on the player's screen who received the message.
   messageReceived : '&6✉ &a %composer% &7- &aYou &8> &f&o%composed_message%'

    # The message that appears on the player's screen who tried composing a message, but the recipient had logged off.
   messageFailure : '&cMessage failed to send because %recipient% is no longer online! You have been put back into global chat.'

    # If Chatrooms are enabled and a player tries starting another conversion with another player during a current conversion with someone else, then it will prevent them.
   cannotStartMessaging : '&cYou are already messaging someone. Do -close to stop messaging them and then try again.'

    # The message that appears on the player's screen who canceled the message / conversion.
   messageCanceled : '&cEnded messaging!'

    # If a player ends a conversion with someone, then the other player will receive a message telling them it ended.
   messageEnded : '&c %composer% has ended the conversion with you. You have been put back into global chat.'

    # If a player starts a conversion with someone, but then ends it right away before the other player could even message them back.
   messageEndedNeverJoined : '&c %composer% had started a conversion with you, but ended it right away. No need to message them back.'

    # When a player receives a message, it will make this sound. Make sure to follow what to use at this link: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html

    # Or the sound will NOT happen and an message telling you so will be printed to the console.

    # To disable the sound feature, change the value below from TRUE to FALSE.
   messageSoundsEnabled : true

    # The sound played when a player receives a message.
   messageReceivedSound : 'ENTITY_EXPERIENCE_ORB_PICKUP'