[PP-2]: Add note in readme about waiting for plugins to load before changing state

Author: BillyDotWS

README.md

@@ -1,15 +1,18 @@
-![ServerPersistence Header](https://i.imgur.com/5zPJx7X.png)
+![ServerReady Header](https://i.imgur.com/MzyOhS2.png)
 
 [![Build Plugin](https://github.com/PlexPrison/ServerPersistence/actions/workflows/build.yml/badge.svg)](https://github.com/PlexPrison/ServerPersistence/actions/workflows/build.yml)
 
-ServerPersistence is a plugin for infinitely running Mineplex Studio project instances until they are killed by external
+ServerReady is a plugin for infinitely running Mineplex Studio project instances until they are killed by external
 factors. This permanently sets the project into `PRE_START` phase (meaning it will last forever, until killed).
 
+The plugin will ensure all other plugins are done with their load process before marking the server as `PRE_START`. It
+will fire the default Mineplex events to signify that everything is ready, so these are also suitable to listen to.
+
 It's a very simple plugin, with no configuration.
 
 ## Installation
 
-1. Head to the [latest release](https://github.com/PlexPrison/ServerPersistence/releases) of the plugin
+1. Head to the [latest release](https://github.com/PlexPrison/ServerReady/releases) of the plugin
 2. Download the Jar file from the latest release
-3. Plop `ServerPersistence.jar` into a folder within your Mineplex Project called `external-plugins`
-4. Start your server, and profit.
+3. Plop `ServerReady-1.0.0.jar` into a folder within your Mineplex Project called `external-plugins`
+4. Start your server, and profit.

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
     id("net.minecrell.plugin-yml.paper") version "0.6.0"
 }
 
-group = "com.plexprison.serverpersistence"
+group = "com.plexprison.serverready"
 version = "1.0.0"
 
 tasks {
@@ -17,9 +17,9 @@ tasks {
 }
 
 paper {
-    name = "ServerPersistence"
+    name = "ServerReady"
     version = project.version.toString()
-    main = "com.plexprison.serverpersistence.ServerPersistence"
+    main = "com.plexprison.serverready.ServerReady"
     apiVersion = "1.20"
 
     serverDependencies {

settings.gradle.kts

@@ -1,4 +1,4 @@
-rootProject.name = "ServerPersistence"
+rootProject.name = "ServerReady"
 
 pluginManagement {
     repositories {

…serverpersistence/ServerPersistence.java …/plexprison/serverready/ServerReady.javasrc/main/java/com/plexprison/serverpersistence/ServerPersistence.java renamed to src/main/java/com/plexprison/serverready/ServerReady.java src/main/java/com/plexprison/serverpersistence/ServerPersistence.java renamed to src/main/java/com/plexprison/serverready/ServerReady.java

@@ -1,6 +1,6 @@
-package com.plexprison.serverpersistence;
+package com.plexprison.serverready;
 
-import com.plexprison.serverpersistence.game.EmptyGame;
+import com.plexprison.serverready.game.EmptyGame;
 import lombok.Getter;
 import org.bukkit.event.Listener;
 import org.bukkit.plugin.Plugin;
@@ -14,11 +14,11 @@
 import java.util.Map;
 
 /**
- * Main plugin class for ServerPersistence.
+ * Main plugin class for ServerReady.
  * Handles plugin loading coordination and game state initialization.
  */
 @Getter
-public class ServerPersistence extends JavaPlugin implements Listener {
+public class ServerReady extends JavaPlugin implements Listener {
 
     private static final int REQUIRED_STABLE_TICKS = 20; // 1 second of stable state
 
@@ -67,13 +67,13 @@ public void run() {
          * @return PluginStateSnapshot containing current plugin information
          */
         private PluginStateSnapshot createPluginStateSnapshot() {
-            final PluginManager pluginManager = ServerPersistence.this.getServer().getPluginManager();
+            final PluginManager pluginManager = ServerReady.this.getServer().getPluginManager();
             final Map<String, Boolean> currentStates = new HashMap<>();
             final List<String> failedPlugins = new ArrayList<>();
             boolean allPluginsFinished = true;
 
             for (final Plugin plugin : pluginManager.getPlugins()) {
-                if (!plugin.equals(ServerPersistence.this)) {
+                if (!plugin.equals(ServerReady.this)) {
                     final boolean isEnabled = plugin.isEnabled();
                     currentStates.put(plugin.getName(), isEnabled);
 
@@ -116,7 +116,7 @@ private void updatePluginStates(final Map<String, Boolean> currentStates) {
         private void warnAboutFailedPlugins(final List<String> failedPlugins) {
             for (final String failedPlugin : failedPlugins) {
                 if (!this.warnedPlugins.contains(failedPlugin)) {
-                    ServerPersistence.this.getLogger().warning(
+                    ServerReady.this.getLogger().warning(
                             "Plugin '" + failedPlugin + "' failed to load but continuing with game state setup."
                     );
                     this.warnedPlugins.add(failedPlugin);
@@ -131,24 +131,24 @@ private void warnAboutFailedPlugins(final List<String> failedPlugins) {
          * @return true if you should proceed, false otherwise
          */
         private boolean shouldProceedToGameState(final boolean allPluginsFinished) {
-            return this.stableTicks >= ServerPersistence.REQUIRED_STABLE_TICKS && allPluginsFinished;
+            return this.stableTicks >= ServerReady.REQUIRED_STABLE_TICKS && allPluginsFinished;
         }
 
         /**
          * Proceeds to game state initialization and logs the status.
          */
         private void proceedToGameState() {
             if (!this.warnedPlugins.isEmpty()) {
-                ServerPersistence.this.getLogger().info(
+                ServerReady.this.getLogger().info(
                         "All plugins have finished loading. Setting up game state with " +
                                 this.warnedPlugins.size() + " failed plugin(s)."
                 );
             } else {
-                ServerPersistence.this.getLogger().info(
+                ServerReady.this.getLogger().info(
                         "All plugins have finished loading successfully. Setting up game state."
                 );
             }
-            ServerPersistence.setState();
+            ServerReady.setState();
             this.cancel();
         }
     }

…on/serverpersistence/game/EmptyGame.java …exprison/serverready/game/EmptyGame.javasrc/main/java/com/plexprison/serverpersistence/game/EmptyGame.java renamed to src/main/java/com/plexprison/serverready/game/EmptyGame.java src/main/java/com/plexprison/serverpersistence/game/EmptyGame.java renamed to src/main/java/com/plexprison/serverready/game/EmptyGame.java

@@ -1,4 +1,4 @@
-package com.plexprison.serverpersistence.game;
+package com.plexprison.serverready.game;
 
 import com.mineplex.studio.sdk.modules.MineplexModuleManager;
 import com.mineplex.studio.sdk.modules.game.*;