fixed plugin.yml to use simplenick.nick.set as the permission for commands, implemented permission check on nick, added /help output

Author: RhythmicSys

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>adhdmc</groupId>
     <artifactId>SimpleNicks</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.2</version>
     <packaging>jar</packaging>
 
     <name>SimpleNicks</name>

src/main/java/adhdmc/simplenicks/commands/subcommands/Help.java

@@ -1,19 +1,27 @@
 package adhdmc.simplenicks.commands.subcommands;
 
+import adhdmc.simplenicks.SimpleNicks;
 import adhdmc.simplenicks.commands.SubCommand;
+import adhdmc.simplenicks.config.Locale;
 import adhdmc.simplenicks.util.SimpleNickPermission;
+import net.kyori.adventure.text.minimessage.MiniMessage;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 import org.bukkit.command.CommandSender;
 
 import java.util.List;
 
 public class Help extends SubCommand {
+    MiniMessage miniMessage = SimpleNicks.getMiniMessage();
     public Help() {
         super("help", "Help command for SimpleNicks", "/nick help", SimpleNickPermission.NICK_COMMAND);
     }
 
     @Override
     public void execute(CommandSender sender, String[] args) {
-        sender.sendMessage("<gray>PLACEHOLDER: HELP COMMAND");
+        sender.sendMessage(miniMessage.deserialize(Locale.Message.HELP_BASE.getMessage(), Placeholder.parsed("prefix", Locale.Message.PREFIX.getMessage())));
+        sender.sendMessage(miniMessage.deserialize(Locale.Message.HELP_SET.getMessage()));
+        sender.sendMessage(miniMessage.deserialize(Locale.Message.HELP_RESET.getMessage()));
+        sender.sendMessage(miniMessage.deserialize(Locale.Message.HELP_MINIMESSAGE.getMessage()));
     }
 
     @Override

src/main/java/adhdmc/simplenicks/commands/subcommands/Set.java

@@ -8,6 +8,7 @@
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
+import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
 import org.bukkit.NamespacedKey;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
@@ -85,7 +86,20 @@ public void execute(CommandSender sender, String[] args) {
         // Saves to PDC
         //temporary saving option
         String nickToSave = args[0];
-        Component nickname = miniMessage.deserialize(args[0]);
+        //TODO: config option for admin settings to be restricted to their own permissions
+        Component nickname = null;
+        if (sender.hasPermission(SimpleNickPermission.NICK_ADMIN.getPermission())) {
+            nickname = miniMessage.deserialize(args[0]);
+        } else {
+            Component fullyParsed = miniMessage.deserialize(args[0]);
+            Component permissionParsed = parseMessageContent(player, args[0]);
+            if (fullyParsed.equals(permissionParsed)){
+                nickname = permissionParsed;
+            } else {
+                sender.sendMessage(miniMessage.deserialize(Message.INVALID_TAGS.getMessage(), Placeholder.parsed("prefix", Message.PREFIX.getMessage())));
+                return;
+            }
+        }
         player.getPersistentDataContainer().set(nickNameSave, PersistentDataType.STRING, nickToSave);
         //---
         player.displayName(nickname);
@@ -118,4 +132,17 @@ private void addValidTabOption(CommandSender sender, String arg, String option,
             if (option.startsWith(arg)) list.add(option);
         }
     }
+    //Stolen from https://github.com/YouHaveTrouble/JustChat/blob/master/src/main/java/me/youhavetrouble/justchat/JustChatListener.java#L78
+    private Component parseMessageContent(Player player, String rawMessage) {
+        TagResolver.Builder tagResolver = TagResolver.builder();
+
+        for(SimpleNickPermission perm : SimpleNickPermission.values()) {
+            if (player.hasPermission(perm.getPermission()) && perm.getTagResolver() != null) {
+                tagResolver.resolver(perm.getTagResolver());
+            }
+        }
+        MiniMessage nameParser = MiniMessage.builder().tags(tagResolver.build()).build();
+        return nameParser.deserialize(rawMessage);
+    }
+
 }

src/main/java/adhdmc/simplenicks/config/Locale.java

@@ -28,6 +28,7 @@ public enum Message {
         INVALID_PLAYER("<prefix><red>Invalid player specified"),
         INVALID_NICK_REGEX("<prefix><red>Not a valid nickname, must follow regex: " + Set.NICKNAME_REGEX),
         INVALID_NICK_TOO_LONG("<prefix><red>Nickname is too long, must be <=" + Set.MAX_NICKNAME_LENGTH),
+        INVALID_TAGS("<prefix><red>You have used a color or formatting tag you do not have permission to use. Please try again"),
         //plugin messages
         PREFIX("<aqua>SimpleNicks <white>» "),
         NICK_CHANGED_SELF("<prefix><green>Changed your own nickname to <nickname>!"),
@@ -36,6 +37,10 @@ public enum Message {
         NICK_RESET_OTHER("<prefix><green>Reset <username>'s nickname."),
         //other
         VERSION("<prefix>yes"),
+        HELP_BASE("<prefix><green>--------"),
+        HELP_SET("<aqua>· <yellow>Setting a nickname: \n   <gray>/nick set <nickname>"),
+        HELP_RESET("<aqua>· <yellow>removing a nickname: \n   <gray>/nick reset"),
+        HELP_MINIMESSAGE("<aqua>· <yellow>Formatting: \n   <gray>This plugin uses minimessage formatting. You can find a format viewer <aqua><u><click:open_url:'https://webui.adventure.kyori.net/'>here</click></u></aqua>"),
         CONFIG_RELOADED("<prefix><gold>SimpleNicks config and locale reloaded");
 
         String message;
@@ -130,7 +135,12 @@ public void setLocaleDefaults() {
         locale.addDefault("invalid-player", "<prefix><red>Invalid player specified");
         locale.addDefault("invalid-nick-regex", "<prefix><red>Not a valid nickname, must follow regex: ");
         locale.addDefault("invalid-nick-too-long", "<prefix><red>Nickname is too long, must be <=");
+        locale.addDefault("invalid-tags", "<prefix><red>You have used a color or formatting tag you do not have permission to use. Please try again");
         locale.addDefault("prefix", "<aqua>SimpleNicks <white>» ");
+        locale.addDefault("help-base", "<prefix><green>--------");
+        locale.addDefault("help-set","<aqua>· <yellow>Setting a nickname: \n   <gray>/nick set <nickname>");
+        locale.addDefault("help-reset","<aqua>· <yellow>removing a nickname: \n   <gray>/nick reset");
+        locale.addDefault("help-minimessage", "<aqua>· <yellow>Formatting: \n   <gray>This plugin uses minimessage formatting. You can find a format viewer <aqua><u><click:open_url:'https://webui.adventure.kyori.net/'>here</click></u></aqua>");
         locale.addDefault("config-reload", "<prefix><gold>SimpleNicks config and locale reloaded");
         locale.addDefault("nick-changed-self", "<prefix><green>Changed your own nickname to <nickname>!");
         locale.addDefault("nick-changed-other", "<prefix><green>Changed <username>'s nickname to <nickname>");

src/main/java/adhdmc/simplenicks/util/SimpleNickPermission.java

@@ -15,11 +15,11 @@ public enum SimpleNickPermission {
     NICK_BOLD("simplenick.nick.format.bold", StandardTags.decorations(TextDecoration.BOLD)),
     NICK_OBFUSCATED("simplenick.nick.format.obfuscated", StandardTags.decorations(TextDecoration.OBFUSCATED)),
     //Command Perms
-    NICK_COMMAND("simplenick.nick.set"),
-    NICK_ADMIN("simplenick.admin"),
-    NICK_RESET("simplenick.nick.reset"),
-    NICK_RELOAD("simplenick.reload"),
-    NICK_USERNAME_BYPASS("simplenick.usernamebypass");
+    NICK_COMMAND("simplenick.nick.set", null),
+    NICK_ADMIN("simplenick.admin", null),
+    NICK_RESET("simplenick.nick.reset", null),
+    NICK_RELOAD("simplenick.reload", null),
+    NICK_USERNAME_BYPASS("simplenick.usernamebypass", null);
 
     private final String permission;
     private final TagResolver resolver;

src/main/resources/plugin.yml

@@ -8,7 +8,7 @@ commands:
     description: "Base command for SimpleNicks, Admin permission required to alter other's names."
     aliases: [simplenicks, simplenick, snick]
     usage: "Usage: /nick [set|reset|help|reload] <name> [player]"
-    permission: simplenick.nick
+    permission: simplenick.nick.set
 permissions:
   simplenick.admin:
     description: allows user to set and reset other players' nicknames