match in-game descriptions with readme

TheNextLvl-net · Apr 21, 2024 · 0ab264e · 0ab264e
1 parent 9e1fdc3
commit 0ab264e
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -8,15 +8,15 @@ A lightweight modern alternative to WorldGuard optimized for API usage
 |--------------------------------------|---------------------------------------------------|---------------------------------------|
 | /area create [name]                  | create new areas                                  | protect.command.area.create           |
 | /area delete [area]                  | delete existing areas                             | protect.command.area.delete           |
-| /area flag info [flag] (area)        | modify, reset or query area flags                 | protect.command.area.flag.info        |
-| /area flag set [flag] [value] (area) | modify, reset or query area flags                 | protect.command.area.flag.set         |
-| /area flag unset [flag] (area)       | modify, reset or query area flags                 | protect.command.area.flag.unset       |
+| /area flag info [flag] (area)        | query information about area flags                | protect.command.area.flag.info        |
+| /area flag set [flag] [value] (area) | change specified flags of areas                   | protect.command.area.flag.set         |
+| /area flag unset [flag] (area)       | reset specified flags of areas                    | protect.command.area.flag.unset       |
 | /area info (area)                    | query information about specific areas            | protect.command.area.info             |
 | /area list                           | list all areas                                    | protect.command.area.list             |
 | /area priority [priority] (area)     | change the priority of areas                      | protect.command.area.priority         |
 | /area redefine [area]                | redefine the region of an existing area           | protect.command.area.redefine         |
-| /area schematic delete [area]        | save, load or delete area schematics              | protect.command.area.schematic.delete |
-| /area schematic load [area]          | save, load or delete area schematics              | protect.command.area.schematic.load   |
-| /area schematic save [area]          | save, load or delete area schematics              | protect.command.area.schematic.save   |
+| /area schematic delete [area]        | delete an area's schematic                        | protect.command.area.schematic.delete |
+| /area schematic load [area]          | load in an area's schematic                       | protect.command.area.schematic.load   |
+| /area schematic save [area]          | save an area's schematic                          | protect.command.area.schematic.save   |
 | /area select (area)                  | (worldedit) select the region of an existing area | worldedit.selection.pos               |
 | /area teleport [area]                | teleport yourself to an area                      | protect.command.area.teleport         |
diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaCreateCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaCreateCommand.java
@@ -12,6 +12,7 @@
 import org.bukkit.plugin.java.JavaPlugin;
 import org.incendo.cloud.Command;
 import org.incendo.cloud.context.CommandContext;
+import org.incendo.cloud.description.Description;
 import org.incendo.cloud.parser.standard.StringParser;
 
 @RequiredArgsConstructor
@@ -22,6 +23,7 @@ class AreaCreateCommand {
     Command.Builder<Player> create() {
         return builder.literal("create")
                 .permission("protect.command.area.create")
+                .commandDescription(Description.description("create new areas"))
                 .required("name", StringParser.greedyStringParser())
                 .senderType(Player.class)
                 .handler(this::execute);

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaDeleteCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaDeleteCommand.java
@@ -8,6 +8,7 @@
 import org.bukkit.command.CommandSender;
 import org.incendo.cloud.Command;
 import org.incendo.cloud.context.CommandContext;
+import org.incendo.cloud.description.Description;
 import org.incendo.cloud.exception.InvalidSyntaxException;
 import org.incendo.cloud.parser.standard.StringParser;
 import org.incendo.cloud.suggestion.Suggestion;
@@ -23,6 +24,7 @@ class AreaDeleteCommand {
     Command.Builder<CommandSender> create() {
         return builder.literal("delete")
                 .permission("protect.command.area.delete")
+                .commandDescription(Description.description("delete existing areas"))
                 .required("area",
                         StringParser.greedyStringParser(),
                         SuggestionProvider.blocking((context, input) -> plugin.areaProvider().getAreas()

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaFlagCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaFlagCommand.java
@@ -46,7 +46,7 @@ public Info(ProtectPlugin plugin, Command.Builder<CommandSender> builder) {
         Command.Builder<CommandSender> create() {
             return flagCommand().literal("info")
                     .permission("protect.command.area.flag.info")
-                    .commandDescription(Description.description("Query an area's flag"))
+                    .commandDescription(Description.description("query information about area flags"))
                     .required("flag",
                             NamespacedKeyParser.namespacedKeyParser(),
                             SuggestionProvider.blocking((context, input) -> plugin.flagRegistry().getFlags().stream()
@@ -92,7 +92,7 @@ public Set(ProtectPlugin plugin, Command.Builder<CommandSender> builder) {
         Command.Builder<CommandSender> create() {
             return flagCommand().literal("set")
                     .permission("protect.command.area.flag.set")
-                    .commandDescription(Description.description("Change an area's flag"))
+                    .commandDescription(Description.description("change specified flags of areas"))
                     .required("flag",
                             NamespacedKeyParser.namespacedKeyParser(),
                             SuggestionProvider.blocking((context, input) -> plugin.flagRegistry().getFlags().stream()
@@ -192,7 +192,7 @@ public Unset(ProtectPlugin plugin, Command.Builder<CommandSender> builder) {
         Command.Builder<CommandSender> create() {
             return flagCommand().literal("unset")
                     .permission("protect.command.area.flag.unset")
-                    .commandDescription(Description.description("Reset an area's flag"))
+                    .commandDescription(Description.description("reset specified flags of areas"))
                     .required("flag",
                             NamespacedKeyParser.namespacedKeyParser(),
                             SuggestionProvider.blocking((context, input) -> plugin.flagRegistry().getFlags().stream()

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaInfoCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaInfoCommand.java
@@ -27,7 +27,7 @@ class AreaInfoCommand {
     Command.Builder<CommandSender> create() {
         return builder.literal("info")
                 .permission("protect.command.area.info")
-                .commandDescription(Description.description("Query information about an area"))
+                .commandDescription(Description.description("query information about specific areas"))
                 .optional("area",
                         StringParser.greedyStringParser(),
                         DefaultValue.dynamic(context -> {

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaListCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaListCommand.java
@@ -18,7 +18,7 @@ class AreaListCommand {
     Command.Builder<CommandSender> create() {
         return builder.literal("list")
                 .permission("protect.command.area.list")
-                .commandDescription(Description.description("List all areas"))
+                .commandDescription(Description.description("list all areas"))
                 .handler(this::execute);
     }
 

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaPriorityCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaPriorityCommand.java
@@ -9,6 +9,7 @@
 import org.incendo.cloud.Command;
 import org.incendo.cloud.component.DefaultValue;
 import org.incendo.cloud.context.CommandContext;
+import org.incendo.cloud.description.Description;
 import org.incendo.cloud.exception.InvalidSyntaxException;
 import org.incendo.cloud.parser.standard.IntegerParser;
 import org.incendo.cloud.parser.standard.StringParser;
@@ -25,6 +26,7 @@ class AreaPriorityCommand {
     Command.Builder<CommandSender> create() {
         return builder.literal("priority")
                 .permission("protect.command.area.priority")
+                .commandDescription(Description.description("change the priority of areas"))
                 .required("priority", IntegerParser.integerParser())
                 .optional("area", StringParser.greedyStringParser(),
                         DefaultValue.dynamic(context -> {

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaRedefineCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaRedefineCommand.java
@@ -15,6 +15,7 @@
 import org.bukkit.plugin.java.JavaPlugin;
 import org.incendo.cloud.Command;
 import org.incendo.cloud.context.CommandContext;
+import org.incendo.cloud.description.Description;
 import org.incendo.cloud.exception.InvalidSyntaxException;
 import org.incendo.cloud.parser.standard.StringParser;
 import org.incendo.cloud.suggestion.Suggestion;
@@ -30,6 +31,7 @@ class AreaRedefineCommand {
     Command.Builder<Player> create() {
         return builder.literal("redefine")
                 .permission("protect.command.area.redefine")
+                .commandDescription(Description.description("redefine the region of areas"))
                 .required("area",
                         StringParser.greedyStringParser(),
                         SuggestionProvider.blocking((context, input) -> plugin.areaProvider().getAreas()

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaSchematicCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaSchematicCommand.java
@@ -51,6 +51,7 @@ public Delete(ProtectPlugin plugin, Command.Builder<CommandSender> builder) {
         Command.Builder<CommandSender> create() {
             return schematicCommand().literal("delete")
                     .permission("protect.command.area.schematic.delete")
+                    .commandDescription(Description.description("delete an area's schematic"))
                     .required("area", StringParser.greedyStringParser(),
                             SuggestionProvider.blocking((context, input) -> plugin.areaProvider().getAreas()
                                     .filter(area -> area instanceof SchematicHolder holder
@@ -82,6 +83,7 @@ public Load(ProtectPlugin plugin, Command.Builder<CommandSender> builder) {
         Command.Builder<CommandSender> create() {
             return schematicCommand().literal("load")
                     .permission("protect.command.area.schematic.load")
+                    .commandDescription(Description.description("load in an area's schematic"))
                     .required("area", StringParser.greedyStringParser(),
                             SuggestionProvider.blocking((context, input) -> plugin.areaProvider().getAreas()
                                     .filter(area -> area instanceof SchematicHolder holder
@@ -120,6 +122,7 @@ public Save(ProtectPlugin plugin, Command.Builder<CommandSender> builder) {
         Command.Builder<CommandSender> create() {
             return schematicCommand().literal("save")
                     .permission("protect.command.area.schematic.save")
+                    .commandDescription(Description.description("save an area's schematic"))
                     .required("area", StringParser.greedyStringParser(),
                             SuggestionProvider.blocking((context, input) -> plugin.areaProvider().getAreas()
                                     .filter(area -> area instanceof SchematicHolder)

diff --git a/plugin/src/main/java/net/thenextlvl/protect/command/AreaSelectCommand.java b/plugin/src/main/java/net/thenextlvl/protect/command/AreaSelectCommand.java
@@ -14,6 +14,7 @@
 import org.incendo.cloud.Command;
 import org.incendo.cloud.component.DefaultValue;
 import org.incendo.cloud.context.CommandContext;
+import org.incendo.cloud.description.Description;
 import org.incendo.cloud.exception.InvalidSyntaxException;
 import org.incendo.cloud.parser.standard.StringParser;
 import org.incendo.cloud.suggestion.Suggestion;
@@ -29,6 +30,7 @@ class AreaSelectCommand {
     Command.Builder<Player> create() {
         return builder.literal("select")
                 .permission("worldedit.selection.pos")
+                .commandDescription(Description.description("(worldedit) select the region of an existing area"))
                 .senderType(Player.class)
                 .optional("area", StringParser.greedyStringParser(),
                         DefaultValue.dynamic(context -> plugin.areaProvider().getArea(context.sender()).getName()),