Add shadow muting

Author: RhythmicSys

README.md

@@ -13,6 +13,8 @@ A simple plugin that allows freezing and unfreezing players.
   - Prevents this user from being frozen
 - spf.reload:
   - Allows this user to reload the configuration
+- spf.chatspy
+  - Allows this user to see the chat of frozen players, if chat behavior is set to 2
 
 ### Commands:
 - /freeze <player>
@@ -21,6 +23,8 @@ A simple plugin that allows freezing and unfreezing players.
   - unfreezes a frozen player
 - /spfreload 
   - Reloads the configuration
+- /fspy
+  - Toggles visibility of the chat of frozen players, if chat behavior is set to 2
 
 ### Default configuration
 
@@ -37,10 +41,14 @@ freeze-dismount: true
 freeze-flight: false
 # Should the user be invulnerable while they're frozen? (prevents issues like drowning if frozen while underwater)
 freeze-invulnerability: true
+# Chat behavior
+# 0 = Chat as normal, no change
+# 1 = Shadow mute, they don't see a change in their chat, however only staff can see their messages
+# 2 = Full mute. They cannot send messages and get an error when they attempt to
+chat-behavior: 2
 # Which things should be prevented when someone is frozen?
 prevent-movement: true
 prevent-interact: true
-prevent-chat: true
 prevent-xp-pickup: true
 prevent-item-pickup: true
 prevent-item-drop: true
@@ -65,6 +73,10 @@ cannot-use-command: "You are frozen and cannot use that command"
 login-message: "<red><bold>[NOTICE]</bold></red> <gray>You were frozen during a previous session. You cannot move, interact, or chat"
 login-notif: "<dark_gray><bold><name></bold></dark_gray> <gray>has logged in. They were frozen during a previous session."
 login-notif-now-unfrozen: "<dark_gray><bold><name></bold></dark_gray> <gray>has logged in. They were frozen during a previous session. They will now be unfrozen."
+shadow-mute-format: "<dark_gray>[Frozen]</dark_gray> <gray><player>: <message></gray>"
+freeze-spy-enabled: "<green>Freeze Spy has been toggled <bold><yellow>On</yellow></bold>!</green>"
+freeze-spy-disabled: "<grey>Freeze Spy has been toggled <bold><red>Off</red></bold>!</grey>"
 cannot-be-frozen: "<red>That player cannot be frozen!</red>"
 not-frozen: "<red>That player is not frozen!</red>"
+only-player: "<red>Sorry! Only a player can run that command</red>"
 ```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>simplexity</groupId>
     <artifactId>SimplePlayerFreeze</artifactId>
-    <version>0.1.0</version>
+    <version>0.2.0</version>
     <packaging>jar</packaging>
 
     <name>SimplePlayerFreeze</name>

src/main/java/simplexity/simpleplayerfreeze/ConfigSettings.java

@@ -6,7 +6,6 @@
 import java.util.List;
 
 public class ConfigSettings {
-    
     public static String prefix = "";
     public static String commandErrorMessage = "";
     public static String cannotChat = "";
@@ -22,6 +21,10 @@ public class ConfigSettings {
     public static String loginNotif = "";
     public static String cannotBeFrozen = "";
     public static String notFrozen = "";
+    public static String shadowMuteFormat = "";
+    public static String freezeSpyEnabled = "";
+    public static String freezeSpyDisabled = "";
+    public static String onlyPlayer = "";
     public static boolean freezePersist;
     public static boolean freezeGlow;
     public static boolean freezeDismount;
@@ -30,20 +33,21 @@ public class ConfigSettings {
     public static boolean preventMovement;
     public static boolean preventInteract;
     public static boolean preventCrafting;
-    public static boolean preventChat;
     public static boolean preventXPPickup;
     public static boolean preventItemPickup;
     public static boolean preventItemDrop;
     public static boolean preventItemUse;
     public static boolean preventHotbarSwitch;
     public static boolean preventInventoryInteraction;
     public static boolean preventCommands;
+    public static int chatBehavior;
     public static ArrayList<String> whitelistedCommandList = new ArrayList<>();
 
     public static void reloadConfigSettings(){
         reloadConfigBooleans();
         reloadMessages();
         reloadConfigCommands();
+        reloadConfigIntegers();
     }
     private static void reloadMessages() {
         FileConfiguration config = SimplePlayerFreeze.simplePlayerFreeze.getConfig();
@@ -62,7 +66,10 @@ private static void reloadMessages() {
         loginNotif = config.getString("login-notif");
         cannotBeFrozen = config.getString("cannot-be-frozen");
         notFrozen = config.getString("not-frozen");
-        preventCommands = config.getBoolean("prevent-commands");
+        shadowMuteFormat = config.getString("shadow-mute-format");
+        freezeSpyEnabled = config.getString("freeze-spy-enabled");
+        freezeSpyDisabled = config.getString("freeze-spy-disabled");
+        onlyPlayer = config.getString("only-player");
     }
 
     private static void reloadConfigBooleans() {
@@ -75,12 +82,12 @@ private static void reloadConfigBooleans() {
         preventMovement = config.getBoolean("prevent-movement");
         preventInteract = config.getBoolean("prevent-interact");
         preventCrafting = config.getBoolean("prevent-crafting");
-        preventChat = config.getBoolean("prevent-chat");
         preventXPPickup = config.getBoolean("prevent-xp-pickup");
         preventItemPickup = config.getBoolean("prevent-item-pickup");
         preventItemDrop = config.getBoolean("prevent-item-drop");
         preventItemUse = config.getBoolean("prevent-item-use");
         preventHotbarSwitch = config.getBoolean("prevent-hotbar-switch");
+        preventCommands = config.getBoolean("prevent-commands");
         preventInventoryInteraction = config.getBoolean("prevent-inventory-interaction");
     }
 
@@ -90,4 +97,13 @@ private static void reloadConfigCommands() {
         List<String> commandList = config.getStringList("whitelisted-commands");
         whitelistedCommandList.addAll(commandList);
     }
+    
+    private static void reloadConfigIntegers() {
+        FileConfiguration config = SimplePlayerFreeze.simplePlayerFreeze.getConfig();
+        chatBehavior = config.getInt("chat-behavior");
+        if (!( 0 <= chatBehavior && chatBehavior <= 2)) {
+            SimplePlayerFreeze.simplePlayerFreeze.getLogger().warning("Chat behavior value is invalid. Defaulting to 0.");
+            chatBehavior = 2;
+        }
+    }
 }

src/main/java/simplexity/simpleplayerfreeze/SimplePlayerFreeze.java

@@ -1,8 +1,10 @@
 package simplexity.simpleplayerfreeze;
 
+import org.bukkit.Server;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import simplexity.simpleplayerfreeze.commands.FreezePlayer;
+import simplexity.simpleplayerfreeze.commands.FreezeSpy;
 import simplexity.simpleplayerfreeze.commands.ReloadConfig;
 import simplexity.simpleplayerfreeze.commands.UnfreezePlayer;
 import simplexity.simpleplayerfreeze.listeners.*;
@@ -11,14 +13,17 @@
 
 public final class SimplePlayerFreeze extends JavaPlugin {
     public static Plugin simplePlayerFreeze;
+    public static Server server;
 
     @Override
     public void onEnable() {
         simplePlayerFreeze = this;
+        server = getServer();
         //Register the commands for the plugin, this is supposedly the best way to do commands now
         getServer().getCommandMap().register(Util.namespace, new FreezePlayer("freeze", "Freezes a player in place and prevents them from using normal things", "/freeze <player>", List.of("cease")));
         getServer().getCommandMap().register(Util.namespace, new UnfreezePlayer("unfreeze", "Unfreezes a player and allows them to use normal things", "/unfreeze <player>", List.of("resume")));
         getServer().getCommandMap().register(Util.namespace, new ReloadConfig("freezereload", " reloads the config", "/freezereload", List.of("simpleplayerfreezereload", "spfreload")));
+        getServer().getCommandMap().register(Util.namespace, new FreezeSpy("freezespy", "Toggles the visibility of frozen players' messages", "/freezespy", List.of("fspy", "spfspy")));
         registerListeners();
         this.saveDefaultConfig();
         this.reloadConfig();

src/main/java/simplexity/simpleplayerfreeze/Util.java

@@ -12,10 +12,12 @@ public class Util {
     public static String namespace = "simpleplayerfreeze";
     public static NamespacedKey isFrozenKey = new NamespacedKey(namespace, "isfrozen");
     public static NamespacedKey previouslyHadFlyPerms = new NamespacedKey(namespace, "previousflyperms");
+    public static NamespacedKey freezeSpyDisabled = new NamespacedKey(namespace, "freezespy");
     public static Permission freezePermission = new Permission("spf.freeze");
     public static Permission unfreezePermission = new Permission("spf.unfreeze");
     public static Permission freezeBypassPermission = new Permission("spf.bypass");
     public static Permission freezeNotify = new Permission("spf.notify");
+    public static Permission freezeChatSpy = new Permission("spf.chatspy");
     public static Permission reloadPermission = new Permission("spf.reload");
 
 

src/main/java/simplexity/simpleplayerfreeze/commands/FreezePlayer.java

@@ -37,7 +37,6 @@ public boolean execute(@NotNull CommandSender sender, @NotNull String s, @NotNul
         } else if (player.hasPermission(Util.freezeBypassPermission)) {
             sender.sendRichMessage(ConfigSettings.prefix + ConfigSettings.cannotBeFrozen);
             return false;
-            
         } else if (Util.isFrozen(player) && sender.hasPermission(Util.unfreezePermission)) {
             FreezeFunctionality.setUnfrozen(player);
             sender.sendMessage(Util.miniMessage.deserialize((ConfigSettings.prefix + ConfigSettings.unfreezeMessage),

src/main/java/simplexity/simpleplayerfreeze/commands/FreezeSpy.java

@@ -0,0 +1,45 @@
+package simplexity.simpleplayerfreeze.commands;
+
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.bukkit.persistence.PersistentDataType;
+import org.jetbrains.annotations.NotNull;
+import simplexity.simpleplayerfreeze.ConfigSettings;
+import simplexity.simpleplayerfreeze.Util;
+import simplexity.simpleplayerfreeze.listeners.JoinListener;
+
+import java.util.List;
+
+public class FreezeSpy extends Command {
+    
+    public FreezeSpy(@NotNull String name, @NotNull String description, @NotNull String usageMessage, @NotNull List<String> aliases) {
+        super(name, description, usageMessage, aliases);
+    }
+    
+    @Override
+    public boolean execute(@NotNull CommandSender sender, @NotNull String s, @NotNull String[] strings) {
+        if (!sender.hasPermission(Util.freezeChatSpy)) {
+            sender.sendRichMessage(ConfigSettings.noPermission);
+            return false;
+        }
+        if (!(sender instanceof Player player)) {
+            sender.sendRichMessage(ConfigSettings.onlyPlayer);
+            return false;
+        }
+        toggleSpy(player);
+        return true;
+    }
+    
+    private void toggleSpy(Player player) {
+        if (!player.getPersistentDataContainer().getOrDefault(Util.freezeSpyDisabled, PersistentDataType.BOOLEAN, false)) {
+            player.getPersistentDataContainer().set(Util.freezeSpyDisabled, PersistentDataType.BOOLEAN, true);
+            player.sendRichMessage(ConfigSettings.prefix + ConfigSettings.freezeSpyDisabled);
+            JoinListener.spyList.remove(player);
+        } else {
+            player.getPersistentDataContainer().set(Util.freezeSpyDisabled, PersistentDataType.BOOLEAN, false);
+            player.sendRichMessage(ConfigSettings.prefix + ConfigSettings.freezeSpyEnabled);
+            JoinListener.spyList.add(player);
+        }
+    }
+}

src/main/java/simplexity/simpleplayerfreeze/listeners/ChatListener.java

@@ -1,19 +1,45 @@
 package simplexity.simpleplayerfreeze.listeners;
 
 import io.papermc.paper.event.player.AsyncChatEvent;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
+import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
 import simplexity.simpleplayerfreeze.ConfigSettings;
+import simplexity.simpleplayerfreeze.SimplePlayerFreeze;
 import simplexity.simpleplayerfreeze.Util;
 
 public class ChatListener implements Listener {
+    
     @EventHandler
     public void onChat(AsyncChatEvent chatEvent) {
-        if (!ConfigSettings.preventChat) return;
-        if (Util.isFrozen(chatEvent.getPlayer())) {
-            chatEvent.setCancelled(true);
-            chatEvent.getPlayer().sendRichMessage(ConfigSettings.cannotChat);
+        if (!(ConfigSettings.chatBehavior == 1 || ConfigSettings.chatBehavior == 2)) return;
+        switch (ConfigSettings.chatBehavior) {
+            case 1:
+                if (Util.isFrozen(chatEvent.getPlayer())) {
+                    chatEvent.setCancelled(true);
+                    chatEvent.getPlayer().sendRichMessage(ConfigSettings.cannotChat);
+                }
+                break;
+            case 2:
+                if (!Util.isFrozen(chatEvent.getPlayer())) return;
+                Component message = chatEvent.message();
+                chatEvent.viewers().clear();
+                chatEvent.viewers().add(chatEvent.getPlayer());
+                for (Player player : JoinListener.spyList) {
+                    player.sendMessage(Util.miniMessage.deserialize(
+                            ConfigSettings.shadowMuteFormat,
+                            Placeholder.component("player", chatEvent.getPlayer().displayName()),
+                            Placeholder.component("message", message)));
+                }
+                SimplePlayerFreeze.server.getConsoleSender().sendMessage(Util.miniMessage.deserialize(
+                        ConfigSettings.shadowMuteFormat,
+                        Placeholder.component("player", chatEvent.getPlayer().displayName()),
+                        Placeholder.component("message", message)));
+                break;
         }
+        
     }
-
+    
 }

src/main/java/simplexity/simpleplayerfreeze/listeners/JoinListener.java

@@ -6,6 +6,7 @@
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerJoinEvent;
 import simplexity.simpleplayerfreeze.ConfigSettings;
+import simplexity.simpleplayerfreeze.SimplePlayerFreeze;
 import simplexity.simpleplayerfreeze.Util;
 import simplexity.simpleplayerfreeze.freeze.FreezeFunctionality;
 
@@ -14,19 +15,25 @@
 public class JoinListener implements Listener {
 
     public static ArrayList<Player> notifyList = new ArrayList<>();
+    public static ArrayList<Player> spyList = new ArrayList<>();
 
     @EventHandler
     public void onJoin(PlayerJoinEvent joinEvent) {
         Player player = joinEvent.getPlayer();
         if (player.hasPermission(Util.freezeNotify)) {
             notifyList.add(player);
         }
+        if (player.hasPermission(Util.freezeChatSpy)) {
+            spyList.add(player);
+        }
         if (Util.isFrozen(player) && ConfigSettings.freezePersist) {
             FreezeFunctionality.setFrozen(player);
             for (Player playerNotif : notifyList) {
                 playerNotif.sendMessage(Util.miniMessage.deserialize(
                         (ConfigSettings.prefix + ConfigSettings.loginNotif), Placeholder.component("name", player.displayName())));
             }
+            SimplePlayerFreeze.server.getConsoleSender().sendMessage(Util.miniMessage.deserialize(
+                    (ConfigSettings.prefix + ConfigSettings.loginNotif), Placeholder.component("name", player.displayName())));
         } else if (Util.isFrozen(player)) {
             FreezeFunctionality.setUnfrozen(player);
             for (Player playerNotif : notifyList) {

src/main/java/simplexity/simpleplayerfreeze/listeners/LeaveListener.java

@@ -9,6 +9,7 @@ public class LeaveListener implements Listener {
     @EventHandler
     public void onLeave(org.bukkit.event.player.PlayerQuitEvent event) {
         JoinListener.notifyList.remove(event.getPlayer());
+        JoinListener.spyList.remove(event.getPlayer());
     }
 
 }