Add placeholders for vanish stuff

Author: RhythmicSys

README.md

@@ -1,6 +1,6 @@
 # SimpleVanish
 
-Hide a player to make them appear offline. 
+Hide a player to make them appear offline.
 
 ## Commands
 
@@ -12,9 +12,9 @@ Hide a player to make them appear offline.
 ### `/fake` | Sends a fake join or leave message
 
 - **Permission:** `vanish.command.fake`
-- **Arguments:** 
-  - Player: `/fake <leave|join>`
-  - Console: `/fake <leave|join> <player>`
+- **Arguments:**
+    - Player: `/fake <leave|join>`
+    - Console: `/fake <leave|join> <player>`
 
 ### `/vanish-reload` | Reloads the plugin configuration and messages.
 
@@ -64,9 +64,9 @@ Hide a player to make them appear offline.
 
 ### Command Permissions
 
-| Permission                  | What it do                         |
-|-----------------------------|------------------------------------|
-| `vanish.command`            | Use the `/vanish` command.         |
+| Permission            | What it do                                     |
+|-----------------------|------------------------------------------------|
+| `vanish.command`      | Use the `/vanish` command.                     |
 | `vanish.command.fake` | Use the `/fake leave` and `/fake join`command. |
 
 ### Settings Permissions
@@ -160,3 +160,14 @@ Hide a player to make them appear offline.
 | `remind-while-vanished`      | Boolean | Toggles reminders for vanished players. |
 | `remind-interval-in-seconds` | Boolean | Interval for vanish reminders.          |
 
+## Placeholder API placeholders
+
+If you are using Placeholder API, there are a few placeholders you can use from this plugin:
+
+| Placeholder                       | What it do                                                                           |
+|:----------------------------------|:-------------------------------------------------------------------------------------|
+| `%simplevanish_total-online%`     | Total players online on this server, vanished and non-vanished                       |
+| `%simplevanish_current-vanished%` | Number of players that are currently vanished on this server                         |
+| `%simplevanish_current-visible%`  | Number of visible players that are currently on this server                          |
+| `%simplevanish_is-vanished%`      | Whether this user is currently in vanish mode or not                                 |
+| `%simplevanish_vanished-prefix%`  | A prefix that shows the text from `view.placeholder-format` when someone is vanished |

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>simplexity</groupId>
     <artifactId>SimpleVanish</artifactId>
-    <version>1.0.1</version>
+    <version>1.1.0</version>
     <packaging>jar</packaging>
 
     <name>SimpleVanish</name>

src/main/java/simplexity/simplevanish/SimpleVanish.java

@@ -1,5 +1,6 @@
 package simplexity.simplevanish;
 
+import me.clip.placeholderapi.expansion.PlaceholderExpansion;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import org.bukkit.plugin.java.JavaPlugin;
 import simplexity.simplevanish.commands.FakeCommand;
@@ -19,6 +20,7 @@
 import simplexity.simplevanish.commands.settings.VanishNotifications;
 import simplexity.simplevanish.config.ConfigHandler;
 import simplexity.simplevanish.config.Message;
+import simplexity.simplevanish.hooks.VanishPlaceholders;
 import simplexity.simplevanish.listeners.AttackListener;
 import simplexity.simplevanish.listeners.BlockBreakListener;
 import simplexity.simplevanish.listeners.BlockInteractListener;
@@ -106,6 +108,7 @@ private void registerListeners() {
     private void checkForPapi() {
         if (this.getServer().getPluginManager().getPlugin("PlaceholderAPI") != null) {
             papiEnabled = true;
+            new VanishPlaceholders().register();
         } else {
             this.getLogger().info("You do not have PlaceholderAPI loaded on your server. Any PlaceholderAPI placeholders used in this plugin's messages, will not work.");
         }

src/main/java/simplexity/simplevanish/config/Message.java

@@ -24,6 +24,7 @@ public enum Message {
     VIEW_USER_LEFT_SILENTLY("view.user-left-silently", "<gray> <username> left silently</gray>"),
     VIEW_USER_VANISHED("view.user-vanished", "<gray> <username> vanished</gray>"),
     VIEW_USER_UNVANISHED("view.user-unvanished", "<gray> <username> unvanished</gray>"),
+    VIEW_PLACEHOLDER_FORMAT("view.placeholder-format", "<gray><i>[Hidden] </i></gray>"),
     VIEW_TABLIST_FORMAT("view.tablist-format", "<gray><i>[Hidden] <username></i></gray>"),
     MESSAGE_FAKE_JOIN("message.fake-join", "<yellow><lang:multiplayer.player.joined:<username>></yellow>"),
     MESSAGE_FAKE_LEAVE("message.fake-leave", "<yellow><lang:multiplayer.player.left:<username>></yellow>"),

src/main/java/simplexity/simplevanish/hooks/VanishPlaceholders.java

@@ -0,0 +1,66 @@
+package simplexity.simplevanish.hooks;
+
+import me.clip.placeholderapi.expansion.PlaceholderExpansion;
+import org.bukkit.Bukkit;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+import simplexity.simplevanish.config.Message;
+import simplexity.simplevanish.saving.Cache;
+
+public class VanishPlaceholders extends PlaceholderExpansion {
+
+    public VanishPlaceholders() {
+    }
+
+    @Override
+    public @NotNull String getIdentifier() {
+        return "simplevanish";
+    }
+
+    @Override
+    public @NotNull String getAuthor() {
+        return "Simplexity";
+    }
+
+    @Override
+    public @NotNull String getVersion() {
+        return "1.0.0";
+    }
+
+    @Override
+    public boolean persist() {
+        return true;
+    }
+
+    @Override
+    public String onRequest(OfflinePlayer player, @NotNull String params) {
+        if (params.equalsIgnoreCase("total-online")) {
+            int count = Bukkit.getServer().getOnlinePlayers().size();
+            return String.valueOf(count);
+        }
+        if (params.equalsIgnoreCase("current-vanished")) {
+            int count = Cache.getVanishedPlayers().size();
+            return String.valueOf(count);
+        }
+        if (params.equalsIgnoreCase("current-visible")) {
+            int vanishedCount = Cache.getVanishedPlayers().size();
+            int onlineCount = Bukkit.getOnlinePlayers().size();
+            int visibleCount = onlineCount - vanishedCount;
+            return String.valueOf(visibleCount);
+        }
+        if (!(player instanceof Player onlinePlayer)) return null;
+        boolean isVanished = Cache.getVanishedPlayers().contains(onlinePlayer);
+        if (params.equalsIgnoreCase("is-vanished")) {
+            return String.valueOf(isVanished);
+        }
+        if (params.equalsIgnoreCase("vanished-prefix")) {
+            if (isVanished) {
+                return Message.VIEW_PLACEHOLDER_FORMAT.getMessage();
+            } else {
+                return "";
+            }
+        }
+        return null;
+    }
+}

src/main/java/simplexity/simplevanish/listeners/PingServerListener.java

@@ -11,6 +11,7 @@
 import java.util.List;
 
 public class PingServerListener implements Listener {
+
     @EventHandler
     public void onPingServer(PaperServerListPingEvent pingEvent) {
         if (Cache.getVanishedPlayers().isEmpty()) return;