Change pause on join to have a configurable player count

Closes #31

README.md

@@ -114,13 +114,12 @@ generation:
   # The value should be a positive integer greater than 50.  
   mspt-pause-threshold: 500
 
-  # If the chunk generation process should pause on player join.
+  # Pauses the generation if the number of players on the server is larger or equal
+  # to the configured value
   # Notice that playing on a server that constantly generates chunks can be
   # very laggy and can cause it to crash.
-  # You could configure the values above so that the performance impact of the generation
+  # The value should be a posivitve integer > 1.
-  # process is minimal.
+  pause-on-player-count: 1
-  # The value should be a boolean <true/false>
-  pause-on-join: true
 ```
 
 ### Spigot and Paper

src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt

@@ -75,7 +75,7 @@ class Chunkmaster: JavaPlugin() {
         config.addDefault("generation.chunks-per-step", 2)
         config.addDefault("generation.chunk-skips-per-step", 100)
         config.addDefault("generation.mspt-pause-threshold", 500L)
-        config.addDefault("generation.pause-on-join", true)
+        config.addDefault("generation.pause-on-player-count", 1)
         config.addDefault("generation.max-pending-chunks", 10)
         config.addDefault("generation.max-loaded-chunks", 10)
         config.addDefault("generation.ignore-worldborder", false)

src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt

@@ -1,16 +1,17 @@
 package net.trivernis.chunkmaster
 
-import net.trivernis.chunkmaster.lib.generation.GenerationTaskPaper
 import org.bukkit.Server
 import org.bukkit.event.EventHandler
 import org.bukkit.event.Listener
 import org.bukkit.event.player.PlayerJoinEvent
 import org.bukkit.event.player.PlayerQuitEvent
-import org.bukkit.event.world.WorldSaveEvent
 
 class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server: Server) : Listener {
 
-    private val pauseOnJoin = chunkmaster.config.getBoolean("generation.pause-on-join")
+    private val pauseOnPlayerCount: Int
+        get () {
+            return chunkmaster.config.getInt("generation.pause-on-player-count")
+        }
     private var playerPaused = false
 
     /**
@@ -18,21 +19,15 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server
      */
     @EventHandler
     fun onPlayerQuit(event: PlayerQuitEvent) {
-        if (pauseOnJoin) {
+        if (server.onlinePlayers.size == pauseOnPlayerCount) {
-            if (server.onlinePlayers.size == 1 && server.onlinePlayers.contains(event.player) ||
+            if (!playerPaused) {
-                server.onlinePlayers.isEmpty()
+                if (chunkmaster.generationManager.pausedTasks.isNotEmpty()) {
-            ) {
+                    chunkmaster.logger.info(chunkmaster.langManager.getLocalized("RESUME_PLAYER_LEAVE"))
-                if (!playerPaused) {
-                    if (chunkmaster.generationManager.pausedTasks.isNotEmpty()) {
-                        chunkmaster.logger.info("Server is empty. Resuming chunk generation tasks.")
-                    }
-                    chunkmaster.generationManager.resumeAll()
-                } else if (chunkmaster.generationManager.paused){
-                    chunkmaster.logger.info("Generation was manually paused. Not resuming automatically.")
-                    playerPaused = chunkmaster.generationManager.paused
-                } else {
-                    chunkmaster.logger.info("Generation tasks are already running.")
                 }
+                chunkmaster.generationManager.resumeAll()
+            } else if (chunkmaster.generationManager.paused){
+                chunkmaster.logger.info(chunkmaster.langManager.getLocalized("PAUSE_MANUALLY"))
+                playerPaused = chunkmaster.generationManager.paused
             }
         }
     }
@@ -42,14 +37,12 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server
      */
     @EventHandler
     fun onPlayerJoin(event: PlayerJoinEvent) {
-        if (pauseOnJoin) {
+        if (server.onlinePlayers.size >= pauseOnPlayerCount) {
-            if (server.onlinePlayers.size == 1 || server.onlinePlayers.isEmpty()) {
+            if (chunkmaster.generationManager.tasks.isNotEmpty()) {
-                if (chunkmaster.generationManager.tasks.isNotEmpty()) {
+                chunkmaster.logger.info(chunkmaster.langManager.getLocalized("PAUSE_PLAYER_JOIN"))
-                    chunkmaster.logger.info("Pausing generation tasks because of player join.")
-                }
-                playerPaused = chunkmaster.generationManager.paused
-                chunkmaster.generationManager.pauseAll()
             }
+            playerPaused = chunkmaster.generationManager.paused
+            chunkmaster.generationManager.pauseAll()
         }
     }
 }

src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt

@@ -19,7 +19,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server
                     this.loadWorldCenters()
                 }
                 this.startAll()
-                if (!server.onlinePlayers.isEmpty()) {
+                if (server.onlinePlayers.size >= chunkmaster.config.getInt("generation.pause-on-player-count")) {
                     this.pauseAll()
                 }
             }
@@ -239,7 +239,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server
     /**
      * Overload that doesn't need an argument
      */
-    fun loadWorldCenters() {
+    private fun loadWorldCenters() {
         loadWorldCenters(null)
     }
 

src/main/resources/i18n/DEFAULT.i18n.properties

@@ -56,4 +56,8 @@ COORD_INVALID = §cThe provided coordinate ('%s', '%s') is invalid!
 CENTER_UPDATED = §9The center for world §2%s §9has been set to §2(%s, %s)§9.
 CENTER_INFO = §9The center for world §2%s §9is §2(%s, %s)§9.
 
-PLUGIN_DETECTED = Detected %s version %s
+PLUGIN_DETECTED = Detected %s version %s
+
+RESUME_PLAYER_LEAVE = The player count is smaller than the configured pause value. Resuming generation...
+PAUSE_PLAYER_JOIN = The player count has reached the pause value. Pausing generation...
+PAUSE_MANUALLY = Generation was manually paused. Not resuming automatically.

src/main/resources/i18n/de.i18n.properties

@@ -51,9 +51,13 @@ TABLE_CREATE_ERROR = §cFehler beim erstellen der Tabelle %s.
 UPDATE_TABLE_DEFINITION = Tabelle %s wurde mit sql %s geupdated.
 UPDATE_TABLE_FAILED = Fehler beim Updaten der Tabelle %s mit sql %s.
 
-TOO_FEW_ARGUMENTS = §cDu hast nicht genug arguments angegeben.
+TOO_FEW_ARGUMENTS = §cDu hast nicht genug Parameter angegeben.
 COORD_INVALID = §cDie Koordinate ('%s', '%s') ist ungültig!
 CENTER_UPDATED = §9Die Mitte der Welt §2%s §9wurde auf §2(%s, %s)§9 gesetzt.
 CENTER_INFO = §9Die Mitte der Welt §2%s §9ist §2(%s, %s)§9.
 
-PLUGIN_DETECTED = Plugin %s in der Version %s gefunden!
+PLUGIN_DETECTED = Plugin %s in der Version %s gefunden!
+
+RESUME_PLAYER_LEAVE = Die Anzahl der Spieler hat den festgelegen Wert zum Pausieren unterschritten. Setze Generieren fort...
+PAUSE_PLAYER_JOIN = Die Anzahl der Spieler hat den festgelegten Wert zum Pausieren erreicht. Pausiere...
+PAUSE_MANUALLY = Das Generieren wurde manuell pausiert und wird deswegen nicht automatisch fortgesetzt.

src/main/resources/i18n/en.i18n.properties

@@ -56,4 +56,8 @@ COORD_INVALID = §cThe provided coordinate ('%s', '%s') is invalid!
 CENTER_UPDATED = §9The center for world §2%s §9has been set to §2(%s, %s)§9.
 CENTER_INFO = §9The center for world §2%s §9is §2(%s, %s)§9.
 
-PLUGIN_DETECTED = Detected %s version %s
+PLUGIN_DETECTED = Detected %s version %s
+
+RESUME_PLAYER_LEAVE = The player count is smaller than the configured pause value. Resuming generation...
+PAUSE_PLAYER_JOIN = The player count has reached the pause value. Pausing generation...
+PAUSE_MANUALLY = Generation was manually paused. Not resuming automatically.