Merge pull request #2916 from BentoBoxWorld/develop

Release 3.14 PI

Author: tastybento

CLAUDE.md

@@ -32,13 +32,13 @@ The main plugin class is `BentoBox.java` (extends `JavaPlugin`). Almost all subs
 ### Key Packages
 
 - **`api/`** — Public API surface for addons: events, commands, panels (GUIs), user management, flags, configuration
-- **`managers/`** — Core subsystems: `IslandsManager`, `PlayersManager`, `AddonsManager`, `LocalesManager`, `FlagsManager`, `BlueprintsManager`, `HooksManager`, `PlaceholdersManager`, `RanksManager`
-- **`database/`** — Database abstraction supporting MongoDB, MySQL, MariaDB, and PostgreSQL (via HikariCP)
+- **`managers/`** — Core subsystems: `IslandsManager`, `PlayersManager`, `AddonsManager`, `LocalesManager`, `FlagsManager`, `BlueprintsManager`, `BlueprintClipboardManager`, `HooksManager`, `PlaceholdersManager`, `RanksManager`, `CommandsManager`, `IslandDeletionManager`, `IslandChunkDeletionManager`, `MapManager`, `WebManager`
+- **`database/`** — Database abstraction supporting MongoDB, MySQL, MariaDB, PostgreSQL (via HikariCP), and SQLite
 - **`blueprints/`** — Island schematic handling and pasting
 - **`listeners/`** — Bukkit event handlers (teleport, death, join/leave, panel clicks, spawn protection)
 - **`commands/`** — Admin and user command implementations
 - **`panels/`** — Inventory GUI panel system
-- **`hooks/`** — Integrations with external plugins (Vault, PlaceholderAPI, MythicMobs, Multiverse, LuckPerms, etc.)
+- **`hooks/`** — Integrations with external plugins (Vault, PlaceholderAPI, MythicMobs, Multiverse, LuckPerms, ItemsAdder, Slimefun, Oraxen, ZNPCsPlus, FancyNpcs, BlueMap, Dynmap, LangUtils, etc.)
 - **`nms/`** — NMS (Native Minecraft Server) version-specific code
 
 ### Island Data Flow
@@ -118,9 +118,17 @@ public ImmutableSet<UUID> getMemberSet() { ... }
 
 Guava (`ImmutableSet`, `ImmutableList`, etc.) is reliably available at runtime via Paper's bundled JARs and is safe to use in the public API.
 
+## MiniMessage / legacy color round-trip
+
+`User.getTranslation()` returns a legacy `§`-coded string for backwards compatibility, even when the locale entry is MiniMessage. UI code (`PanelItem.setDescription`, etc.) then re-parses that legacy string back into a Component via `Util.parseMiniMessageOrLegacy`. This MiniMessage → Component → legacy → Component round-trip is lossy by default because of an Adventure quirk:
+
+**Adventure's `LegacyComponentSerializer` never emits `§r` to turn off a decoration when a sibling component clears it.** Legacy color codes have no "decoration off" code — only `§r` resets — but Adventure simply omits the decoration code on the next sibling instead of resetting. When that legacy string is re-parsed under correct legacy semantics (decorations persist until `§r`), the decoration leaks into the following segment. This bit bold, italic, underlined, strikethrough, and obfuscated equally (#2917).
+
+`Util.componentToLegacy` is therefore **not** a thin wrapper around Adventure's serializer — it's a custom Component walker (`appendComponentLegacy` / `emitStyleTransition`) that tracks the last-emitted color and decorations and inserts `§r` whenever any decoration was on and is now off, then re-applies color afterwards. **Do not replace it with `LegacyComponentSerializer.serialize()` directly** without re-introducing the leak. The round-trip is exercised by `LegacyToMiniMessageTest`.
+
 ## Build Notes
 
 - The Gradle build uses the Paper `userdev` plugin and Shadow plugin to produce a fat/shaded JAR at `build/libs/BentoBox-{version}.jar`.
 - `plugin.yml` and `config.yml` are filtered for the `${version}` placeholder at build time; locale files are copied without filtering.
 - Java preview features are enabled for both compilation and test execution.
-- Local builds produce version `3.11.2-LOCAL-SNAPSHOT`; CI builds append `-b{BUILD_NUMBER}-SNAPSHOT`; `origin/master` builds produce the bare version.
+- Local builds produce version `3.13.0-LOCAL-SNAPSHOT`; CI builds append `-b{BUILD_NUMBER}-SNAPSHOT`; `origin/master` builds produce the bare version.

build.gradle.kts

@@ -46,7 +46,7 @@ paperweight.reobfArtifactConfiguration = io.papermc.paperweight.userdev.ReobfArt
 group = "world.bentobox" // From <groupId>
 
 // Base properties from <properties>
-val buildVersion = "3.13.0"
+val buildVersion = "3.14.0"
 val buildNumberDefault = "-LOCAL" // Local build identifier
 val snapshotSuffix = "-SNAPSHOT"  // Indicates development/snapshot version
 

src/main/java/world/bentobox/bentobox/BentoBox.java

@@ -31,6 +31,7 @@
 import world.bentobox.bentobox.managers.CommandsManager;
 import world.bentobox.bentobox.managers.FlagsManager;
 import world.bentobox.bentobox.managers.HooksManager;
+import world.bentobox.bentobox.managers.ChunkPregenManager;
 import world.bentobox.bentobox.managers.IslandDeletionManager;
 import world.bentobox.bentobox.managers.IslandWorldManager;
 import world.bentobox.bentobox.managers.IslandsManager;
@@ -70,6 +71,7 @@ public class BentoBox extends JavaPlugin implements Listener {
     private PlaceholdersManager placeholdersManager;
     private MapManager mapManager;
     private IslandDeletionManager islandDeletionManager;
+    private ChunkPregenManager chunkPregenManager;
     private WebManager webManager;
 
     // Settings
@@ -283,6 +285,7 @@ private void registerListeners() {
         BentoBoxListenerRegistrar registrar = new BentoBoxListenerRegistrar(this);
         registrar.register();
         islandDeletionManager = registrar.getIslandDeletionManager();
+        chunkPregenManager = registrar.getChunkPregenManager();
     }
 
     @Override
@@ -302,7 +305,9 @@ public void onDisable() {
         if (islandsManager != null) {
             islandsManager.shutdown();
         }
-
+        if (chunkPregenManager != null) {
+            chunkPregenManager.shutdown();
+        }
 
     }
 
@@ -553,6 +558,14 @@ public IslandDeletionManager getIslandDeletionManager() {
         return islandDeletionManager;
     }
 
+    /**
+     * @return the chunkPregenManager
+     * @since 3.14.0
+     */
+    public ChunkPregenManager getChunkPregenManager() {
+        return chunkPregenManager;
+    }
+
     /**
      * @return an optional of the Bstats instance
      * @since 1.1

src/main/java/world/bentobox/bentobox/Settings.java

@@ -340,6 +340,32 @@ public class Settings implements ConfigObject {
     @ConfigEntry(path = "island.deletion.slow-deletion", since = "1.19.1")
     private boolean slowDeletion = false;
 
+    // Chunk pre-generation settings
+    @ConfigComment("")
+    @ConfigComment("Chunk pre-generation settings.")
+    @ConfigComment("Pre-generates chunks around predicted future island locations")
+    @ConfigComment("to reduce lag when islands are created or reset.")
+    @ConfigComment("")
+    @ConfigComment("Enable or disable chunk pre-generation.")
+    @ConfigEntry(path = "island.pregeneration.enabled", since = "3.14.0")
+    private boolean pregenEnabled = false;
+
+    @ConfigComment("Number of future islands to pre-generate chunks for, per game mode world.")
+    @ConfigComment("Higher values use more disk space but reduce the chance of lag on island creation.")
+    @ConfigEntry(path = "island.pregeneration.islands-ahead", since = "3.14.0")
+    private int pregenIslandsAhead = 3;
+
+    @ConfigComment("Maximum number of async chunk generation requests dispatched per tick batch.")
+    @ConfigComment("Lower values reduce server impact. Paper handles these asynchronously.")
+    @ConfigComment("Recommended range: 2-10.")
+    @ConfigEntry(path = "island.pregeneration.chunks-per-tick", since = "3.14.0")
+    private int pregenChunksPerTick = 4;
+
+    @ConfigComment("Ticks between pre-generation batches.")
+    @ConfigComment("1 = every tick (fastest), 20 = once per second (gentlest).")
+    @ConfigEntry(path = "island.pregeneration.tick-interval", since = "3.14.0")
+    private int pregenTickInterval = 5;
+
     @ConfigComment("By default, If the destination is not safe, the plugin will try to search for a safe spot around the destination,")
     @ConfigComment("then it will try to expand the y-coordinate up and down from the destination.")
     @ConfigComment("This setting limits how far the y-coordinate will be expanded.")
@@ -376,6 +402,13 @@ public class Settings implements ConfigObject {
     @ConfigEntry(path = "island.obsidian-scooping-cooldown", since = "3.11.4")
     private int obsidianScoopingCooldown = 1;
 
+    @ConfigComment("How long (in seconds) to show a hologram tip above newly formed obsidian")
+    @ConfigComment("that can be scooped back into lava. The hologram reminds players they can")
+    @ConfigComment("right-click obsidian with an empty bucket to recover lava.")
+    @ConfigComment("Set to 0 or less to disable the tip entirely. Default is 5 seconds.")
+    @ConfigEntry(path = "island.obsidian-scooping-lava-tip-duration", since = "3.14.0")
+    private int obsidianScoopingLavaTipDuration = 5;
+
     /* WEB */
     @ConfigComment("Toggle whether BentoBox can connect to GitHub to get data about updates and addons.")
     @ConfigComment("Disabling this will result in the deactivation of the update checker and of some other")
@@ -995,6 +1028,70 @@ public void setSlowDeletion(boolean slowDeletion) {
         this.slowDeletion = slowDeletion;
     }
 
+    /**
+     * @return whether chunk pre-generation is enabled
+     * @since 3.14.0
+     */
+    public boolean isPregenEnabled() {
+        return pregenEnabled;
+    }
+
+    /**
+     * @param pregenEnabled whether chunk pre-generation is enabled
+     * @since 3.14.0
+     */
+    public void setPregenEnabled(boolean pregenEnabled) {
+        this.pregenEnabled = pregenEnabled;
+    }
+
+    /**
+     * @return number of future islands to pre-generate per game mode
+     * @since 3.14.0
+     */
+    public int getPregenIslandsAhead() {
+        return pregenIslandsAhead;
+    }
+
+    /**
+     * @param pregenIslandsAhead number of future islands to pre-generate
+     * @since 3.14.0
+     */
+    public void setPregenIslandsAhead(int pregenIslandsAhead) {
+        this.pregenIslandsAhead = pregenIslandsAhead;
+    }
+
+    /**
+     * @return max async chunk generation requests per tick batch
+     * @since 3.14.0
+     */
+    public int getPregenChunksPerTick() {
+        return pregenChunksPerTick;
+    }
+
+    /**
+     * @param pregenChunksPerTick max async chunk requests per tick
+     * @since 3.14.0
+     */
+    public void setPregenChunksPerTick(int pregenChunksPerTick) {
+        this.pregenChunksPerTick = pregenChunksPerTick;
+    }
+
+    /**
+     * @return ticks between pre-generation batches
+     * @since 3.14.0
+     */
+    public int getPregenTickInterval() {
+        return pregenTickInterval;
+    }
+
+    /**
+     * @param pregenTickInterval ticks between batches
+     * @since 3.14.0
+     */
+    public void setPregenTickInterval(int pregenTickInterval) {
+        this.pregenTickInterval = pregenTickInterval;
+    }
+
     /**
      * Gets maximum pool size.
      *
@@ -1153,6 +1250,28 @@ public void setObsidianScoopingCooldown(int obsidianScoopingCooldown) {
         this.obsidianScoopingCooldown = Math.max(1, obsidianScoopingCooldown);
     }
 
+    /**
+     * Gets the duration (in seconds) for showing the lava tip hologram above
+     * newly formed obsidian blocks that can be scooped.
+     *
+     * @return the lava tip duration in seconds; 0 or less means disabled
+     * @since 3.14.0
+     */
+    public int getObsidianScoopingLavaTipDuration() {
+        return obsidianScoopingLavaTipDuration;
+    }
+
+    /**
+     * Sets the duration (in seconds) for showing the lava tip hologram above
+     * newly formed obsidian blocks that can be scooped.
+     *
+     * @param obsidianScoopingLavaTipDuration the duration in seconds; 0 or less disables
+     * @since 3.14.0
+     */
+    public void setObsidianScoopingLavaTipDuration(int obsidianScoopingLavaTipDuration) {
+        this.obsidianScoopingLavaTipDuration = obsidianScoopingLavaTipDuration;
+    }
+
     /**
      * @return the islandNumber
      * @since 2.0.0

src/main/java/world/bentobox/bentobox/api/addons/GameModeAddon.java

@@ -199,4 +199,21 @@ public boolean isFixIslandCenter() {
     public boolean isEnforceEqualRanges() {
         return true;
     }
+
+    /**
+     * Returns the number of islands to pre-generate chunks for in this game mode.
+     * <p>
+     * Override this method to customize pre-generation for your addon:
+     * <ul>
+     *   <li>{@code -1} — use the global BentoBox setting (default)</li>
+     *   <li>{@code 0} — disable pre-generation for this addon</li>
+     *   <li>positive value — pre-generate this many islands ahead</li>
+     * </ul>
+     *
+     * @return number of islands ahead, -1 for global default, 0 to disable
+     * @since 3.14.0
+     */
+    public int getPregenIslandsAhead() {
+        return -1;
+    }
 }

src/main/java/world/bentobox/bentobox/api/commands/admin/AdminSettingsCommand.java

@@ -21,6 +21,7 @@
 import world.bentobox.bentobox.api.user.User;
 import world.bentobox.bentobox.database.objects.Island;
 import world.bentobox.bentobox.managers.RanksManager;
+import world.bentobox.bentobox.panels.settings.IslandDefaultSettingsTab;
 import world.bentobox.bentobox.panels.settings.SettingsTab;
 import world.bentobox.bentobox.panels.settings.WorldDefaultSettingsTab;
 import world.bentobox.bentobox.util.Util;
@@ -224,6 +225,7 @@ public boolean execute(User user, String label, List<String> args) {
             .world(getWorld())
                     .tab(1, new SettingsTab(getWorld(), user, Flag.Type.WORLD_SETTING, Flag.Mode.EXPERT))
             .tab(2, new WorldDefaultSettingsTab(getWorld(), user))
+            .tab(3, new IslandDefaultSettingsTab(getWorld(), user))
             .startingSlot(1)
             .size(54)
             .build().openPanel();

src/main/java/world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintListCommand.java

@@ -51,10 +51,17 @@ public boolean execute(User user, String label, List<String> args)
             return false;
         }
 
-        FilenameFilter blueprintFilter = (File dir, String name) -> name.endsWith(BlueprintsManager.BLUEPRINT_SUFFIX);
+        FilenameFilter blueprintFilter = (File dir, String name) ->
+                name.endsWith(BlueprintsManager.BLUEPRINT_SUFFIX) || name.endsWith(BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX);
 
         List<String> blueprintList = Arrays.stream(Objects.requireNonNull(blueprints.list(blueprintFilter))).
-                map(name -> name.substring(0, name.length() - BlueprintsManager.BLUEPRINT_SUFFIX.length())).
+                map(name -> {
+                    if (name.endsWith(BlueprintsManager.BLUEPRINT_SUFFIX)) {
+                        return name.substring(0, name.length() - BlueprintsManager.BLUEPRINT_SUFFIX.length());
+                    }
+                    return name.substring(0, name.length() - BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX.length());
+                }).
+                distinct().
                 toList();
 
         if (blueprintList.isEmpty())

src/main/java/world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintLoadCommand.java

@@ -17,7 +17,7 @@
 public class AdminBlueprintLoadCommand extends CompositeCommand {
 
     private static final FilenameFilter BLUEPRINT_FILTER = (File dir, String name) -> name
-            .endsWith(BlueprintsManager.BLUEPRINT_SUFFIX);
+            .endsWith(BlueprintsManager.BLUEPRINT_SUFFIX) || name.endsWith(BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX);
 
     public AdminBlueprintLoadCommand(AdminBlueprintCommand parent) {
         super(parent, "load");
@@ -54,11 +54,22 @@ public Optional<List<String>> tabComplete(User user, String alias, List<String>
         AdminBlueprintCommand parent = (AdminBlueprintCommand) getParent();
         File folder = parent.getBlueprintsFolder();
         if (folder.exists()) {
-            options = Arrays.stream(Objects.requireNonNull(folder.list(BLUEPRINT_FILTER))).map(n -> n.substring(0, n.length() - 4)) // remove .blu from filename
+            options = Arrays.stream(Objects.requireNonNull(folder.list(BLUEPRINT_FILTER)))
+                    .map(AdminBlueprintLoadCommand::removeBlueprintSuffix)
                     .toList();
         }
         String lastArg = !args.isEmpty() ? args.getLast() : "";
 
         return Optional.of(Util.tabLimit(options, lastArg));
     }
+
+    private static String removeBlueprintSuffix(String name) {
+        if (name.endsWith(BlueprintsManager.BLUEPRINT_SUFFIX)) {
+            return name.substring(0, name.length() - BlueprintsManager.BLUEPRINT_SUFFIX.length());
+        }
+        if (name.endsWith(BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX)) {
+            return name.substring(0, name.length() - BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX.length());
+        }
+        return name;
+    }
 }

src/main/java/world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintRenameCommand.java

@@ -56,8 +56,9 @@ public boolean canExecute(User user, String label, List<String> args)
         // Check if the 'from' file exists
         AdminBlueprintCommand parent = (AdminBlueprintCommand) this.getParent();
         File fromFile = new File(parent.getBlueprintsFolder(), from + BlueprintsManager.BLUEPRINT_SUFFIX);
+        File fromFileLegacy = new File(parent.getBlueprintsFolder(), from + BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX);
 
-        if (!fromFile.exists())
+        if (!fromFile.exists() && !fromFileLegacy.exists())
         {
             user.sendMessage("commands.admin.blueprint.no-such-file");
             return false;
@@ -78,8 +79,9 @@ public boolean execute(User user, String label, List<String> args)
 
         // Check if the 'to' file exists
         File toFile = new File(parent.getBlueprintsFolder(), to + BlueprintsManager.BLUEPRINT_SUFFIX);
+        File toFileLegacy = new File(parent.getBlueprintsFolder(), to + BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX);
 
-        if (toFile.exists())
+        if (toFile.exists() || toFileLegacy.exists())
         {
             // Ask for confirmation to overwrite
             this.askConfirmation(user,

src/main/java/world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintSaveCommand.java

@@ -72,8 +72,9 @@ public boolean execute(User user, String label, List<String> args)
 
         // Check if file exists
         File newFile = new File(parent.getBlueprintsFolder(), fileName + BlueprintsManager.BLUEPRINT_SUFFIX);
+        File legacyFile = new File(parent.getBlueprintsFolder(), fileName + BlueprintsManager.LEGACY_BLUEPRINT_SUFFIX);
 
-        if (newFile.exists())
+        if (newFile.exists() || legacyFile.exists())
         {
             this.askConfirmation(user,
                     user.getTranslation("commands.admin.blueprint.file-exists"),