Merge pull request #17 from NonSwag/code-cleanup

Code cleanup and performance improvements

Author: NonSwag

build.gradle.kts

@@ -58,8 +58,6 @@ dependencies {
     // Utils
     implementation(libs.serverlib)
     implementation(libs.paperlib)
-    // Material Utils
-    implementation(libs.xseries) { isTransitive = false }
     // Stats
     implementation(libs.bstats)
     // Commands
@@ -105,7 +103,6 @@ paper {
 spotless {
     java {
         licenseHeaderFile(rootProject.file("HEADER.txt"))
-        targetExclude("**/XMaterial.java")
         target("**/*.java")
     }
 }

gradle/libs.versions.toml

@@ -1,7 +1,6 @@
 [versions]
 minecraft = "1.20.6-R0.1-SNAPSHOT"
 intellectualsites = "1.27"
-xseries = "9.4.0"
 bstats = "3.0.2"
 cloud-minecraft = "2.0.0-beta.8"
 cloud-annotations = "2.0.0-rc.2"
@@ -12,7 +11,6 @@ fawe-bom = { group = "com.intellectualsites.bom", name = "bom-newest", version.r
 fawe-bukkit = { group = "com.fastasyncworldedit", name = "FastAsyncWorldEdit-Bukkit" }
 serverlib = { group = "dev.notmyfault.serverlib", name = "ServerLib" }
 paperlib = { group = "io.papermc", name = "paperlib" }
-xseries = { group = "com.github.cryptomorin", name = "XSeries", version.ref = "xseries" }
 bstats = { group = "org.bstats", name = "bstats-bukkit", version.ref = "bstats" }
 cloud-annotations = { group = "org.incendo", name = "cloud-annotations", version.ref = "cloud-annotations" }
 cloud-minecraft-extras = { group = "org.incendo", name = "cloud-minecraft-extras", version.ref = "cloud-minecraft" }

src/main/java/net/onelitefeather/bettergopaint/BetterGoPaint.java

@@ -19,20 +19,18 @@
 package net.onelitefeather.bettergopaint;
 
 import com.fastasyncworldedit.core.Fawe;
-import io.papermc.lib.PaperLib;
 import net.kyori.adventure.text.minimessage.MiniMessage;
+import net.onelitefeather.bettergopaint.brush.PlayerBrushManager;
 import net.onelitefeather.bettergopaint.command.GoPaintCommand;
 import net.onelitefeather.bettergopaint.command.ReloadCommand;
 import net.onelitefeather.bettergopaint.listeners.ConnectListener;
 import net.onelitefeather.bettergopaint.listeners.InteractListener;
 import net.onelitefeather.bettergopaint.listeners.InventoryListener;
 import net.onelitefeather.bettergopaint.objects.other.Settings;
-import net.onelitefeather.bettergopaint.objects.player.PlayerBrushManager;
-import net.onelitefeather.bettergopaint.utils.Constants;
-import net.onelitefeather.bettergopaint.utils.DisabledBlocks;
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.SimplePie;
 import org.bukkit.Bukkit;
+import org.bukkit.Material;
 import org.bukkit.command.CommandSender;
 import org.bukkit.event.Listener;
 import org.bukkit.plugin.PluginManager;
@@ -42,70 +40,71 @@
 import org.incendo.cloud.execution.ExecutionCoordinator;
 import org.incendo.cloud.paper.LegacyPaperCommandManager;
 import org.incendo.serverlib.ServerLib;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.io.File;
-import java.io.IOException;
-import java.nio.file.Files;
+import java.util.Objects;
 import java.util.logging.Level;
 
-
 public class BetterGoPaint extends JavaPlugin implements Listener {
 
-    public static boolean plotSquaredEnabled;
-    private static PlayerBrushManager manager;
-    private static BetterGoPaint betterGoPaint;
+    public static final @NotNull String PAPER_DOCS = "https://jd.papermc.io/paper/1.20.6/org/bukkit/Material.html#enum-constant-summary";
 
-    public static BetterGoPaint getGoPaintPlugin() {
-        return betterGoPaint;
-    }
+    public static final @NotNull String USE_PERMISSION = "bettergopaint.use";
+    public static final @NotNull String ADMIN_PERMISSION = "bettergopaint.admin";
+    public static final @NotNull String RELOAD_PERMISSION = "bettergopaint.command.admin.reload";
+    public static final @NotNull String WORLD_BYPASS_PERMISSION = "bettergopaint.world.bypass";
 
-    public static PlayerBrushManager getBrushManager() {
-        return manager;
-    }
+    private final @NotNull PlayerBrushManager brushManager = new PlayerBrushManager();
+    private final @NotNull Metrics metrics = new Metrics(this, 18734);
 
-    public static boolean isPlotSquaredEnabled() {
-        return plotSquaredEnabled;
-    }
-
-    public void reload() {
-        BetterGoPaint.getGoPaintPlugin().reloadConfig();
-        manager = new PlayerBrushManager();
-        Settings.settings().reload(new File(getDataFolder(), "config.yml"));
+    @Override
+    public void onLoad() {
+        metrics.addCustomChart(new SimplePie(
+                "faweVersion",
+                () -> Objects.requireNonNull(Fawe.instance().getVersion()).toString()
+        ));
     }
 
+    @Override
     public void onEnable() {
         // Check if we are in a safe environment
         ServerLib.checkUnsafeForks();
-        PaperLib.suggestPaper(this);
 
         // disable if goPaint and BetterGoPaint are installed simultaneously
         if (hasOriginalGoPaint()) {
-            this.getServer().getPluginManager().disablePlugin(this);
+            getComponentLogger().error("BetterGoPaint is a replacement for goPaint. Please use one instead of both");
+            getComponentLogger().error("This plugin is now disabling to prevent future errors");
+            getServer().getPluginManager().disablePlugin(this);
             return;
         }
 
+        reloadConfig();
+
+        Material brush = Settings.settings().GENERIC.DEFAULT_BRUSH;
+        if (!brush.isItem()) {
+            getComponentLogger().error("{} is not a valid default brush, it has to be an item", brush.name());
+            getComponentLogger().error("For more information visit {}", PAPER_DOCS);
+            getServer().getPluginManager().disablePlugin(this);
+        }
+
         //noinspection UnnecessaryUnicodeEscape
         getComponentLogger().info(MiniMessage.miniMessage().deserialize(
                 "<white>Made with <red>\u2665</red> <white>in <gradient:black:red:gold>Germany</gradient>"
         ));
 
-        betterGoPaint = this;
-        if (!Files.exists(getDataFolder().toPath())) {
-            try {
-                Files.createDirectories(getDataFolder().toPath());
-            } catch (IOException e) {
-                throw new RuntimeException(e);
-            }
-        }
-        Settings.settings().reload(new File(getDataFolder(), "config.yml"));
-        enableBStats();
-
-        manager = new PlayerBrushManager();
-
         registerListeners();
         registerCommands();
-        DisabledBlocks.addBlocks();
+    }
+
+    @Override
+    public void onDisable() {
+        metrics.shutdown();
+    }
+
+    public void reloadConfig() {
+        Settings.settings().reload(this, new File(getDataFolder(), "config.yml"));
     }
 
     @SuppressWarnings("UnstableApiUsage")
@@ -121,23 +120,13 @@ private void registerCommands() {
 
     private void registerListeners() {
         PluginManager pm = getServer().getPluginManager();
-        pm.registerEvents(new ConnectListener(this), this);
+        pm.registerEvents(new InventoryListener(getBrushManager()), this);
         pm.registerEvents(new InteractListener(this), this);
-        pm.registerEvents(new InventoryListener(this), this);
+        pm.registerEvents(new ConnectListener(getBrushManager()), this);
     }
 
     private boolean hasOriginalGoPaint() {
-        if (getServer().getPluginManager().getPlugin("goPaint") == this) {
-            return false;
-        }
-        getComponentLogger().error(MiniMessage.miniMessage().deserialize(
-                "<red>BetterGoPaint is a replacement for goPaint. Please use one instead of both"
-        ));
-        getComponentLogger().error(MiniMessage.miniMessage().deserialize(
-                "<red>This plugin is now disabling to prevent future errors"
-        ));
-
-        return true;
+        return getServer().getPluginManager().getPlugin("goPaint") != this;
     }
 
     private @Nullable AnnotationParser<CommandSender> enableCommandSystem() {
@@ -158,13 +147,8 @@ private boolean hasOriginalGoPaint() {
         }
     }
 
-    private void enableBStats() {
-        Metrics metrics = new Metrics(this, Constants.BSTATS_ID);
-
-        metrics.addCustomChart(new SimplePie(
-                "faweVersion",
-                () -> Fawe.instance().getVersion().toString()
-        ));
+    public @NotNull PlayerBrushManager getBrushManager() {
+        return brushManager;
     }
 
 }

src/main/java/net/onelitefeather/bettergopaint/brush/BrushSettings.java

@@ -0,0 +1,166 @@
+/*
+ * goPaint is designed to simplify painting inside of Minecraft.
+ * Copyright (C) Arcaniax-Development
+ * Copyright (C) Arcaniax team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package net.onelitefeather.bettergopaint.brush;
+
+import net.onelitefeather.bettergopaint.objects.brush.Brush;
+import net.onelitefeather.bettergopaint.objects.other.SurfaceMode;
+import org.bukkit.Axis;
+import org.bukkit.Material;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+import java.util.Random;
+
+/**
+ * The BrushSettings interface defines the configuration settings for a brush. It provides methods to retrieve information
+ * about the brush's axis, brush type, list of blocks, mask material, enabled status, surface mode, angle-height
+ * difference, angle distance, chance, falloff strength, fracture distance, mixing strength, size and thickness.
+ */
+public interface BrushSettings {
+
+    /**
+     * Returns the axis used by the brush settings.
+     *
+     * @return the axis used by the brush settings
+     */
+    @NotNull
+    Axis axis();
+
+    /**
+     * Returns the brush used by the brush settings.
+     *
+     * @return The brush used by the brush settings.
+     */
+    @NotNull
+    Brush brush();
+
+    /**
+     * Returns the list of blocks used by the brush settings.
+     *
+     * @return the list of blocks used by the brush settings
+     */
+    @NotNull
+    List<Material> blocks();
+
+    /**
+     * Retrieves the mask material used by the brush settings.
+     *
+     * @return The mask material.
+     * @deprecated the mask-material is going to be replaced with a WorldEdit Mask
+     */
+    @NotNull
+    @Deprecated(since = "1.1.0-SNAPSHOT")
+    @ApiStatus.ScheduledForRemoval(inVersion = "1.2.0")
+    Material mask();
+
+    /**
+     * Checks if the brush is enabled.
+     *
+     * @return true if the brush is enabled, false otherwise
+     */
+    boolean enabled();
+
+    /**
+     * Checks if the mask is enabled.
+     *
+     * @return true if the mask is enabled, false otherwise.
+     */
+    boolean maskEnabled();
+
+    /**
+     * Returns the surface mode used by the brush settings.
+     *
+     * @return The surface mode used by the brush settings.
+     */
+    SurfaceMode surfaceMode();
+
+    /**
+     * Returns the angle-height difference used by the brush settings.
+     *
+     * @return The angle-height difference used by the brush settings.
+     */
+    double angleHeightDifference();
+
+    /**
+     * Returns the angle distance used by the brush settings.
+     *
+     * @return The angle distance used by the brush settings.
+     */
+    int angleDistance();
+
+    /**
+     * Returns the chance of the brush being applied to a block.
+     *
+     * @return The chance of the brush being applied to a block.
+     */
+    int chance();
+
+    /**
+     * Returns the falloff strength used by the brush settings.
+     *
+     * @return The falloff strength used by the brush settings.
+     */
+    int falloffStrength();
+
+    /**
+     * Returns the fracture distance used by the brush settings.
+     *
+     * @return The fracture distance used by the brush settings.
+     */
+    int fractureDistance();
+
+    /**
+     * Returns the mixing strength used by the brush settings.
+     *
+     * @return The mixing strength used by the brush settings.
+     */
+    int mixingStrength();
+
+    /**
+     * Returns the size of the brush settings.
+     *
+     * @return The size of the brush settings.
+     */
+    int size();
+
+    /**
+     * Returns the thickness used by the brush settings.
+     *
+     * @return The thickness used by the brush settings.
+     */
+    int thickness();
+
+    /**
+     * Picks a random block material from {@link #blocks()}.
+     *
+     * @return The randomly picked block material.
+     */
+    @NotNull
+    Material randomBlock();
+
+    /**
+     * The random number generator instance.
+     *
+     * @return a Random instance
+     */
+    @NotNull
+    Random random();
+
+}