spotlessApply

- the same (but correctly implemented) functionality exists in other plugins
 - closes #4140

.github/renovate.json

@@ -9,5 +9,11 @@
     "dependencies"
   ],
   "rebaseWhen": "conflicted",
-  "schedule": ["on the first day of the month"]
+  "schedule": ["on the first day of the month"],
+  "ignoreDeps": [
+    "com.google.code.gson:gson",
+    "com.google.guava:guava",
+    "org.yaml:snakeyaml",
+    "org.apache.logging.log4j:log4j-api",
+  ]
 }

.gitignore

@@ -138,6 +138,5 @@ build/
 
 .DS_Store
 # Ignore run folders
-run-[0-0].[0-9]/
-run-[0-0].[0-9].[0-9]/
-
+run-[0-9].[0-9][0-9]/
+run-[0-9].[0-9][0-9].[0-9]/

Bukkit/build.gradle.kts

@@ -21,20 +21,20 @@ dependencies {
     api(projects.plotsquaredCore)
 
     // Metrics
-    implementation("org.bstats:bstats-bukkit")
+    implementation(libs.bstatsBukkit)
 
     // Paper
-    compileOnly("io.papermc.paper:paper-api")
-    implementation("io.papermc:paperlib")
+    compileOnly(libs.paper)
+    implementation(libs.paperlib)
 
     // Plugins
     compileOnly(libs.worldeditBukkit) {
         exclude(group = "org.bukkit")
         exclude(group = "org.spigotmc")
     }
-    compileOnly("com.fastasyncworldedit:FastAsyncWorldEdit-Bukkit") { isTransitive = false }
-    testImplementation("com.fastasyncworldedit:FastAsyncWorldEdit-Bukkit") { isTransitive = false }
-    compileOnly("com.github.MilkBowl:VaultAPI") {
+    compileOnly(libs.faweBukkit) { isTransitive = false }
+    testImplementation(libs.faweBukkit) { isTransitive = false }
+    compileOnly(libs.vault) {
         exclude(group = "org.bukkit")
     }
     compileOnly(libs.placeholderapi)
@@ -44,15 +44,15 @@ dependencies {
 
     // Other libraries
     implementation(libs.squirrelid) { isTransitive = false }
-    implementation("dev.notmyfault.serverlib:ServerLib")
+    implementation(libs.serverlib)
 
     // Our libraries
     implementation(libs.arkitektonika)
-    implementation("com.intellectualsites.paster:Paster")
-    implementation("com.intellectualsites.informative-annotations:informative-annotations")
+    implementation(libs.paster)
+    implementation(libs.informativeAnnotations)
 
     // Adventure
-    implementation("net.kyori:adventure-platform-bukkit")
+    implementation(libs.adventureBukkit)
 }
 
 tasks.processResources {

Bukkit/src/main/java/com/plotsquared/bukkit/BukkitPlatform.java

@@ -50,6 +50,7 @@ import com.plotsquared.bukkit.util.BukkitUtil;
 import com.plotsquared.bukkit.util.BukkitWorld;
 import com.plotsquared.bukkit.util.SetGenCB;
 import com.plotsquared.bukkit.util.TranslationUpdateManager;
+import com.plotsquared.bukkit.util.UpdateUtility;
 import com.plotsquared.bukkit.util.task.BukkitTaskManager;
 import com.plotsquared.bukkit.util.task.PaperTimeConverter;
 import com.plotsquared.bukkit.util.task.SpigotTimeConverter;
@@ -251,6 +252,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
     }
 
     @Override
+    @SuppressWarnings("deprecation") // Paper deprecation
     public void onEnable() {
         this.pluginName = getDescription().getName();
 
@@ -302,11 +304,9 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
 
         this.serverLocale = Locale.forLanguageTag(Settings.Enabled_Components.DEFAULT_LOCALE);
 
-        /* TODO Enable update checker before v7 is released to GA
         if (PremiumVerification.isPremium() && Settings.Enabled_Components.UPDATE_NOTIFICATIONS) {
             injector.getInstance(UpdateUtility.class).updateChecker();
         }
-         */
 
         if (PremiumVerification.isPremium()) {
             LOGGER.info("PlotSquared version licensed to Spigot user {}", getUserID());
@@ -551,7 +551,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
         this.startMetrics();
 
         if (Settings.Enabled_Components.WORLDS) {
-            TaskManager.getPlatformImplementation().taskRepeat(this::unload, TaskTime.seconds(1L));
+            TaskManager.getPlatformImplementation().taskRepeat(this::unload, TaskTime.seconds(10L));
             try {
                 singleWorldListener = injector().getInstance(SingleWorldListener.class);
                 Bukkit.getPluginManager().registerEvents(singleWorldListener, this);
@@ -1161,6 +1161,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
         return new BukkitPlotGenerator(world, generator, this.plotAreaManager);
     }
 
+    @SuppressWarnings("deprecation") // Paper deprecation
     @Override
     public @NonNull String pluginsFormatted() {
         StringBuilder msg = new StringBuilder();
@@ -1182,7 +1183,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
     }
 
     @Override
-    @SuppressWarnings("ConstantConditions")
+    @SuppressWarnings({"ConstantConditions", "deprecation"}) // Paper deprecation
     public @NonNull String worldEditImplementations() {
         StringBuilder msg = new StringBuilder();
         if (Bukkit.getPluginManager().getPlugin("FastAsyncWorldEdit") != null) {

Bukkit/src/main/java/com/plotsquared/bukkit/entity/ReplicatingEntityWrapper.java

@@ -74,6 +74,7 @@ public final class ReplicatingEntityWrapper extends EntityWrapper {
     private HorseStats horse;
     private boolean noGravity;
 
+    @SuppressWarnings("deprecation") // Deprecation exists since 1.20, while we support 1.16 onwards
     public ReplicatingEntityWrapper(Entity entity, short depth) {
         super(entity);
 

Bukkit/src/main/java/com/plotsquared/bukkit/listener/PlayerEventListener.java

@@ -369,6 +369,7 @@ public class PlayerEventListener implements Listener {
     }
 
     @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
+    @SuppressWarnings("deprecation") // Paper deprecation
     public void onConnect(PlayerJoinEvent event) {
         final Player player = event.getPlayer();
         PlotSquared.platform().playerManager().removePlayer(player.getUniqueId());
@@ -733,6 +734,7 @@ public class PlayerEventListener implements Listener {
     }
 
     @EventHandler(priority = EventPriority.LOW)
+    @SuppressWarnings("deprecation") // Paper deprecation
     public void onChat(AsyncPlayerChatEvent event) {
         if (event.isCancelled()) {
             return;
@@ -1063,6 +1065,7 @@ public class PlayerEventListener implements Listener {
     }
 
     @EventHandler(priority = EventPriority.LOW)
+    @SuppressWarnings("deprecation") // Paper deprecation
     public void onCancelledInteract(PlayerInteractEvent event) {
         if (event.isCancelled() && event.getAction() == Action.RIGHT_CLICK_AIR) {
             Player player = event.getPlayer();

Bukkit/src/main/java/com/plotsquared/bukkit/util/BukkitInventoryUtil.java

@@ -44,6 +44,7 @@ import java.util.stream.IntStream;
 @Singleton
 public class BukkitInventoryUtil extends InventoryUtil {
 
+    @SuppressWarnings("deprecation") // Paper deprecation
     private static @Nullable ItemStack getItem(PlotItemStack item) {
         if (item == null) {
             return null;

Bukkit/src/main/java/com/plotsquared/bukkit/util/BukkitSetupUtils.java

@@ -67,6 +67,7 @@ public class BukkitSetupUtils extends SetupUtils {
         this.worldFile = worldFile;
     }
 
+    @SuppressWarnings("deprecation") // Paper deprecation
     @Override
     public void updateGenerators(final boolean force) {
         if (loaded && !SetupUtils.generators.isEmpty() && !force) {

Bukkit/src/main/java/com/plotsquared/bukkit/util/TranslationUpdateManager.java

@@ -44,6 +44,10 @@ public class TranslationUpdateManager {
         String minheightReplacement = "minheight";
         String maxHeight = "maxHeight";
         String maxheightReplacement = "maxheight";
+        String usedGrants = "usedGrants";
+        String usedGrantsReplacement = "used_grants";
+        String remainingGrants = "remainingGrants";
+        String rremainingGrantsReplacement = "remaining_grants";
 
         try (Stream<Path> paths = Files.walk(Paths.get(PlotSquared.platform().getDirectory().toPath().resolve("lang").toUri()))) {
             paths
@@ -53,6 +57,8 @@ public class TranslationUpdateManager {
                         replaceInFile(p, suggestCommand, suggestCommandReplacement);
                         replaceInFile(p, minHeight, minheightReplacement);
                         replaceInFile(p, maxHeight, maxheightReplacement);
+                        replaceInFile(p, usedGrants, usedGrantsReplacement);
+                        replaceInFile(p, remainingGrants, rremainingGrantsReplacement);
                     });
         }
     }

Bukkit/src/main/java/com/plotsquared/bukkit/util/UpdateUtility.java

@@ -60,7 +60,7 @@ public class UpdateUtility implements Listener {
         task = Bukkit.getScheduler().runTaskTimerAsynchronously(this.javaPlugin, () -> {
             try {
                 HttpsURLConnection connection = (HttpsURLConnection) new URL(
-                        "https://api.spigotmc.org/simple/0.1/index.php?action=getResource&id=77506")
+                        "https://api.spigotmc.org/simple/0.2/index.php?action=getResource&id=77506")
                         .openConnection();
                 connection.setRequestMethod("GET");
                 JsonObject result = new JsonParser()

CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at contact<at>intellectualsites.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

Core/build.gradle.kts

@@ -2,18 +2,18 @@ import java.time.format.DateTimeFormatter
 
 dependencies {
     // Expected everywhere.
-    compileOnlyApi("org.checkerframework:checker-qual")
+    compileOnlyApi(libs.checkerqual)
 
     // Minecraft expectations
-    compileOnlyApi("com.google.code.gson:gson")
-    compileOnly("com.google.guava:guava")
+    compileOnlyApi(libs.gson)
+    compileOnly(libs.guava)
 
     // Platform expectations
-    compileOnlyApi("org.yaml:snakeyaml")
+    compileOnlyApi(libs.snakeyaml)
 
     // Adventure
-    api("net.kyori:adventure-api")
-    api("net.kyori:adventure-text-minimessage")
+    api(libs.adventureApi)
+    api(libs.adventureMiniMessage)
 
     // Guice
     api(libs.guice) {
@@ -31,19 +31,19 @@ dependencies {
         exclude(group = "dummypermscompat")
     }
     testImplementation(libs.worldeditCore)
-    compileOnly("com.fastasyncworldedit:FastAsyncWorldEdit-Core") { isTransitive = false }
-    testImplementation("com.fastasyncworldedit:FastAsyncWorldEdit-Core") { isTransitive = false }
+    compileOnly(libs.faweBukkit) { isTransitive = false }
+    testImplementation(libs.faweCore) { isTransitive = false }
 
     // Logging
-    compileOnlyApi("org.apache.logging.log4j:log4j-api")
+    compileOnlyApi(libs.log4j)
 
     // Other libraries
     api(libs.prtree)
     api(libs.aopalliance)
     api(libs.cloudServices)
     api(libs.arkitektonika)
-    api("com.intellectualsites.paster:Paster")
-    api("com.intellectualsites.informative-annotations:informative-annotations")
+    api(libs.paster)
+    api(libs.informativeAnnotations)
 }
 
 tasks.processResources {

Core/src/main/java/com/plotsquared/core/PlotSquared.java

@@ -1281,7 +1281,7 @@ public class PlotSquared {
     }
 
     /**
-     * Setup the database connection.
+     * Set up the database connection.
      */
     public void setupDatabase() {
         try {

Core/src/main/java/com/plotsquared/core/command/Auto.java

@@ -131,8 +131,8 @@ public class Auto extends SubCommand {
                         player.sendMessage(
                                 TranslatableCaption.of("economy.removed_granted_plot"),
                                 TagResolver.builder()
-                                        .tag("usedGrants", Tag.inserting(Component.text(grantedPlots - left)))
-                                        .tag("remainingGrants", Tag.inserting(Component.text(left)))
+                                        .tag("used_grants", Tag.inserting(Component.text(grantedPlots - left)))
+                                        .tag("remaining_grants", Tag.inserting(Component.text(left)))
                                         .build()
                         );
                     }

Core/src/main/java/com/plotsquared/core/command/Claim.java

@@ -186,8 +186,8 @@ public class Claim extends SubCommand {
                 player.sendMessage(
                         TranslatableCaption.of("economy.removed_granted_plot"),
                         TagResolver.builder()
-                                .tag("usedGrants", Tag.inserting(Component.text(grants - 1)))
-                                .tag("remainingGrants", Tag.inserting(Component.text(grants)))
+                                .tag("used_grants", Tag.inserting(Component.text(grants - 1)))
+                                .tag("remaining_grants", Tag.inserting(Component.text(grants)))
                                 .build()
                 );
             }

Core/src/main/java/com/plotsquared/core/command/Debug.java

@@ -29,7 +29,6 @@ import com.plotsquared.core.util.WorldUtil;
 import com.plotsquared.core.util.entity.EntityCategories;
 import com.plotsquared.core.util.entity.EntityCategory;
 import com.plotsquared.core.util.query.PlotQuery;
-import com.plotsquared.core.util.task.TaskManager;
 import com.plotsquared.core.uuid.UUIDMapping;
 import com.sk89q.worldedit.world.entity.EntityType;
 import net.kyori.adventure.text.Component;
@@ -71,7 +70,7 @@ public class Debug extends SubCommand {
                     TranslatableCaption.of("commandconfig.command_syntax"),
                     TagResolver.resolver(
                             "value",
-                            Tag.inserting(Component.text("/plot debug <loadedchunks | player | debug-players | entitytypes | msg>"))
+                            Tag.inserting(Component.text("/plot debug <player | debug-players | entitytypes | msg>"))
                     )
             );
         }
@@ -85,16 +84,6 @@ public class Debug extends SubCommand {
                 return true;
             }
         }
-        if (args.length > 0 && "loadedchunks".equalsIgnoreCase(args[0])) {
-            final long start = System.currentTimeMillis();
-            player.sendMessage(TranslatableCaption.of("debug.fetching_loaded_chunks"));
-            TaskManager.runTaskAsync(() -> player.sendMessage(StaticCaption
-                    .of("Loaded chunks: " + this.worldUtil
-                            .getChunkChunks(player.getLocation().getWorldName())
-                            .size() + " (" + (System.currentTimeMillis()
-                            - start) + "ms) using thread: " + Thread.currentThread().getName())));
-            return true;
-        }
         if (args.length > 0 && "uuids".equalsIgnoreCase(args[0])) {
             final Collection<UUIDMapping> mappings = PlotSquared.get().getImpromptuUUIDPipeline().getAllImmediately();
             player.sendMessage(
@@ -196,7 +185,7 @@ public class Debug extends SubCommand {
 
     @Override
     public Collection<Command> tab(final PlotPlayer<?> player, String[] args, boolean space) {
-        return Stream.of("loadedchunks", "debug-players", "entitytypes")
+        return Stream.of("debug-players", "entitytypes")
                 .filter(value -> value.startsWith(args[0].toLowerCase(Locale.ENGLISH)))
                 .map(value -> new Command(null, false, value, "plots.admin", RequiredType.NONE, null) {
                 }).collect(Collectors.toList());

Core/src/main/java/com/plotsquared/core/command/DebugRoadRegen.java

@@ -96,6 +96,7 @@ public class DebugRoadRegen extends SubCommand {
         PlotArea area = location.getPlotArea();
         if (area == null) {
             player.sendMessage(TranslatableCaption.of("errors.not_in_plot_world"));
+            return false;
         }
         Plot plot = player.getCurrentPlot();
         if (plot == null) {

Core/src/main/java/com/plotsquared/core/generator/HybridUtils.java

@@ -77,6 +77,10 @@ public class HybridUtils {
     private static final Logger LOGGER = LogManager.getLogger("PlotSquared/" + HybridUtils.class.getSimpleName());
     private static final BlockState AIR = BlockTypes.AIR.getDefaultState();
 
+    /**
+     * Deprecated and likely to be removed in a future release.
+     */
+    @Deprecated(forRemoval = true, since = "7.0.0")
     public static HybridUtils manager;
     public static Set<BlockVector2> regions;
     public static int height;

Core/src/main/java/com/plotsquared/core/player/OfflinePlotPlayer.java

@@ -25,9 +25,9 @@ import java.util.UUID;
 public interface OfflinePlotPlayer extends PermissionHolder {
 
     /**
-     * Gets the {@code UUID} of this player
+     * Returns the UUID of the player.
      *
-     * @return the player {@link UUID}
+     * @return the UUID of the player
      */
     UUID getUUID();
 
@@ -39,9 +39,9 @@ public interface OfflinePlotPlayer extends PermissionHolder {
     long getLastPlayed();
 
     /**
-     * Gets the name of this player.
+     * Returns the name of the player.
      *
-     * @return the player name
+     * @return the name of the player
      */
     String getName();
 

Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java

@@ -273,8 +273,9 @@ public abstract class PlotPlayer<P> implements CommandCaller, OfflinePlotPlayer,
         return this.meta == null ? null : this.meta.remove(key);
     }
 
+
     /**
-     * This player's name.
+     * Returns the name of the player.
      *
      * @return the name of the player
      */

Core/src/main/java/com/plotsquared/core/plot/PlotId.java

@@ -26,8 +26,8 @@ import java.util.Iterator;
 import java.util.NoSuchElementException;
 
 /**
- * Plot (X,Y) tuples for plot locations
- * within a plot area
+ * The PlotId class represents a Plot's x and y coordinates within a {@link PlotArea}. PlotId x,y values do not correspond to Block locations.
+ * A PlotId instance can be created using the {@link #of(int, int)} method or parsed from a string using the {@link #fromString(String)} method.
  */
 public final class PlotId {
 
@@ -36,10 +36,10 @@ public final class PlotId {
     private final int hash;
 
     /**
-     * PlotId class (PlotId x,y values do not correspond to Block locations)
+     * Constructs a new PlotId with the given x and y coordinates.
      *
-     * @param x The plot x coordinate
-     * @param y The plot y coordinate
+     * @param x the x-coordinate of the plot
+     * @param y the y-coordinate of the plot
      */
     private PlotId(final int x, final int y) {
         this.x = x;
@@ -48,11 +48,11 @@ public final class PlotId {
     }
 
     /**
-     * Create a new plot ID instance
+     * Returns a new PlotId instance with the specified x and y coordinates.
      *
-     * @param x The plot x coordinate
-     * @param y The plot y coordinate
-     * @return a new PlotId at x,y
+     * @param x the x-coordinate of the plot
+     * @param y the y-coordinate of the plot
+     * @return a new PlotId instance with the specified x and y coordinates
      */
     public static @NonNull PlotId of(final int x, final int y) {
         return new PlotId(x, y);
@@ -74,10 +74,13 @@ public final class PlotId {
     }
 
     /**
-     * Attempt to parse a plot ID from a string
+     * Returns a PlotId object from the given string, or null if the string is invalid.
+     * The string should be in the format "x;y" where x and y are integers.
+     * The string can also contain any combination of the characters ";_,."
+     * as delimiters.
      *
-     * @param string ID string
-     * @return Plot ID, or {@code null} if none could be parsed
+     * @param string the string to parse
+     * @return a PlotId object parsed from the given string, or null if the string is invalid
      */
     public static @Nullable PlotId fromStringOrNull(final @NonNull String string) {
         final String[] parts = string.split("[;_,.]");
@@ -95,39 +98,39 @@ public final class PlotId {
         return of(x, y);
     }
 
+
     /**
-     * Gets the PlotId from the HashCode<br>
-     * Note: Only accurate for small x,z values (short)
+     * Returns a new PlotId instance from the given hash.
      *
-     * @param hash ID hash
-     * @return Plot ID
+     * @param hash the hash to unpair
+     * @return a new PlotId instance
      */
     public static @NonNull PlotId unpair(final int hash) {
         return PlotId.of(hash >> 16, hash & 0xFFFF);
     }
 
     /**
-     * Get the ID X component
+     * Returns the x-coordinate of this Plot ID.
      *
-     * @return X component
+     * @return the x-coordinate of this Plot ID
      */
     public int getX() {
         return this.x;
     }
 
     /**
-     * Get the ID Y component
+     * Returns the y-coordinate of this Plot ID.
      *
-     * @return Y component
+     * @return the y-coordinate of this Plot ID
      */
     public int getY() {
         return this.y;
     }
 
     /**
-     * Get the next plot ID for claiming purposes
+     * Returns the next Plot ID for claiming purposes based on the current Plot ID.
      *
-     * @return Next plot ID
+     * @return the next Plot ID
      */
     public @NonNull PlotId getNextId() {
         final int absX = Math.abs(x);
@@ -159,10 +162,11 @@ public final class PlotId {
     }
 
     /**
-     * Get the PlotId in a relative direction
+     * Returns a new Plot ID in the specified relative direction based on the
+     * current Plot ID.
      *
-     * @param direction Direction
-     * @return Relative plot ID
+     * @param direction the direction in which to get the relative Plot ID
+     * @return the relative Plot ID
      */
     public @NonNull PlotId getRelative(final @NonNull Direction direction) {
         return switch (direction) {
@@ -193,10 +197,11 @@ public final class PlotId {
     }
 
     /**
-     * Get a String representation of the plot ID where the
-     * components are separated by ";"
+     * Returns a string representation of this Plot ID in the format "x;y".
      *
-     * @return {@code x + ";" + y}
+     * <p> The format is {@code x + ";" + y}
+     *
+     * @return a string representation of this Plot ID
      */
     @Override
     public @NonNull String toString() {
@@ -204,41 +209,40 @@ public final class PlotId {
     }
 
     /**
-     * Get a String representation of the plot ID where the
-     * components are separated by a specified string
+     * Returns a string representation of this Plot ID with the specified separator.
+     * <p>
+     * The format is {@code x + separator + y}
      *
-     * @param separator Separator
-     * @return {@code x + separator + y}
+     * @param separator the separator to use between the X and Y coordinates
+     * @return a string representation of this Plot ID with the specified separator
      */
     public @NonNull String toSeparatedString(String separator) {
         return this.getX() + separator + this.getY();
     }
 
     /**
-     * Get a String representation of the plot ID where the
-     * components are separated by ","
+     * Returns a string representation of this Plot ID in the format "x,y".
      *
-     * @return {@code x + "," + y}
+     * @return a string representation of this Plot ID
      */
     public @NonNull String toCommaSeparatedString() {
         return this.getX() + "," + this.getY();
     }
 
     /**
-     * Get a String representation of the plot ID where the
-     * components are separated by "_"
+     * Returns a string representation of this Plot ID in the format "x_y".
      *
-     * @return {@code x + "_" + y}
+     * @return a string representation of this Plot ID
      */
+
     public @NonNull String toUnderscoreSeparatedString() {
         return this.getX() + "_" + this.getY();
     }
 
     /**
-     * Get a String representation of the plot ID where the
-     * components are separated by "-"
+     * Returns a string representation of this Plot ID in the format "x-y".
      *
-     * @return {@code x + "-" + y}
+     * @return a string representation of this Plot ID
      */
     public @NonNull String toDashSeparatedString() {
         return this.getX() + "-" + this.getY();
@@ -250,6 +254,10 @@ public final class PlotId {
     }
 
 
+    /**
+     * An iterator that iterates over a range of {@link PlotId}s.
+     * The range is defined by a start and end {@link PlotId}.
+     */
     public static final class PlotRangeIterator implements Iterator<PlotId>, Iterable<PlotId> {
 
         private final PlotId start;
@@ -265,6 +273,13 @@ public final class PlotId {
             this.y = this.start.getY();
         }
 
+        /**
+         * Returns a new {@link PlotRangeIterator} that iterates over the range of Plots between the specified start and end Plots (inclusive).
+         *
+         * @param start the starting Plot of the range
+         * @param end the ending Plot of the range
+         * @return a new {@link PlotRangeIterator} that iterates over the range of Plots between the specified start and end Plots (inclusive)
+         */
         public static PlotRangeIterator range(final @NonNull PlotId start, final @NonNull PlotId end) {
             return new PlotRangeIterator(start, end);
         }

Core/src/main/java/com/plotsquared/core/plot/PlotItemStack.java

@@ -67,14 +67,25 @@ public class PlotItemStack {
         return this.type;
     }
 
+    /**
+     * Returns the number of items in this stack.
+     * Valid values range from 1-255.
+     *
+     * @return the amount of items in this stack
+     */
     public int getAmount() {
         return amount;
     }
 
+    /**
+     * Returns the given name of this stack of items. The name is displayed when
+     * hovering over the item.
+     *
+     * @return the given name of this stack of items
+     */
     public String getName() {
         return name;
     }
-
     public String[] getLore() {
         return lore;
     }

Core/src/main/java/com/plotsquared/core/plot/PlotModificationManager.java

@@ -891,7 +891,6 @@ public final class PlotModificationManager {
     }
 
     /**
-     * /**
      * Sets components such as border, wall, floor.
      * (components are generator specific)
      *

Core/src/main/java/com/plotsquared/core/plot/PlotWeather.java

@@ -18,9 +18,25 @@
  */
 package com.plotsquared.core.plot;
 
+/**
+ * The different types of weather that can be set for a Plot.
+ */
 public enum PlotWeather {
+
+    /**
+     * Rainy weather conditions
+     */
     RAIN,
+    /**
+     * Clear weather conditions
+     */
     CLEAR,
+    /**
+     * Use the weather of the world the plot is in
+     */
     WORLD,
+    /**
+     * Turn off weather for the plot
+     */
     OFF
 }

Core/src/main/resources/lang/messages_en.json

@@ -124,7 +124,7 @@
   "economy.cannot_afford_merge": "<prefix><red>You cannot afford to merge the plots. It costs <gold><money></gold>.</red>",
   "economy.added_balance": "<prefix><gold><money> </gold><gray>has been added to your balance.</gray>",
   "economy.removed_balance": "<prefix><gold><money> </gold><gray>has been taken from your balance.</gray>",
-  "economy.removed_granted_plot": "<prefix><gray>You used <usedGrants> plot grant(s), you've got </gray><gold><remainingGrants></gold> <gray>left.</gray>",
+  "economy.removed_granted_plot": "<prefix><gray>You used <used_grants> plot grant(s), you've got </gray><gold><remaining_grants></gold> <gray>left.</gray>",
   "setup.choose_generator": "<gold>What generator do you want?</gold>",
   "setup.setup_not_started": "<prefix><gold>No setup started.</gold>",
   "setup.setup_init": "<prefix><gold>Usage: </gold><gray>/plot setup <value></gray>",

build.gradle.kts

@@ -1,5 +1,6 @@
 import com.diffplug.gradle.spotless.SpotlessPlugin
 import com.github.jengelman.gradle.plugins.shadow.ShadowPlugin
+import groovy.json.JsonSlurper
 import java.net.URI
 import xyz.jpenilla.runpaper.task.RunServer
 
@@ -17,11 +18,11 @@ plugins {
     eclipse
     idea
 
-    id("xyz.jpenilla.run-paper") version "2.1.0"
+    alias(libs.plugins.runPaper)
 }
 
 group = "com.intellectualsites.plotsquared"
-version = "7.0.0-rc.4"
+version = "7.0.1-SNAPSHOT"
 
 if (!File("$rootDir/.git").exists()) {
     logger.lifecycle("""
@@ -76,10 +77,6 @@ subprojects {
         plugin<IdeaPlugin>()
     }
 
-    dependencies {
-        implementation(platform("com.intellectualsites.bom:bom-newest:1.34"))
-    }
-
     dependencies {
         // Tests
         testImplementation("org.junit.jupiter:junit-jupiter:5.10.0")
@@ -222,14 +219,23 @@ tasks.getByName<Jar>("jar") {
     enabled = false
 }
 
-val supportedVersions = listOf("1.16.5", "1.17", "1.17.1", "1.18.2", "1.19", "1.19.1", "1.19.2", "1.19.3", "1.19.4", "1.20")
+val supportedVersions = listOf("1.16.5", "1.17.1", "1.18.2", "1.19.4", "1.20.1")
 tasks {
+    val lastSuccessfulBuildUrl = uri("https://ci.athion.net/job/FastAsyncWorldEdit/lastSuccessfulBuild/api/json").toURL()
+    val artifact = ((JsonSlurper().parse(lastSuccessfulBuildUrl) as Map<*, *>)["artifacts"] as List<*>)
+            .map { it as Map<*, *> }
+            .map { it["fileName"] as String }
+            .first { it.contains("Bukkit") }
+
     supportedVersions.forEach {
         register<RunServer>("runServer-$it") {
             minecraftVersion(it)
             pluginJars(*project(":plotsquared-bukkit").getTasksByName("shadowJar", false).map { (it as Jar).archiveFile }
                     .toTypedArray())
             jvmArgs("-DPaper.IgnoreJavaVersion=true", "-Dcom.mojang.eula.agree=true")
+            downloadPlugins {
+                url("https://ci.athion.net/job/FastAsyncWorldEdit/lastSuccessfulBuild/artifact/artifacts/$artifact")
+            }
             group = "run paper"
             runDirectory.set(file("run-$it"))
         }

gradle/libs.versions.toml

@@ -1,13 +1,22 @@
 [versions]
 # Platform expectations
+paper = "1.20.1-R0.1-SNAPSHOT"
 guice = "7.0.0"
 spotbugs = "4.7.3"
+checkerqual = "3.37.0"
+gson = "2.10"
+guava = "31.1-jre"
+snakeyaml = "2.0"
+adventure = "4.14.0"
+adventure-bukkit = "4.3.0"
+log4j = "2.19.0"
 
 # Plugins
 worldedit = "7.2.15"
+fawe = "2.7.1"
 placeholderapi = "2.11.3"
 luckperms = "5.4"
-essentialsx = "2.20.0"
+essentialsx = "2.20.1"
 mvdwapi = "3.1.1"
 
 # Third party
@@ -16,18 +25,34 @@ aopalliance = "1.0"
 cloud-services = "1.8.3"
 arkitektonika = "2.1.2"
 squirrelid = "0.3.2"
+paster = "1.1.5"
+bstats = "3.0.2"
+paperlib = "1.0.8"
+informative-annotations = "1.3"
+vault = "1.7.1"
+serverlib = "2.3.4"
 
 # Gradle plugins
 shadow = "8.1.1"
 grgit = "4.1.1"
-spotless = "6.20.0"
+spotless = "6.21.0"
 nexus = "1.3.0"
+runPaper = "2.2.0"
 
 [libraries]
 # Platform expectations
+paper = { group = "io.papermc.paper", name = "paper-api", version.ref = "paper" }
 guice = { group = "com.google.inject", name = "guice", version.ref = "guice" }
 guiceassistedinject = { group = "com.google.inject.extensions", name = "guice-assistedinject", version.ref = "guice" }
 spotbugs = { group = "com.github.spotbugs", name = "spotbugs-annotations", version.ref = "spotbugs" }
+checkerqual = { group = "org.checkerframework", name = "checker-qual", version.ref = "checkerqual" }
+gson = { group = "com.google.code.gson", name = "gson", version.ref = "gson" }
+guava = { group = "com.google.guava", name = "guava", version.ref = "guava" }
+snakeyaml = { group = "org.yaml", name = "snakeyaml", version.ref = "snakeyaml" }
+adventureApi = { group = "net.kyori", name = "adventure-api", version.ref = "adventure" }
+adventureMiniMessage = { group = "net.kyori", name = "adventure-text-minimessage", version.ref = "adventure" }
+adventureBukkit = { group = "net.kyori", name = "adventure-platform-bukkit", version.ref = "adventure-bukkit" }
+log4j = { group = "org.apache.logging.log4j", name = "log4j-api", version.ref = "log4j" }
 
 # Plugins
 worldeditCore = { group = "com.sk89q.worldedit", name = "worldedit-core", version.ref = "worldedit" }
@@ -35,6 +60,8 @@ worldeditBukkit = { group = "com.sk89q.worldedit", name = "worldedit-bukkit", ve
 placeholderapi = { group = "me.clip", name = "placeholderapi", version.ref = "placeholderapi" }
 luckperms = { group = "net.luckperms", name = "api", version.ref = "luckperms" }
 essentialsx = { group = "net.essentialsx", name = "EssentialsX", version.ref = "essentialsx" }
+faweCore = { group = "com.fastasyncworldedit", name = "FastAsyncWorldEdit-Core", version.ref = "fawe" }
+faweBukkit = { group = "com.fastasyncworldedit", name = "FastAsyncWorldEdit-Bukkit", version.ref = "fawe" }
 
 # Third party
 prtree = { group = "com.intellectualsites.prtree", name = "PRTree", version.ref = "prtree" }
@@ -43,9 +70,17 @@ cloudServices = { group = "cloud.commandframework", name = "cloud-services", ver
 mvdwapi = { group = "com.intellectualsites.mvdwplaceholderapi", name = "MVdWPlaceholderAPI", version.ref = "mvdwapi" }
 squirrelid = { group = "org.enginehub", name = "squirrelid", version.ref = "squirrelid" }
 arkitektonika = { group = "com.intellectualsites.arkitektonika", name = "Arkitektonika-Client", version.ref = "arkitektonika" }
+paster = { group = "com.intellectualsites.paster", name = "Paster", version.ref = "paster" }
+bstatsBase = { group = "org.bstats", name = "bstats-base", version.ref = "bstats" }
+bstatsBukkit = { group = "org.bstats", name = "bstats-bukkit", version.ref = "bstats" }
+informativeAnnotations = { group = "com.intellectualsites.informative-annotations", name = "informative-annotations", version.ref = "informative-annotations" }
+paperlib = { group = "io.papermc", name = "paperlib", version.ref = "paperlib" }
+vault = { group = "com.github.MilkBowl", name = "VaultAPI", version.ref = "vault" }
+serverlib = { group = "dev.notmyfault.serverlib", name = "ServerLib", version.ref = "serverlib" }
 
 [plugins]
 shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" }
 grgit = { id = "org.ajoberstar.grgit", version.ref = "grgit" }
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 nexus = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexus" }
+runPaper = { id = "xyz.jpenilla.run-paper", version.ref = "runPaper" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum