Reworked WorldEvents, implemented GUI Framework & Code Modernizations

pom.xml

@@ -17,17 +17,13 @@
             <id>spigot-repo</id>
             <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
         </repository>
-        <repository>
-            <id>sonatype</id>
-            <url>https://oss.sonatype.org/content/groups/public/</url>
-        </repository>
     </repositories>
     <dependencies>
         <!--Bukkit API-->
         <dependency>
             <groupId>org.spigotmc</groupId>
             <artifactId>spigot-api</artifactId>
-            <version>1.21.5-R0.1-SNAPSHOT</version>
+            <version>1.21-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
         <!-- ProjectKorra Core -->
@@ -48,14 +44,14 @@
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
-            <version>3.17.0</version>
+            <version>3.18.0</version>
             <scope>provided</scope>
         </dependency>
-        <!-- Inventory Framework -->
         <dependency>
-            <groupId>com.github.stefvanschie.inventoryframework</groupId>
-            <artifactId>IF</artifactId>
-            <version>0.11.0</version>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>26.0.2</version>
+            <scope>compile</scope>
         </dependency>
     </dependencies>
 
@@ -87,21 +83,7 @@
                 <version>3.6.0</version>
                 <configuration>
                     <createDependencyReducedPom>false</createDependencyReducedPom>
-                    <relocations>
-                        <relocation>
-                            <pattern>com.github.stefvanschie.inventoryframework</pattern>
-                            <shadedPattern>com.projectkorra.rpg.inventoryframework</shadedPattern>
-                        </relocation>
-                    </relocations>
                 </configuration>
-		        <executions>
-		            <execution>
-		                <phase>package</phase>
-			            <goals>
-			                <goal>shade</goal>
-			            </goals>
-		            </execution>
-		        </executions>
 	        </plugin>
         </plugins>
     </build>

src/main/java/com/projectkorra/rpg/ProjectKorraRPG.java

@@ -6,6 +6,8 @@
 import com.projectkorra.rpg.metrics.MetricsLite;
 import com.projectkorra.rpg.modules.ModuleManager;
 import com.projectkorra.rpg.storage.TableCreator;
+import com.projectkorra.rpg.ui.service.InventoryEventListener;
+import com.projectkorra.rpg.ui.service.InventoryService;
 import net.luckperms.api.LuckPerms;
 import org.bukkit.Bukkit;
 import org.bukkit.plugin.RegisteredServiceProvider;
@@ -18,6 +20,7 @@ public class ProjectKorraRPG extends JavaPlugin {
 	public static LuckPerms luckPermsAPI;
 
 	private ModuleManager moduleManager;
+	private InventoryService inventoryService;
 
 	@Override
 	public void onEnable() {
@@ -26,9 +29,11 @@ public void onEnable() {
 		new ConfigManager();
 		new TableCreator();
 
-		moduleManager = new ModuleManager();
+		moduleManager = new ModuleManager(this);
+		inventoryService = new InventoryService();
 
-		Bukkit.getServer().getPluginManager().registerEvents(new RPGListener(), plugin);
+		Bukkit.getServer().getPluginManager().registerEvents(new InventoryEventListener(inventoryService), this);
+		Bukkit.getServer().getPluginManager().registerEvents(new RPGListener(this), this);
 
 		RegisteredServiceProvider<LuckPerms> provider = Bukkit.getServicesManager().getRegistration(LuckPerms.class);
 		if (provider != null) {
@@ -44,7 +49,7 @@ public void onEnable() {
 
 		// Metrics
 		try {
-			MetricsLite metrics = new MetricsLite(plugin);
+			MetricsLite metrics = new MetricsLite(this);
 			metrics.start();
 		} catch (IOException e) {
 			getLogger().severe("Failed to submit stats to bStats!" + e.getMessage());
@@ -54,6 +59,7 @@ public void onEnable() {
 	@Override
 	public void onDisable() {
 		moduleManager.disableModules();
+		inventoryService.closeAll();
 	}
 
 	public static ProjectKorraRPG getPlugin() {
@@ -64,6 +70,10 @@ public static LuckPerms getLuckPermsAPI() {
 		return luckPermsAPI;
 	}
 
+	public InventoryService getInventoryService() {
+		return inventoryService;
+	}
+
 	public ModuleManager getModuleManager() {
 		return moduleManager;
 	}

src/main/java/com/projectkorra/rpg/RPGListener.java

@@ -1,6 +1,7 @@
 package com.projectkorra.rpg;
 
 import com.projectkorra.projectkorra.event.BendingReloadEvent;
+import com.projectkorra.projectkorra.util.ChatUtil;
 import com.projectkorra.rpg.commands.HelpCommand;
 import com.projectkorra.rpg.commands.RPGCommandBase;
 import com.projectkorra.rpg.configuration.ConfigManager;
@@ -9,10 +10,16 @@
 import org.bukkit.scheduler.BukkitRunnable;
 
 public class RPGListener implements Listener {
+	private final ProjectKorraRPG plugin;
+
+	public RPGListener(final ProjectKorraRPG plugin) {
+		this.plugin = plugin;
+	}
+
 	@EventHandler
-	public void onBendingConfigReload(BendingReloadEvent event) {
+	public void onBendingConfigReload(final BendingReloadEvent event) {
 		// Disable all enabled modules for clean module start
-		ProjectKorraRPG.getPlugin().getModuleManager().disableModules();
+		plugin.getModuleManager().disableModules();
 
 		// Reload configs
 		ConfigManager.defaultConfig.reload();
@@ -24,10 +31,12 @@ public void onBendingConfigReload(BendingReloadEvent event) {
 			public void run() {
 				new RPGCommandBase();
 				new HelpCommand();
-			}
-		}.runTaskLater(ProjectKorraRPG.getPlugin(), 20);
+            }
+		}.runTaskLater(plugin, 20);
 
 		// Re-Enable all modules for clean start
-		ProjectKorraRPG.getPlugin().getModuleManager().enableModules();
-	}
+		plugin.getModuleManager().enableModules();
+
+        event.getSender().sendMessage(ChatUtil.color("&bRPG Addon reloaded!"));
+    }
 }

src/main/java/com/projectkorra/rpg/RPGMethods.java

@@ -1,14 +1,21 @@
 package com.projectkorra.rpg;
 
 import net.luckperms.api.node.Node;
+import org.bukkit.NamespacedKey;
+import org.bukkit.Registry;
+import org.bukkit.Sound;
+import org.bukkit.boss.BarColor;
+import org.bukkit.boss.BarStyle;
 import org.bukkit.entity.Player;
+import org.jetbrains.annotations.Nullable;
 
 import java.time.Duration;
+import java.util.Arrays;
+import java.util.Locale;
 
 import static com.projectkorra.rpg.ProjectKorraRPG.luckPermsAPI;
 
 public class RPGMethods {
-	private static final ProjectKorraRPG plugin = ProjectKorraRPG.getPlugin();
 
 	/**
 	 * @param player     Player who will lose permission
@@ -17,7 +24,7 @@ public class RPGMethods {
 	 * @Description This method is a simplified way of removing
 	 * Permissions to players via LuckPerms
 	 */
-	public static void removePermission(Player player, String permission) {
+	public static void removePermission(final Player player, final String permission) {
 		if (luckPermsAPI == null)
 			return;
 
@@ -34,25 +41,62 @@ public static void removePermission(Player player, String permission) {
 	 * @Description This method is a simplified way of adding
 	 * Permissions to players via LuckPerms
 	 */
-	public static void addPermission(Player player, String permission) {
+	public static void addPermission(final Player player, final String permission) {
 		if (luckPermsAPI == null)
 			return;
+
 		luckPermsAPI.getUserManager().getUser(player.getUniqueId()).data()
 				.add(Node.builder(permission).build());
 		luckPermsAPI.getUserManager().saveUser(luckPermsAPI.getUserManager().getUser(player.getUniqueId()));
 	}
 
+    public static BarColor convertStringToBarColor(final String colorStr) {
+        if (colorStr == null) {
+            return BarColor.RED;
+        }
+
+        try {
+            return BarColor.valueOf(colorStr.toUpperCase(Locale.ROOT));
+        } catch (IllegalArgumentException exception) {
+            ProjectKorraRPG.getPlugin().getLogger().warning("Failed BarColor conversion for String: '" + colorStr + "'! Possible values: " + Arrays.toString(BarColor.values()));
+            return null;
+        }
+    }
+
+    public static BarStyle convertStringToBarStyle(final String styleStr) {
+        if (styleStr == null) {
+            return BarStyle.SOLID;
+        }
+
+        try {
+            return BarStyle.valueOf(styleStr.toUpperCase(Locale.ROOT));
+        } catch (IllegalArgumentException exception) {
+            ProjectKorraRPG.getPlugin().getLogger().warning("Failed BarColor conversion for String: '" + styleStr + "'! Possible values: " + Arrays.toString(BarStyle.values()));
+            return null;
+        }
+    }
+
+    public static @Nullable Sound resolveSound(final String raw) {
+        if (raw == null) return null;
+        String soundId = raw.trim().toLowerCase(Locale.ROOT);
+        if (soundId.isEmpty()) return null;
+
+        NamespacedKey key = soundId.contains(":") ? NamespacedKey.fromString(soundId) : NamespacedKey.minecraft(soundId);
+
+        return (key == null) ? null : Registry.SOUNDS.get(key);
+    }
+
 	/**
 	 * @param period String to convert to duration
 	 * @return Duration in the period string
 	 * @author CrashCringle
 	 * @Description This method converts a period string like 3d4h to a duration object
 	 */
-	public static Duration periodStringToDuration(String period) {
+	public static Duration periodStringToDuration(final String period) {
 		// Can be in the formats like: 1s, 1m, 1h, 1d, 2d1h10s etc etc.
 		Duration duration = Duration.ZERO;
 		if (period == null || period.isEmpty()) {
-			plugin.getLogger().info("Invalid period string: " + period);
+			ProjectKorraRPG.getPlugin().getLogger().info("Invalid period string: " + period);
 			return duration;
 		}
 		String[] parts = period.split("(?<=\\D)(?=\\d)");

src/main/java/com/projectkorra/rpg/configuration/ConfigManager.java

@@ -3,11 +3,13 @@
 import com.projectkorra.projectkorra.Element;
 import com.projectkorra.projectkorra.configuration.ConfigType;
 import org.bukkit.Material;
-import org.bukkit.Sound;
 import org.bukkit.configuration.file.FileConfiguration;
 
 import java.io.File;
-import java.util.*;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
 public class ConfigManager {
     private static final ConfigType DEFAULT = new ConfigType("Default");
@@ -239,37 +241,36 @@ public void configCheck(ConfigType type) {
         } else if (type == WORLDEVENTS) {
             config = sozinsCometConfig.get();
 
-            List<String> disabledWorlds = new ArrayList<>();
-            disabledWorlds.add("none");
-
-            config.addDefault("Title", "&cSozins Comet");
+            config.addDefault("Title", "&cSozin's Comet");
             config.addDefault("Duration", 5000);
-            config.addDefault("World", "world");
+
+            config.addDefault("Worlds", List.of("world"));
 
             config.addDefault("Schedule.At", "7am");
             config.addDefault("Schedule.Repeat", "7d");
             config.addDefault("Schedule.Calendar", "REALTIME");
             config.addDefault("Schedule.Offset", "3d12h");
-            config.addDefault("Schedule.TriggerChance", "0.1");
+            config.addDefault("Schedule.TriggerChance", 0.1);
             config.addDefault("Schedule.Cooldown", "60d");
 
             config.addDefault("DisplayMethods.BossBar.Enabled", true);
             config.addDefault("DisplayMethods.BossBar.Color", "RED");
             config.addDefault("DisplayMethods.BossBar.Style", "SOLID");
             config.addDefault("DisplayMethods.BossBar.Smooth", true);
             config.addDefault("DisplayMethods.Chat.Enabled", true);
-            config.addDefault("DisplayMethods.Chat.EventStartMessage", "&cSozins Comet has entered the world's atmosphere. Firebenders bending has been extremely hightened");
-            config.addDefault("DisplayMethods.Chat.EventStopMessage", "&cSozins Comet has left the world's atmosphere. Firebenders bending has been normalized");
-            config.addDefault("DisplayMethods.ScoreBoard.Enabled", false);
+            config.addDefault("DisplayMethods.Chat.EventStartMessage", "&cSozin's Comet has entered the world's atmosphere. Fire benders bending has been extremely heightened!");
+            config.addDefault("DisplayMethods.Chat.EventStopMessage", "&cSozin's Comet has left the world's atmosphere. Fire benders bending has been normalized!");
+            config.addDefault("DisplayMethods.Chat.EventCurrentlyRunning", "&cSozin's Comet is currently in the world's atmosphere. Fire benders bending is extremely heightened!");
+            config.addDefault("DisplayMethods.Scoreboard.Enabled", false);
             config.addDefault("PlayEventStartSound", true);
-            config.addDefault("EventStart.Sound", Sound.ENTITY_ENDER_DRAGON_GROWL.toString());
-            config.addDefault("EventStart.Volume", "1F");
-            config.addDefault("EventStart.Pitch", "0.5F");
+            config.addDefault("EventStart.Sound", "entity.ender_dragon.growl");
+            config.addDefault("EventStart.Volume", 1);
+            config.addDefault("EventStart.Pitch", 0.5);
             config.addDefault("PlayEventStopSound", true);
-            config.addDefault("EventStop.Sound", Sound.ENTITY_ENDER_DRAGON_AMBIENT.toString());
-            config.addDefault("EventStop.Volume", "1F");
-            config.addDefault("EventStop.Pitch", "0.5F");
-            config.addDefault("DisabledWorlds", disabledWorlds);
+            config.addDefault("EventStop.Sound", "entity.ender_dragon.growl");
+            config.addDefault("EventStop.Volume", 1);
+            config.addDefault("EventStop.Pitch", 0.5);
+            config.addDefault("DisabledWorlds", List.of("none"));
             config.addDefault("Abilities.Fire._All.Damage", "x2.0");
             config.addDefault("Abilities.Fire._All.Speed", "x2.0");
             config.addDefault("Abilities.Fire._All.Cooldown", "x0.5");

src/main/java/com/projectkorra/rpg/modules/Module.java

@@ -5,10 +5,11 @@
 import org.bukkit.event.Listener;
 
 public abstract class Module {
-    private final ProjectKorraRPG plugin = ProjectKorraRPG.getPlugin();
+    private final ProjectKorraRPG plugin;
     private final String name;
 
-    public Module(String name) {
+    public Module(ProjectKorraRPG plugin, String name) {
+        this.plugin = plugin;
         this.name = name;
     }
 
@@ -18,7 +19,7 @@ public Module(String name) {
 
     public void registerListeners(Listener... l) {
         for (Listener listener : l) {
-            ProjectKorraRPG.getPlugin().getServer().getPluginManager().registerEvents(listener, ProjectKorraRPG.getPlugin());
+            this.plugin.getServer().getPluginManager().registerEvents(listener, this.plugin);
         }
     }