VIP PremiumVanish - Stay hidden [+Bungee support] 2.9.9

# PremiumVanish v2.8.0 - Messages
#
# Information:
# <..> means that .. is required; [..] means that .. is optional and can be left out; | INSIDE [] or <> stands for 'OR'
# You can use the & character for color codes. Example: '&cThe color of this text would be red!'
# You can use #XXXXXX for HEX color codes. Example: '#663EF6This text would be purple!'
# You can use %p% to get the player's name. Example: '&4&l%p%, you aren't allowed to execute this command!'
# You can use %other% to get the name of the target or cause
# You can use %d% to get the player's display name. If you use Essentials then the display name contains the prefix too
# You can use %tab% to get the player's name in the player list (TAB)
# You can use %prefix% to get the player's prefix (Requires Vault)
# You can use %suffix% to get the player's suffix (Requires Vault)
# You can use %group% to get the player's group (Requires Vault)
# You can use %nick% to get the player's nickname (Requires Essentials)
# You can use %special{<text>|<hoverMessage>|[clickCommand]|[run|suggest]}% to create a clickable/hoverable
#  message part for any message (only one per message possible)
# You can use %time{<format>}% to get the current time (Uses the server's timezone)
#  Replace <format> with the date format of your choice. Example: %time{hh:mma | yyyy/MM/dd}%
#  More info: http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
# You can use %uselevel% and %seelevel% to get the player's respective vanish level (with LayeredPermissions)
# There is also %health%, %maxhealth%, %tps%, %plain_tps%, %ping% and %plain_ping%
# Some messages allow different, unique variables too
#
# NOTE: You can get WAY more placeholders by installing PlaceholderAPI or MVdWPlaceholderAPI
#
# You can also make any message dependent on a player's group by adding 'PerGroup' in front of the message:
# PerGroupNoPermission:
#   Admin: 'What, this should not happen you are the Admin!'
#   Player: 'You have like no permissions anyway'
#   Silence: ''
#   Default: 'Access denied.'
#
# You can start a message with [JSON] to send JSON text directly.
# Example: '[JSON]{"text":"Welcome %p%","color":"yellow"}'
#
# Empty messages will not be sent.
# Using \n starts a new line.
#
# Important:
# You must double single quotes if you want to use them inside a message.
# You must NOT use any tab characters inside this file (indent key) otherwise YAML will spam your console with errors!
# !! If there are errors in the console after editing this file paste it into an online YAML parser to see if
# there are any YAML syntax errors !!
Messages:
  NoPermission: '&4Denied access! You are not allowed to do this.'
  InvalidUsage: '&cInvalid usage, you can use %special{&6''/pv help''|&6Click here for help!|/pv help|suggest}% &cfor help.'
  VanishMessage: '&e%p% left the game'
  ReappearMessage: '&e%p% joined the game'
  VanishMessageWithPermission: '&a[PV] %p% vanished.'
  ReappearMessageWithPermission: '&a[PV] %p% reappeared.'
  OnVanish: '&aYou are now invisible! (%time{hh:mm a}%)'
  OnReappear: '&aYou are no longer invisible! (%time{hh:mm a}%)'
  OnVanishCausedByOtherPlayer: '&a%other% hid you, you are now invisible!'
  OnReappearCausedByOtherPlayer: '&a%other% showed you, you are now visible!'
  AlreadyVanishedError: '&cYou are already invisible!'
  NotVanishedError: '&cYou are not invisible!'
  AppliedSilentFlag: '  &eUsing flag -s: No fake join/quit broadcast'
  AppliedShowInTabFlag: '  &eUsing flag -t: Not hidden in the tablist'
  SilentJoinMessageForAdmins: '&a[PV] %p% joined silently.'
  SilentQuitMessageForAdmins: '&a[PV] %p% left silently.'
  RemindingMessage: '&aYou are still invisible!'
  ListMessagePrefix: '&aInvisible Players:&f '
  ActionBarMessage: '&aYou are invisible to other players!'
  HideOtherMessage: '&aPlayer &e%other%&a is now invisible!'
  ShowOtherMessage: '&aPlayer &e%other%&a is now visible!'
  CannotHideOtherPlayer: '&cYou''re not allowed to change %other%''s visibility!'
  AlreadyInvisibleMessage: '&cPlayer &e%other%&c is already invisible!'
  AlreadyVisibleMessage: '&cPlayer &e%other%&c is already visible!'
  PluginReloaded: '&aSuccessfully reloaded PremiumVanish (%time%ms)!'
  InvalidSender: '&cYou must be a player to execute this command!'
  PlayerNotOnline: '&cThat player is not online!'
  PlayerNonExistent: '&cThat player doesn''t exist!'
  TeleportationFailed: '&cYour teleportation failed because another plugin disallowed it.'
  ToggledPickingUpItemsOn: '&ePicking up items is now turned &aON&e.'
  ToggledPickingUpItemsOff: '&ePicking up items is now turned &cOFF&e.'
  UpdateWarning: '&cWarning! Recreating %updates% resets %changes%. Please use &e/pv recreatefiles confirm&c if you''d like to continue.'
  RecreatedConfig: '&aSuccessfully recreated %updates%! Please check %changes%.'
  NoConfigUpdateAvailable: '&eYour PremiumVanish-files are up to date!'
  RecreationRequiredMsg: '&c[PV] Your PremiumVanish-files are not up to date. You can use &e/pv recreatefiles&c to recreate them
  or click %special{&6here|&6Click here to dismiss this message!|/pv recreatefiles dismiss|suggest}% &cto dismiss this message.
  Recreating PremiumVanish''s files is optional and gives you access to newer config settings and messages of the plugin.
  If you don''t want to redo the entire config files you can also copy in new messages/settings manually
  (see default config files in resource description).'
  DismissedRecreationWarning: '&eYou are no longer receiving notifications about this recreation.'
  UndismissedRecreationWarning: '&eYou are now receiving notifications about this recreation.'
  MustBeVanished: '&cYou must be invisible to use this command!'
  ScoreboardDisabled: '&cThe scoreboard has been disabled in the configuration.'
  NoTarget: '&cYou don''t have any target at the moment!'
  NoLockedTarget: '&cYou don''t have any locked target at the moment!'
  UnlockedPlayer: '&6Successfully unlocked your target!'
  TargetedPlayer: '&eSuccessfully targeted the player ''&a%other%&e''!'
  ScoreboardLockedTarget: '&e[L]'
  ScoreboardNoTarget: 'None'
  ToggledScoreboardOn: '&eYour vanish scoreboard is now turned &aON&e.'
  ToggledScoreboardOff: '&eYour vanish scoreboard is now turned &cOFF&e.'
  PrintedStacktrace: '&eSuccessfully created a stacktrace, see console!'
  ChatMessageWarning: '&c[PV] Your message must end with a %char% to be sent!'
  ChatMessageWarning2: '&cPlease click %special{&6here|&6Click here to send your message!|%message%/|suggest}% &cto send the message.'
  ChatMessageDenied: '&c[PV] You can''t send messages in vanish! %special{&6[Reappear]|&eClick here to reappear!|/pv off|suggest}%'
  CommandAccessDenied: '&c[PV] You can''t use this command in vanish!'
  CreativeItemDenied: '&c[PV] You can''t cheat items in vanish!'
  SpectatorTeleportDenied: '&c[PV] You can''t teleport using the spectator menu in vanish!'
  EntityHitDenied: '&c[PV] You can''t hit players or mobs in vanish!'
  BlockInteractDenied: '&c[PV] You can''t interact with this block in vanish!'
  BlockUseDenied: '&c[PV] You can''t use this block in vanish!'
  BlockPlaceDenied: '&c[PV] You can''t place blocks in vanish!'
  BlockBreakDenied: '&c[PV] You can''t break blocks in vanish!'
  InventoryModifyDenied: '&c[PV] You can''t edit this inventory in vanish!'
  MessageFailedAntiSpam: '&c[PV] Please slow down and wait at least %time% before running this command again.'
  SwitchedGameMode: '&a[PV] Switched gamemode (Double-Shift)'
  PluginOutdated: '&c[PV] Your current version of PremiumVanish is outdated. New version: ''%new%''; Currently: ''%current%'''
  NoDatabaseConnection: '&c[PV] Error: Failed to connect to the database, more info in console.'
  DynmapFakeJoin: '%d% joined'
  DynmapFakeQuit: '%d% quit'
  HelpHeader: '&e<&f---------------&6PremiumVanish-Help&f-----------------&e>'
  HelpHint: '&7You can hover over a command to show more information about it and click on a command to
  insert it into your chat.'
  HelpCommands: '&eCommands:'
  HelpCommandFormat: '%special{&a- &c%usage% &b%shortdesc%|&a%usage%\n&f%longdesc%\n&4Permission:&e
  %permission%\n&2Console:&e %console%|%usage%|suggest}%'
  HelpCustomCommandShortDescriptions:
#    '/pv help': 'Custom short description; Keep the indentation, only remove the hashtag!'
  HelpCustomCommandLongDescriptions:
#    '/pv target <player>': 'Custom long description'
  HelpConsoleYes: 'Yes'
  HelpConsoleNo: 'No'
  HelpOtherPermissions: '%special{&e> Other permissions <|&aOther permissions%permissions%}%'
  HelpOtherPermissionsPermissionsFormat: '\n&c%permission% &e> &f%description%'
  HelpFooter: ''
  InvalidVanishLevel: "&c'%arg%' is not a valid vanish level (Maximum=%maxlevel%)."
  SetVanishLevelDenied: "&cYou are not allowed to set your level to %level%!"
  LayeredPermissionsDisabled: "&cLayered permissions must be enabled in the config."
  SetVanishLevel: "&aYou set your vanish level to %level%!"
  DiscordSRVFakeQuit: "&e%p% left the game"
  DiscordSRVFakeJoin: "&e%p% joined the game"
  PlaceholderIsVanishedYes: 'Yes'
  PlaceholderIsVanishedNo: 'No'
  PlaceholderVanishPrefix: '&a[V] &r'
  PlaceholderVanishSuffix: ' &r&a[V]'
MessagesVersion: 2.8.0

# PremiumVanish v2.7.7 - Bungeecord proxy extension config
Configuration:
  Database:
    # The credentials for the database, make sure to use the same database for PV on any bukkit/bungee server.
    # This has to be enabled for this plugin to work on bungeecord.
    #
    # Important: Please make sure that ip-forwarding is enabled on your Bungee AND your Bukkit servers.
    # It's also important that your database is firewalled so it's not accessible from the internet.
    Enable: true
    # The ip of your database server
    Ip: ""
    # The port of your database, usually 3306; just leave it empty if there is no specific port
    Port: "3306"
    # You can make PremiumVanish ignore the two options above and use a direct URI to connect instead
    # Format for MySQL servers: jdbc:mysql://<yourIp>:<yourPort>/<yourDatabase>?useSSL=false
    CustomURI: ""
    # The name of your database user
    User: ""
    # The password of your database user
    # WARNING: Please make sure only people who are allowed to know the password can access this file
    Password: ""
    # The name of the database which PremiumVanish should create its tables in
    # Note: PremiumVanish won't create this database, it must be pre-created using eg. phpMyAdmin
    Database: ""
    # Not recommended; Makes PV use the standard JDBC connector instead of the more powerful multi-pooled HikariCP one
    # You can give this a try if you have strange problems with connecting to your database
    BasicDatabaseConnector: false
  Features:
    # Should PremiumVanish hide invisible players in the bungeecord commands /glist, /server and /find?
    # Note: You can use 'pv.see' as a bungeecord permission to determine which players should be able to see
    # invisible players in these commands. (This doesn't replace the bukkit permission, it's recommended to use both)
    ReplaceBungeeCommands: true
    # Should PremiumVanish adjust the playercount in the serverlist? (-1 per invisible player)
    AdjustPlayerCount: true
    # Should PremiumVanish remove the names of vanished players from tab-completions for players without pv.see?
    FilterTabCompletions: true
    # A whitelist of command usages where it should be allowed to tab-complete vanished players that you can't see.
    # You can use this for commands that generally tab-complete any player, online or not.
    # This section is for advanced users only and uses regular expressions.
    # For changes to apply you need to change this on all spigot servers and on the bungee.
    TabCompleteWhitelist:
      - "/(ps|plotsquared|p2|2|plotme|plot|p)\\s(visit|v|tp|teleport|goto|warp).*"
    # You can make any command not execute and instead return a custom message if an argument is a vanished
    # player's name. Useful for faking 'Player not found' messages if there are unsupported plugins.
    # You can use <vanished> as a placeholder for any vanished player's name and <...> as a placeholder for
    # anything but whitespace. Any message which STARTS WITH the text you define below (case-insensitive) will
    # be cancelled and will instead send the sender of the command a message you specify.
    # This is network-wide and not optimized for Bukkit commands, for non-bungeecord commands go to the
    # server's PV config; exempt permission: pv.see
    CustomCommandMessages:
      '/examplemsg1 <vanished>': "&cPlayer not found"
      '/makemeadmin2 group <...> useradd <vanished>': "&c<vanished> is totally not online!"
    # Should pv.use and pv.see be layered? => pv.use.levelX, pv.see.levelX
    # Players can see a vanished player if their see level is higher or equal to the other player's use level
    # This setting only applies to PV's bungee features. Layered permissions need to be enabled on the spigot servers.
    # Note: For performance reasons permissions are currently only recomputed on join; '/pv setlevel' isn't supported
    LayeredSeeAndUsePermissions: false
    # What should be the highest level for both layered permissions?
    # Lower amounts might improve performance with more players since that reduces the amount of permission checks
    # This setting only applies to PV's bungee features. Layered permissions need to be enabled on the spigot servers.
    LayeredPermissionsMaxLevel: 100
  Messages:
    MustBePlayer: "&cYou must be a player to use this command!"
    NetworkVanishOn: "&aYou are now joining the network vanished automatically."
    NetworkVanishOff: "&aYou are no longer joining the network vanished automatically."

private boolean isVanished(Player player) {
        for (MetadataValue meta : player.getMetadata("vanished")) {
            if (meta.asBoolean()) return true;
        }
        return false;
}

First of all you add SuperVanish and PremiumVanish as a (soft-)dependency to your plugin.yml file:

# in the plugin.yml file:
softdepend: [SuperVanish, PremiumVanish]

If you declared it as a soft dependency: Check if SuperVanish or PremiumVanish is enabled before using the API:

if (Bukkit.getPluginManager().isPluginEnabled("SuperVanish") || Bukkit.getPluginManager().isPluginEnabled("PremiumVanish")) {
// use api
}

The next step is to add the SuperVanish.jar file to your java buildpath if you are using an IDE.

Finally you can use the static methods of the VanishAPI class:

// Imports
import de.myzelyam.api.vanish.VanishAPI;
import de.myzelyam.api.vanish.PlayerHideEvent;

public void testTheApi(Player player, Player player2) {
    // A list of all ONLINE vanished players
    List<UUID> invisiblePlayers = VanishAPI.getInvisiblePlayers();
    // Returns a list of the uuids of ALL vanished players, online AND offline
    // MAY INVOLVE A MYSQL-QUERY, so don't use it too often or use it on a different thread!
    List<UUID> allInvisiblePlayers = VanishAPI.getAllInvisiblePlayers();
    // Hide a player
    VanishAPI.hidePlayer(player);
    // Show a player
    VanishAPI.showPlayer(player);
    // Returns true if player is allowed to see player2
    boolean canSee = VanishAPI.canSee(player, player2);
    // Returns true if a player is invisible
    boolean isVanished = VanishAPI.isInvisible(player);
}

If you want to prevent vanishing/reappearing you can use events.
There are two events, PlayerHideEvent and PlayerShowEvent.
PlayerHideEvent triggers when a player vanishs and is online.
PlayerShowEvent triggers when a player reappears and is online.
Example:

@EventHandler
public void onVanish(PlayerHideEvent e) {
    Player p = e.getPlayer();
    if (p.getName().equalsIgnoreCase("Notch")) {
        e.setCancelled(true);
    }
}

IMPORTANT: ALWAYS use MONITOR event priority to get the final outcome of the event but NEVER use MONITOR if you are trying to change the outcome.

   <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>

    <dependencies>
        <!-- SuperVanish -->
        <dependency>
            <groupId>com.github.LeonMangler</groupId>
            <artifactId>SuperVanish</artifactId>
            <version>6.2.6-4</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>