feat: Addition of Command Usages

AdvancedTeleport-Bukkit/build.gradle.kts

@@ -190,6 +190,10 @@ tasks {
     }
 }
 
+tasks.shadowJar {
+    from(tasks.slimJar.get().outputDirectory)
+}
+
 // Lead development use only.
 modrinth {
     token.set(System.getenv("MODRINTH_TOKEN"))

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/CoreCommand.java

@@ -2,6 +2,7 @@
 
 import io.github.niestrat99.advancedteleport.config.CustomMessages;
 import io.github.niestrat99.advancedteleport.managers.CommandManager;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 
 import org.bukkit.command.Command;
 import org.bukkit.command.CommandSender;
@@ -37,11 +38,15 @@ public boolean onCommand(
             help.onCommand(sender, cmd, s, args);
             return true;
         }
-        if (sender.hasPermission("at.member.core." + command)
-                || sender.hasPermission("at.admin.core." + command)) {
-            CommandManager.subcommands
+        if (sender.hasPermission("at.member.core." + command) || sender.hasPermission("at.admin.core." + command)) {
+            boolean correctUse = CommandManager.subcommands
                     .get(command)
                     .onCommand(sender, cmd, s, Arrays.copyOfRange(args, 1, args.length));
+
+            if (!correctUse) {
+                CustomMessages.sendMessage(sender, "Error.commandUse",
+                        Placeholder.unparsed("usage", CustomMessages.asString("Usages.Subcommands." + command)));
+            }
         } else {
             CustomMessages.sendMessage(sender, "Error.noPermission");
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/ClearCacheCommand.java

@@ -67,7 +67,7 @@ public boolean onCommand(
                         CoreClass.getInstance(), () -> RTPManager.loadWorldData(world));
         CustomMessages.sendMessage(
                 sender, "Info.clearWorld", Placeholder.unparsed("world", args[0]));
-        return false;
+        return true;
     }
 
     @Override

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/ExportCommand.java

@@ -29,7 +29,7 @@ public boolean onCommand(
         // If there's no arguments contained, stop there
         if (args.length == 0) {
             CustomMessages.sendMessage(sender, "Error.noPluginSpecified");
-            return true;
+            return false;
         }
 
         // Attempt to get the plugin

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/ImportCommand.java

@@ -48,7 +48,7 @@ public boolean onCommand(
             @NotNull final String[] args) {
         if (args.length == 0) {
             CustomMessages.sendMessage(sender, "Error.noPluginSpecified");
-            return true;
+            return false;
         }
 
         final var pluginHook = getImportExportPlugin(sender, args);

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/MapCommand.java

@@ -2,6 +2,8 @@
 
 import io.github.niestrat99.advancedteleport.commands.SubATCommand;
 import io.github.niestrat99.advancedteleport.commands.core.map.*;
+import io.github.niestrat99.advancedteleport.config.CustomMessages;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 
 import org.bukkit.Bukkit;
 import org.bukkit.command.Command;
@@ -43,24 +45,30 @@ public boolean onCommand(
         // If there's no arguments, stop there
         if (args.length == 0) {
             Bukkit.dispatchCommand(sender, "at help map");
-            return false;
+            return true;
         }
 
         // Get the subcommand in question
         SubATCommand subATCommand = subMapCommands.get(args[0].toLowerCase());
         if (subATCommand == null) {
             Bukkit.dispatchCommand(sender, "at help map");
-            return false;
+            return true;
         }
 
         // Check permissions
         if (!sender.hasPermission("at.member.core.map." + args[0].toLowerCase())) {
             Bukkit.dispatchCommand(sender, "at help map");
-            return false;
+            return true;
         }
 
         // Execute
-        return subATCommand.onCommand(sender, command, s, Arrays.copyOfRange(args, 1, args.length));
+        boolean result = subATCommand.onCommand(sender, command, s, Arrays.copyOfRange(args, 1, args.length));
+
+        if (!result) {
+            CustomMessages.sendMessage(sender, "Error.commandUse",
+                    Placeholder.unparsed("usage", CustomMessages.asString("Usages.Subcommands.map." + args[0].toLowerCase())));
+        }
+        return true;
     }
 
     @Override

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/ParticlesCommand.java

@@ -67,7 +67,7 @@ public boolean onCommand(
             if (data == null) data = "default";
             String type = args[0];
             if (!types.contains(type)) {
-                return false;
+                return true;
             }
             MainConfig.get().set("waiting-particles." + type, data);
             CustomMessages.sendMessage(

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/PurgeCommand.java

@@ -123,7 +123,7 @@ public boolean onCommand(
                             CoreClass.sync);
         }
 
-        return false;
+        return true;
     }
 
     @Override

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/ShowCommand.java

@@ -9,10 +9,11 @@
 public class ShowCommand extends SubATCommand {
     @Override
     public boolean onCommand(
-            @NotNull final CommandSender sender,
-            @NotNull final Command command,
-            @NotNull final String s,
-            @NotNull final String[] args) {
-        return false;
+        @NotNull final CommandSender sender,
+        @NotNull final Command command,
+        @NotNull final String s,
+        @NotNull final String[] args
+    ) {
+        return true;
     }
 }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/core/map/AbstractMapCommand.java

@@ -52,7 +52,7 @@ public boolean onCommand(
         // If not enough arguments are specified, let the player know
         if (args.length < 3) {
             CustomMessages.sendMessage(sender, "Error.notEnoughArgs");
-            return true;
+            return false;
         }
 
         // Squish together the input
@@ -67,7 +67,7 @@ public boolean onCommand(
             case "home" -> {
                 if (args.length < 4) {
                     CustomMessages.sendMessage(sender, "Error.notEnoughArgs");
-                    return true;
+                    return false;
                 }
 
                 input = String.join(" ", Arrays.copyOfRange(args, 3, args.length));

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/home/DelHomeCommand.java

@@ -56,7 +56,10 @@ public boolean onCommand(
             } else {
                 CustomMessages.sendMessage(sender, "Error.noHomes");
             }
-        } else CustomMessages.sendMessage(sender, "Error.noHomeInput");
+        } else {
+            CustomMessages.sendMessage(sender, "Error.noHomeInput");
+            return false;
+        }
 
         return true;
     }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/home/MoveHomeCommand.java

@@ -38,6 +38,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noHomeInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/home/SetHomeCommand.java

@@ -51,6 +51,7 @@ public boolean onCommand(
                 ((ATFloodgatePlayer) atPlayer).sendSetHomeForm();
             } else {
                 CustomMessages.sendMessage(sender, "Error.noHomeInput");
+                return false;
             }
 
             return true;

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/home/SetMainHomeCommand.java

@@ -34,6 +34,7 @@ public boolean onCommand(
                 ((ATFloodgatePlayer) atPlayer).sendSetMainHomeForm();
             } else {
                 CustomMessages.sendMessage(sender, "Error.noHomeInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/spawn/MirrorSpawn.java

@@ -36,7 +36,7 @@ public boolean onCommand(
         // If no argument has been specified, stop there
         if (args.length == 0) {
             CustomMessages.sendMessage(sender, "Error.mirrorSpawnNoArguments");
-            return true;
+            return false;
         }
 
         // If just one spawn has been specified, then use the first argument as the spawn to mirror

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/spawn/RemoveSpawn.java

@@ -39,7 +39,7 @@ public boolean onCommand(
                 removingSpawn = player.getWorld().getName();
             } else {
                 CustomMessages.sendMessage(sender, "Error.removeSpawnNoArgs");
-                return true;
+                return false;
             }
         }
 

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/TpBlockCommand.java

@@ -38,6 +38,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noPlayerInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/TpHereOffline.java

@@ -29,7 +29,7 @@ public boolean onCommand(
 
         if (args.length == 0) {
             CustomMessages.sendMessage(sender, "Error.noPlayerInput");
-            return true;
+            return false;
         }
         Player target = Bukkit.getPlayer(args[0]);
         if (target == null) {

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/TpOffline.java

@@ -28,7 +28,7 @@ public boolean onCommand(
         if (!canProceed(sender)) return true;
         if (args.length == 0) {
             CustomMessages.sendMessage(sender, "Error.noPlayerInput");
-            return true;
+            return false;
         }
         Player target = Bukkit.getPlayer(args[0]);
         if (target != null) {

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/TpUnblock.java

@@ -38,6 +38,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noPlayerInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/Tpa.java

@@ -47,6 +47,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noPlayerInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/TpaHere.java

@@ -45,6 +45,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noPlayerInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/Tpo.java

@@ -38,6 +38,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noPlayerInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/teleport/TpoHere.java

@@ -37,6 +37,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noPlayerInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/warp/DeleteWarpCommand.java

@@ -43,7 +43,7 @@ public boolean onCommand(
 
             // Otherwise, tell the player to enter a warp.
             CustomMessages.sendMessage(sender, "Error.noWarpInput");
-            return true;
+            return false;
         }
 
         // Get the warp to be deleted.
@@ -62,6 +62,7 @@ public boolean onCommand(
                                             Placeholder.unparsed("warp", args[0])));
         } else {
             CustomMessages.sendMessage(sender, "Error.noWarpInput");
+            return false;
         }
         return true;
     }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/warp/MoveWarpCommand.java

@@ -42,6 +42,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noWarpInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/warp/SetWarpCommand.java

@@ -37,6 +37,7 @@ public boolean onCommand(
                 ((ATFloodgatePlayer) atPlayer).sendSetWarpForm();
             } else {
                 CustomMessages.sendMessage(sender, "Error.noWarpInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/commands/warp/WarpCommand.java

@@ -43,6 +43,7 @@ public boolean onCommand(
                 }
             } else {
                 CustomMessages.sendMessage(sender, "Error.noWarpInput");
+                return false;
             }
             return true;
         }

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/config/CustomMessages.java

@@ -402,6 +402,9 @@ If you prefer to use the Legacy Code format (i.e. &a, &b, etc.) then you can sti
                 "Error.randomLocFailed",
                 "<prefix> <gray>Sorry, we couldn't find a location to teleport you to :(");
 
+        addDefault("Error.commandUse", "<aqua>Usage: <gray><usage>");
+        addDefault("Error.rtpManagerNotUsed", "<prefix> <gray>The RTP-Cache is not being used on the server.");
+
         makeSectionLenient("Info");
         addDefault("Info.tpOff", "<prefix> <gray>Successfully disabled teleport requests!");
         addDefault("Info.tpOn", "<prefix> <gray>Successfully enabled teleport requests!");
@@ -606,6 +609,9 @@ If you prefer to use the Legacy Code format (i.e. &a, &b, etc.) then you can sti
                 "Info.mirrorSpawnSame",
                 "<prefix> <gray>The spawns for <aqua><from></aqua> and <aqua><spawn></aqua> already to go the same place! Don't worry :)");
 
+        addDefault("Info.clearEverything", "<prefix> <gray>The RTP-Cache has been cleared.");
+        addDefault("Info.clearWorld", "<prefix> <gray>Cache for world <aqua><world></aqua> has been cleared.");
+
         addDefault("Tooltip.homes", "<prefix> <gray>Teleports you to your home: <aqua><home>");
         addDefault("Tooltip.warps", "<prefix> <gray>Teleports you to warp: <aqua><warp>");
         addDefault(

AdvancedTeleport-Bukkit/src/main/java/io/github/niestrat99/advancedteleport/managers/CommandManager.java

@@ -9,13 +9,12 @@
 import io.github.niestrat99.advancedteleport.commands.spawn.*;
 import io.github.niestrat99.advancedteleport.commands.teleport.*;
 import io.github.niestrat99.advancedteleport.commands.warp.*;
+import io.github.niestrat99.advancedteleport.config.CustomMessages;
 import io.github.niestrat99.advancedteleport.config.MainConfig;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 
 import org.bukkit.Bukkit;
-import org.bukkit.command.Command;
-import org.bukkit.command.CommandMap;
-import org.bukkit.command.PluginCommand;
-import org.bukkit.command.SimpleCommandMap;
+import org.bukkit.command.*;
 
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
@@ -162,7 +161,15 @@ private static void register(String name, ATCommand atCommand) {
         }
 
         if (command.getExecutor() != atCommand) {
-            command.setExecutor(atCommand);
+            CommandExecutor usageExecutor = (sender, cmd, label, args) -> {
+                boolean result = atCommand.onCommand(sender, cmd, label, args);
+                if (!result) {
+                    CustomMessages.sendMessage(sender, "Error.commandUse",
+                            Placeholder.unparsed("usage", CustomMessages.asString("Usages." + name)));
+                }
+                return true;
+            };
+            command.setExecutor(usageExecutor);
             command.setTabCompleter(atCommand);
         }
 

README.md

@@ -24,6 +24,8 @@ Advanced Teleport is a rapidly growing plugin that is not only increasing sharpl
 ## Installation/Cloning
 As of currently, Advanced Teleport uses Gradle to manage its dependencies.
 
-The Gradle command used to build the plugin is `gradle shadowJar` and is done under the AdvancedTeleport-Bukkit module.
+The Gradle command used to build the plugin is `gradle slimJar` and is done under the AdvancedTeleport-Bukkit module.
+
+> NOTE: Due to a bug with SlimJar you should try building twice when updating dependencies or building for the first time, or necessary files will not be installed.