Add Folia support

Closes #54
Co-authored-by: yLeoft <maehara.leonardo@gmail.com>

Author: MrMicky-FR

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        java-version: [ 8, 11, 17 ]
+        java-version: [ 17 ]
 
     steps:
       - name: Checkout repository

README.md

@@ -20,6 +20,7 @@ WorldEditSelectionVisualizer (WESV) is essentially the famous [WorldEditCUI](htt
 - Compatible with all Minecraft versions starting with 1.7.10
 - Support for RGB color codes in messages on Minecraft 1.16 and higher, with the `&#rrggbb` format
 - [PlaceholderAPI](https://github.com/PlaceholderAPI/PlaceholderAPI) support (you can use the placeholders `%wesv_toggled_selection%`, `%wesv_toggled_clipboard%`, `%wesv_volume_selection%` and `%wesv_volume_clipboard%`)
+- [Folia](https://github.com/PaperMC/Folia) support for better performance
 
 ## Downloads
 

build.gradle

@@ -1,6 +1,6 @@
 allprojects {
     group = 'fr.mrmicky'
-    version = '2.1.8'
+    version = '2.1.9'
 }
 
 subprojects {
@@ -9,6 +9,8 @@ subprojects {
     java {
         sourceCompatibility = JavaVersion.VERSION_1_8
         targetCompatibility = JavaVersion.VERSION_1_8
+
+        disableAutoTargetJvm()
     }
 
     tasks.withType(JavaCompile) {
@@ -18,12 +20,12 @@ subprojects {
     repositories {
         mavenCentral()
 
-        maven { url 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' }
-        maven { url 'https://maven.enginehub.org/repo/' }
+        maven { url = 'https://repo.papermc.io/repository/maven-public/' }
+        maven { url = 'https://maven.enginehub.org/repo/' }
     }
 
     dependencies {
         implementation 'org.jspecify:jspecify:1.0.0'
-        compileOnly 'org.spigotmc:spigot-api:1.16.4-R0.1-SNAPSHOT'
+        compileOnly 'dev.folia:folia-api:1.19.4-R0.1-SNAPSHOT'
     }
 }

compatibility/commons/src/main/java/fr/mrmicky/worldeditselectionvisualizer/math/Vector3d.java

@@ -1,5 +1,6 @@
 package fr.mrmicky.worldeditselectionvisualizer.math;
 
+import org.bukkit.Location;
 import org.bukkit.util.Vector;
 import org.jspecify.annotations.NullMarked;
 
@@ -12,6 +13,10 @@ public class Vector3d {
     private final double y;
     private final double z;
 
+    public Vector3d(Location loc) {
+        this(loc.getX(), loc.getY(), loc.getZ());
+    }
+
     public Vector3d(Vector vec) {
         this(vec.getX(), vec.getY(), vec.getZ());
     }

plugin/build.gradle

@@ -3,8 +3,8 @@ plugins {
 }
 
 repositories {
-    maven { url 'https://jitpack.io' }
-    maven { url 'https://repo.extendedclip.com/content/repositories/placeholderapi/' }
+    maven { url = 'https://jitpack.io' }
+    maven { url = 'https://repo.extendedclip.com/content/repositories/placeholderapi/' }
 }
 
 dependencies {

plugin/src/main/java/fr/mrmicky/worldeditselectionvisualizer/WorldEditSelectionVisualizer.java

@@ -3,6 +3,8 @@
 import com.sk89q.worldedit.regions.Region;
 import fr.mrmicky.worldeditselectionvisualizer.commands.CommandWesv;
 import fr.mrmicky.worldeditselectionvisualizer.compat.CompatibilityHelper;
+import fr.mrmicky.worldeditselectionvisualizer.compat.ScheduledTask;
+import fr.mrmicky.worldeditselectionvisualizer.compat.SchedulerAdapter;
 import fr.mrmicky.worldeditselectionvisualizer.config.ConfigurationManager;
 import fr.mrmicky.worldeditselectionvisualizer.config.GlobalSelectionConfig;
 import fr.mrmicky.worldeditselectionvisualizer.display.DisplayType;
@@ -16,47 +18,45 @@
 import fr.mrmicky.worldeditselectionvisualizer.utils.ChatUtils;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.java.JavaPlugin;
-import org.bukkit.scheduler.BukkitTask;
-import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.NullMarked;
 
 import java.io.BufferedReader;
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.net.URI;
 import java.net.URL;
 import java.util.*;
+import java.util.concurrent.ConcurrentHashMap;
 
+@NullMarked
 public final class WorldEditSelectionVisualizer extends JavaPlugin {
 
     private final Map<SelectionType, GlobalSelectionConfig> configurations = new EnumMap<>(SelectionType.class);
-    private final Map<UUID, PlayerVisualizerData> players = new HashMap<>();
-    private final List<BukkitTask> particlesTasks = new ArrayList<>(6);
+    private final Map<UUID, PlayerVisualizerData> players = new ConcurrentHashMap<>();
+    private final List<ScheduledTask> particlesTasks = new ArrayList<>(6);
 
-    private SelectionManager selectionManager;
-    private StorageManager storageManager;
-    private ConfigurationManager configurationManager;
-    private CompatibilityHelper compatibilityHelper;
+    private final SelectionManager selectionManager = new SelectionManager(this);
+    private final StorageManager storageManager = new StorageManager(this);
+    private final ConfigurationManager configurationManager = new ConfigurationManager(this);
+    private final CompatibilityHelper compatibilityHelper = new CompatibilityHelper(this);
 
     @Override
     public void onEnable() {
         saveDefaultConfig();
-        migrateV1Config();
 
-        this.compatibilityHelper = new CompatibilityHelper(this);
-        this.storageManager = new StorageManager(this);
-        this.configurationManager = new ConfigurationManager(this);
-        this.selectionManager = new SelectionManager(this);
+        this.compatibilityHelper.init();
+        this.storageManager.init();
+        this.selectionManager.init();
+
+        getLogger().info("Using WorldEdit " + this.compatibilityHelper.getWorldEditVersion() + " api");
+        getLogger().info("Using " + this.getScheduler().name() + " scheduler");
 
         if (this.compatibilityHelper.getWorldEditVersion() == 7) {
             try {
                 Region.class.getMethod("getVolume");
             } catch (NoSuchMethodException e) {
-                getLogger().severe("**********************************");
-                getLogger().severe("You are using an unsupported WorldEdit version (7.0.x or 7.1.x)!");
-                getLogger().severe("WorldEditSelection visualizer doesn't works with outdated WorldEdit version.");
-                getLogger().severe("You can download the latest WorldEdit version here: https://dev.bukkit.org/projects/worldedit/files");
-                getLogger().severe("**********************************");
+                getLogger().severe("You are using an unsupported WorldEdit version (7.0.x or 7.1.x)");
+                getLogger().severe("Please update WorldEdit: https://dev.bukkit.org/projects/worldedit/files");
                 getServer().getPluginManager().disablePlugin(this);
                 return;
             }
@@ -74,25 +74,21 @@ public void onEnable() {
         }
 
         if (getConfig().getBoolean("check-updates")) {
-            getServer().getScheduler().runTaskAsynchronously(this, this::checkUpdate);
+            getScheduler().executeAsync(this::checkUpdate);
         }
     }
 
     @Override
     public void reloadConfig() {
         super.reloadConfig();
 
-        if (this.configurationManager != null) {
-            loadConfig();
-        }
+        loadConfig();
 
-        if (this.compatibilityHelper != null) {
-            this.compatibilityHelper.init();
-        }
+        this.compatibilityHelper.init();
     }
 
     private void loadConfig() {
-        this.particlesTasks.forEach(BukkitTask::cancel);
+        this.particlesTasks.forEach(ScheduledTask::cancel);
         this.particlesTasks.clear();
 
         for (SelectionType type : SelectionType.values()) {
@@ -107,15 +103,11 @@ private void loadConfig() {
         }
     }
 
-    public void updateHoldingSelectionItem(@NonNull PlayerVisualizerData playerData) {
+    public void updateHoldingSelectionItem(PlayerVisualizerData playerData) {
         playerData.setHoldingSelectionItem(this.compatibilityHelper.isHoldingSelectionItem(playerData.getPlayer()));
     }
 
-    public void loadPlayer(@NonNull Player player) {
-        if (this.players.containsKey(player.getUniqueId())) {
-            return;
-        }
-
+    public void loadPlayer(Player player) {
         PlayerVisualizerData playerData = new PlayerVisualizerData(player);
 
         for (SelectionType type : SelectionType.values()) {
@@ -125,14 +117,14 @@ public void loadPlayer(@NonNull Player player) {
 
         updateHoldingSelectionItem(playerData);
 
-        this.players.put(player.getUniqueId(), playerData);
+        this.players.putIfAbsent(player.getUniqueId(), playerData);
     }
 
-    public void unloadPlayer(@NonNull Player player) {
+    public void unloadPlayer(Player player) {
         this.players.remove(player.getUniqueId());
     }
 
-    public @NonNull PlayerVisualizerData getPlayerData(Player player) {
+    public PlayerVisualizerData getPlayerData(Player player) {
         PlayerVisualizerData playerData = this.players.get(player.getUniqueId());
 
         if (playerData == null) {
@@ -142,11 +134,11 @@ public void unloadPlayer(@NonNull Player player) {
         return playerData;
     }
 
-    public @NonNull Optional<PlayerVisualizerData> getOptionalPlayerData(Player player) {
+    public Optional<PlayerVisualizerData> getOptionalPlayerData(Player player) {
         return Optional.ofNullable(this.players.get(player.getUniqueId()));
     }
 
-    public @NonNull Collection<PlayerVisualizerData> getPlayers() {
+    public Collection<PlayerVisualizerData> getPlayers() {
         return this.players.values();
     }
 
@@ -170,35 +162,27 @@ public String getMessage(String path) {
         return ChatUtils.color(getConfig().getString("messages." + path));
     }
 
+    public SchedulerAdapter getScheduler() {
+        return this.compatibilityHelper.getScheduler();
+    }
+
+    @SuppressWarnings("deprecation") // Ignore Paper-specific deprecations (for compatibility)
+    public String getPluginVersion() {
+        return getDescription().getVersion();
+    }
+
     private void checkUpdate() {
         try {
             URL url = URI.create("https://api.spigotmc.org/legacy/update.php?resource=17311").toURL();
             try (BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream()))) {
                 String lastVersion = reader.readLine();
-                if (!getDescription().getVersion().equalsIgnoreCase(lastVersion)) {
-                    getLogger().warning("A new version is available. Last version is " + lastVersion + " and you are on " + getDescription().getVersion());
-                    getLogger().warning("You can download it on " + getDescription().getWebsite());
+                if (!getPluginVersion().equalsIgnoreCase(lastVersion)) {
+                    getLogger().warning("A new version is available. Last version is " + lastVersion + " and you are on " + getPluginVersion());
+                    getLogger().warning("You can download it on https://www.spigotmc.org/resources/worldeditselectionvisualizer.17311/");
                 }
             }
         } catch (IOException e) {
             getLogger().warning("Unable to check for updates: " + e.getMessage());
         }
     }
-
-    private void migrateV1Config() {
-        if (getConfig().get("lang") == null) {
-            return;
-        }
-
-        // Rename the config from WorldEditSelectionVisualizer v1.x to prevent any issues
-        File configFile = new File(getDataFolder(), "config.yml");
-        File configBackupFile = new File(getDataFolder(), "config-old.yml");
-
-        if (!configFile.renameTo(configBackupFile)) {
-            getLogger().warning("Unable to rename old config.yml file.");
-        }
-
-        saveDefaultConfig();
-        reloadConfig();
-    }
 }

plugin/src/main/java/fr/mrmicky/worldeditselectionvisualizer/commands/CommandWesv.java

@@ -144,7 +144,7 @@ private void handleLock(Player player, String[] args) {
                 return;
             }
 
-            player.teleport(location);
+            this.plugin.getScheduler().teleport(player, location);
             return;
         }
 
@@ -160,7 +160,7 @@ private void handleLock(Player player, String[] args) {
     }
 
     private void sendUsage(CommandSender sender) {
-        String version = this.plugin.getDescription().getVersion();
+        String version = this.plugin.getPluginVersion();
         sender.sendMessage(ChatUtils.color("&6WorldEditSelectionVisualizer v" + version + "&7 by &6MrMicky&7."));
 
         if (sender instanceof Player) {

plugin/src/main/java/fr/mrmicky/worldeditselectionvisualizer/compat/CompatibilityHelper.java

@@ -30,6 +30,7 @@ public class CompatibilityHelper {
 
     private final WorldEditSelectionVisualizer plugin;
 
+    private final SchedulerAdapter scheduler;
     private final boolean supportOffHand = isOffhandSupported();
     private final boolean supportActionBar = isActionBarSupported();
     private final boolean worldEdit7 = isWorldEdit7();
@@ -38,10 +39,7 @@ public class CompatibilityHelper {
 
     public CompatibilityHelper(WorldEditSelectionVisualizer plugin) {
         this.plugin = plugin;
-
-        plugin.getLogger().info("Using WorldEdit " + getWorldEditVersion() + " api");
-
-        init();
+        this.scheduler = SchedulerAdapter.create(this.plugin);
     }
 
     public void init() {
@@ -69,6 +67,10 @@ public void init() {
         }
     }
 
+    public SchedulerAdapter getScheduler() {
+        return this.scheduler;
+    }
+
     public RegionAdapter adaptRegion(Region region) {
         return this.worldEdit7 ? new RegionAdapter7(region) : new RegionAdapter6(region);
     }

plugin/src/main/java/fr/mrmicky/worldeditselectionvisualizer/compat/ScheduledTask.java

@@ -0,0 +1,5 @@
+package fr.mrmicky.worldeditselectionvisualizer.compat;
+
+public interface ScheduledTask {
+    void cancel();
+}