HoverStats
PluginMIT

HoverStats

Converts the player name into a hoverable stats message

26
Downloads
1
Followers
5 months ago
Updated
📦
1
Versions

📖About HoverStats

Join Our Support Discord! Baner
This plugin uses PAPI Banner
Features banner

Feature Summary HoverStats comes packed with powerful features and deep customization options. It supports group-based hover messages, allowing each rank or permission group to have its own unique hover display. With a robust permission system, you can easily enable or disable specific features for your players.

We aim to make our plugins as customizable as possible - while not every single detail can be edited, HoverStats is 99% customizable, giving you full control through the config and other supporting files.

To maximize compatibility, HoverStats fully integrates with PlaceholderAPI, ensuring seamless support with many popular server plugins. This means you can use both our internal placeholders and any from your favorite plugins for a smooth, unified experience.

Commands Section Header

Command Description
/hoverstats Shows the help message for the plugin
/hoverstats reload Reloads the plugin
/hoverstats version Shows the current version of the plugin and config file
/hoverstats blacklist [group/user] [Group Name/User Name] Blacklist a specific player or group from being able to send hoverable messages
/hoverstats whitelist [group/user] [Group Name/User Name] Whitelist a specific player or group, allowing them to be able to send hoverable messages

Permissions Section Header

Pemission Description
hoverstats.help Shows the help message for the plugin (Given by Default)
hoverstats.reload Gives the player the ability to reload the plugin
hoverstats.version Shows the current version of the plugin and config file
hoverstats.update Will show the player if there is an update when they join the server
hoverstats.chat.view Makes it so that the player can view hoverable messages (can only be used when "Chat Formatting.Require Permissions" is set to true
hoverstats.magic.* This will give the player access to all "magic" color codes
hoverstats.colors.hex This will give the player access to all hex colors
hoverstats.colors.* This will give the player access to all chat colors
hoverstats.colors.[color-name] This will give the player access to a specific chat color in chat. This has to be the color name (ex., dark_aqua)
hoverstats.join-formatting This will show the player the join format message specified in the config.yml (Given by Default)
hoverstats.leave-formatting This will show the player the quit format message specified in the config.yml (Given by Default)
hoverstats.blacklist.user This will allow the player to blacklist users, removing the ability to show them hoverable messages
hoverstats.blacklist.group This will allow the player to blacklist groups, removing the ability to show them hoverable messages
hoverstats.whitelist.user This will allow the player to whitelist users, allowing them to show hoverable messages
hoverstats.whitelist.group This will allow the player to whitelist groups, allowing them to show hoverable messages

Config Example Section Header

# DO NOT CHANGE, this value is used for internal plugin use only
Version: 5.6.2
# #################################################################### #
#                                                                      #
#                              Config.yml                              #
#                                                                      #
# #################################################################### #

# Enable debug mode
# Enabling this may result in your console being spammed with messages about the plugin
# Only enable this if you want to learn more about the plugin, or are told to by support staff
Debug Mode: false # Defaults to false

# Set this to true if you want to use Vault in the plugin; this enables group-based hooks
Vault hook: true

# Set this to true if you want to use PlaceholderAPI in the plugin
PAPI hook: true

# Set PAPI hook to true to use all the PlaceholderAPI placeholders
# in the messages

# These are the Placeholders provided by the plugin
Placeholders:
  Prefix: '&aTardisDev &8|'
  Error: '&cError &8|'
  Success: '&aSuccess &8|'
  Plugin Name: '&bHoverStats'
  Command Name: HoverStats
  Placeholder Filler: '0' # Set the default placeholder for any placeholders that are empty or equal "null"

# #################################################################### #
#                         List of placeholders                         #
# #################################################################### #
#                              Global                                  #
#                      ######################                          #
#                                                                      #
#                    Prefix       -       %prefix%                     #
#                     Error       -       %error%                      #
#                   Success       -       %success%                    #
#               Plugin Name       -       %pluginname%                 #
#              Command Name       -       %cmdName%                    #
#                    Player       -       %player%                     #
#                                                                      #
# #################################################################### #
#                           * Disclaimer *                             #
#                  Player may not work for certain                     #
#                              messages                                #
# #################################################################### #
#                                Chat                                  #
#                      ######################                          #
#                                                                      #
#       Previous Formatting       -       %prev-format%                #
#                                                                      #
# #################################################################### #
#                              * Note *                                #
#       Any placeholders in the chat section can only be used          #
#     within the 'Chat Formatting.Format' section of the config        #
# #################################################################### #

# Set the priority at which the chat event will run. Setting this can fix
# Compatibility issues with other plugins
#
# Note: You can find a list of event priorities at the link below:
# https://bukkit.fandom.com/wiki/Event_API_Reference#Event_Priorities
#
# Note: After changing this value, the server must be reloaded/restarted
Chat Event Priority: HIGH # Defaults to HIGH
Join Event Priority: HIGH # Defaults to HIGH
Quit Event Priority: HIGH # Defaults to HIGH

# Set all the different hex patterns you want to support in your chat
#
# Note: By default there is already one hex pattern that the plugin knows
# that hex pattern is the standard (#ffffff) pattern. No need to add that one
# to the list.
#
# Disclaimer: The hex patterns are checked sequentially meaning that the hex
# pattern that is on the top is checked first, then the next pattern and so
# on and so forth. If a hex code isn't working for whatever reason, try to add
# it to the top of the list and try again
Hex Patterns:
  # The default names for each of the hex codes is purely for aesthetics
  <#ffffff>: # Set a unique name for the hex code
    Prefix: <# # Set what prefix the plugin should look for
    Suffix: '>' # Set the suffix that the plugin should look for
  
  '&#ffffff':
    Prefix: '&#'
    Suffix: ''

# Set the global date format
Date Format: MM/dd/yy hh:mm:ss

Formatting:
  # Setting this to false will make it so that either another plugin or default
  # minecraft will take control over the server's join messages. Setting this
  # to true will use the formatting below
  Use Join Formatting: true
  
  # Setting this to false will make it so that either another plugin or default
  # minecraft will take control over the server's leave messages. Setting this
  # to true will use the formatting below
  Use Quit Formatting: true
  Chat Formatting:
    # Setting this to true will make it so that only people who have the permission
    # 'hoverstats.chat.view' can view the hover able message
    #
    # Please note that this will make it so ONLY people with this permission are
    # able to view the hover able message
    Require Permission: false
    # Setting this to false will make it so that another plugin will take control
    # of the chat. Setting this to true will use the formatting below.
    #
    # Please note that this may cause the entire message to be taken over by
    # HoverStats. This is the case if you are using Luck Perms Chat (LPC) which
    # doesn't abide by Minecraft's chat formatting standards.
    Use Formatting: true
    # Setting this to false will make it so that you can use the chat formatting
    # from HoverStats instead of Luck Perms Chat (LPC). This shouldn't be changed
    # as if you have LPC you are more than likely planing to use it, and if you
    # aren't it should be removed.
    Override LPC: true

Hover Blacklist:
  # Define groups that are not able to send any hover messages
  Groups:
  - admin
  # Define users that are not able to send any hover messages
  Users:
  - Notch


# #################################################################### #
#                                                                      #
#                               Messages                               #
#                                                                      #
# #################################################################### #
Messages:
  System Messages:
    Success:
      PAPI Hook: '&aFound PlaceholderAPI, hooking into it.'
      Vault Hook: '&aFound Vault, hooking into it.'
      Reloaded: '%success% %pluginname%''s &7config has successfully reloaded!'
    
    Error:
      PAPI Hook: '&cCouldn''t find PlaceholderAPI, any placeholders from PAPI will
        no longer work.'
      Vault Hook: '&cCouldn''t find Vault, permission based commands/placeholders
        will not work until vault is installed.'
      No Permissions: '%error% &7You don''t have permission to run this command!'
      Usage: '%error% &eUsage Error &8| &7%usage%'
      Invalid Group: '%error% &7The group you entered (&b%group%&7) is invalid! Groups
        are case sensitive and must be exact, please try again, checking your spelling
        and cases.'
      Invalid Player: '%error% &7The player you entered (&b%player%&7) is invalid!
        Please try again.'
      Already Blacklisted: '%error% &7The %option% you entered (&b%input%&7) is already
        blacklisted, to remove them please use the /whitelist command.'
      Already Whitelisted: '%error% &7The %option% you entered (&b%input%&7) is already
        whitelisted, to remove them please use the /blacklist command.'
      Not Blacklisted: '%error% &7The %option% you entered (&b%input%&7) is not blacklisted,
        to add them please use the /blacklist command.'
      Added Blacklist: '%success% &7Successfully added %option% (&b%input%&7) to the
        blacklist.'
      Added Whitelist: '%success% &7Successfully added %option% (&b%input%&7) to the
        whitelist.'
  
  # Default help message, you can change this if you want
  Help:
  - ''
  - '&7&l&m⎯⎯⎯⎯⎯⎯&r &a&l%pluginname% Help &r&7&l&m⎯⎯⎯⎯⎯⎯&r'
  - '&a/%cmdName% &7- Shows this message.'
  - '&a/%cmdName% help &7- Shows this message.'
  - '&a/%cmdName% reload &7- Reload''s %pluginname%''s config.'
  - '&7&l&m⎯⎯⎯⎯⎯⎯&r &a&l%pluginname% Help &r&7&l&m⎯⎯⎯⎯⎯⎯&r'
  - ''