Merge branch 'main' into feat/clone-unloaded

benwoo1110 · web-flow · commit f4405874d108 · 2026-04-04T12:05:01.000+08:00
diff --git a/.github/workflows/generic.platform_uploads.yml b/.github/workflows/generic.platform_uploads.yml
@@ -107,7 +107,7 @@ jobs:
         files: '["${{ github.workspace }}/${{ inputs.plugin_name }}-${{ steps.release-info.outputs.tag_name }}.jar"]'
         name: ${{ steps.release-info.outputs.tag_name }}
         changelog: ${{ steps.release-artifact.outputs.body }}
-        game_versions: 1.21.11, 1.21.10, 1.21.9, 1.21.8, 1.21.7, 1.21.6, 1.21.5, 1.21.4, 1.21.3, 1.21.2, 1.21.1, 1.21, 1.20.6, 1.20.5, 1.20.4, 1.20.3, 1.20.2, 1.20.1, 1.20, 1.19.4, 1.19.3, 1.19.2, 1.19.1, 1.19, 1.18.2
+        game_versions: 26.1.1, 26.1, 1.21.11, 1.21.10, 1.21.9, 1.21.8, 1.21.7, 1.21.6, 1.21.5, 1.21.4, 1.21.3, 1.21.2, 1.21.1, 1.21, 1.20.6, 1.20.5, 1.20.4, 1.20.3, 1.20.2, 1.20.1, 1.20, 1.19.4, 1.19.3, 1.19.2, 1.19.1, 1.19, 1.18.2
         version_type: ${{ steps.parse-release-type.outputs.release_type }}
         loaders: bukkit, spigot, paper, purpur
         dependencies: ${{ inputs.modrinth_dependencies }}
@@ -121,7 +121,7 @@ jobs:
         changelog: ${{ steps.release-artifact.outputs.body }}
         changelog_type: markdown
         display_name: ${{ steps.release-info.outputs.tag_name }}
-        game_versions: 1.21.11, 1.21.10, 1.21.9, 1.21.8, 1.21.7, 1.21.6, 1.21.5, 1.21.4, 1.21.3, 1.21.2, 1.21.1, 1.21, 1.20.6, 1.20.5, 1.20.4, 1.20.3, 1.20.2, 1.20.1, 1.20, 1.19.4, 1.19.3, 1.19.2, 1.19.1, 1.19, 1.18.2
+        game_versions: 26.1.1, 26.1, 1.21.11, 1.21.10, 1.21.9, 1.21.8, 1.21.7, 1.21.6, 1.21.5, 1.21.4, 1.21.3, 1.21.2, 1.21.1, 1.21, 1.20.6, 1.20.5, 1.20.4, 1.20.3, 1.20.2, 1.20.1, 1.20, 1.19.4, 1.19.3, 1.19.2, 1.19.1, 1.19, 1.18.2
         release_type: ${{ steps.parse-release-type.outputs.release_type }}
         project_relations: ${{ inputs.dbo_project_relations }}
         file_path: ${{ github.workspace }}/${{ inputs.plugin_name }}-${{ steps.release-info.outputs.tag_name }}.jar
@@ -136,5 +136,5 @@ jobs:
         channel: ${{ steps.parse-release-type.outputs.release_type }}
         files: '[{"path": "${{ github.workspace }}/${{ inputs.plugin_name }}-${{ steps.release-info.outputs.tag_name }}.jar", "platforms": ["PAPER"]}]'
         description: ${{ steps.release-artifact.outputs.body }}
-        platform_dependencies: '{"PAPER": ["1.18.2-1.21.11"]}'
+        platform_dependencies: '{"PAPER": ["1.18.2-26.1.1"]}'
         plugin_dependencies: ${{ inputs.hangar_plugin_dependencies }}
diff --git a/src/main/java/org/mvplugins/multiverse/core/PlaceholderExpansionHook.java b/src/main/java/org/mvplugins/multiverse/core/PlaceholderExpansionHook.java
@@ -113,7 +113,7 @@ public boolean persist() {
                 return Option.of(player.getWorld().getName());
             } else {
                 warning("You must specify a world name for non-player placeholders");
-                return null;
+                return Option.none();
             }
         }
 
@@ -150,6 +150,7 @@ public boolean persist() {
             case "gamemode" -> world.getGameMode().toString().toLowerCase();
             case "generator" -> world.getGenerator();
             case "hunger" -> String.valueOf(world.isHunger());
+            case "isloaded" -> String.valueOf(world.isLoaded());
             case "monstersspawn" -> String.valueOf(world.getEntitySpawnConfig()
                     .getSpawnCategoryConfig(SpawnCategory.MONSTER)
                     .isSpawn());
diff --git a/src/main/java/org/mvplugins/multiverse/core/commands/LoadCommand.java b/src/main/java/org/mvplugins/multiverse/core/commands/LoadCommand.java
@@ -16,8 +16,8 @@
 import org.mvplugins.multiverse.core.command.MVCommandIssuer;
 import org.mvplugins.multiverse.core.command.flag.CommandFlag;
 import org.mvplugins.multiverse.core.command.flag.CommandFlagsManager;
+import org.mvplugins.multiverse.core.command.flag.FlagBuilder;
 import org.mvplugins.multiverse.core.command.flag.ParsedCommandFlags;
-import org.mvplugins.multiverse.core.command.flags.RemovePlayerFlags;
 import org.mvplugins.multiverse.core.locale.MVCorei18n;
 import org.mvplugins.multiverse.core.locale.message.MessageReplacement.Replace;
 import org.mvplugins.multiverse.core.world.MultiverseWorld;
@@ -38,7 +38,7 @@ class LoadCommand extends CoreCommand {
 
     @Subcommand("load")
     @CommandPermission("multiverse.core.load")
-    @CommandCompletion("@mvworlds:scope=unloaded")
+    @CommandCompletion("@mvworlds:scope=unloaded @flags:groupName=" + Flags.NAME)
     @Syntax("<world>")
     @Description("{@@mv-core.load.description}")
     void onLoadCommand(
@@ -49,7 +49,7 @@ void onLoadCommand(
             MultiverseWorld world,
 
             @Optional
-            @Syntax("[--remove-players]")
+            @Syntax("[--skip-folder-check]")
             @Description("")
             String[] flagArray) {
         ParsedCommandFlags parsedFlags = flags.parse(flagArray);
@@ -67,9 +67,9 @@ void onLoadCommand(
     }
 
     @Service
-    private static final class Flags extends RemovePlayerFlags {
+    private static final class Flags extends FlagBuilder {
 
-        private static final String NAME = "mvunload";
+        private static final String NAME = "mvload";
 
         @Inject
         private Flags(@NotNull CommandFlagsManager flagsManager) {
diff --git a/src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java b/src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java
@@ -220,7 +220,10 @@ private <N extends Node> N node(N node) {
 
     final ConfigNode<PassengerModes> passengerMode = node(ConfigNode.builder("teleport.passenger-mode", PassengerModes.class)
             .comment("")
-            .comment("Configures how passengers and vehicles are handled when an entity is teleported.")
+            .comment("Configures how passengers and vehicles are handled when an entity is teleported. This config is")
+            .comment("only applied to /mvtp, join-destination and first-spawn-override. It will not touch any other")
+            .comment("teleport by other plugins or commands.")
+            .comment("========= Available options: =========")
             .comment("  default: Server will handle passengers and vehicles. On papermc 1.21.10+, all will be retained by default.")
             .comment("                                                       On older versions, all will be dismounted if world changes.")
             .comment("  dismount_passengers: Passengers will be removed from the parent entity before the teleport.")
diff --git a/src/main/java/org/mvplugins/multiverse/core/listeners/MVPlayerListener.java b/src/main/java/org/mvplugins/multiverse/core/listeners/MVPlayerListener.java
@@ -244,7 +244,7 @@ private void handleJoinLocation(Player player) {
     }
 
     private void teleportToDestinationOnJoin(Player player, DestinationInstance<?, ?> destination) {
-        asyncSafetyTeleporter.to(destination).teleportSingle(player)
+        asyncSafetyTeleporter.to(destination).passengerMode(config.getPassengerMode()).teleportSingle(player)
                 .onSuccess(result -> Logging.fine("Player %s has been teleported on join",
                         player.getName()))
                 .onFailure(failure -> Logging.warning("Failed to teleport player %s on join: %s",
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/compatibility/BukkitCompatibility.java b/src/main/java/org/mvplugins/multiverse/core/utils/compatibility/BukkitCompatibility.java
@@ -0,0 +1,68 @@
+package org.mvplugins.multiverse.core.utils.compatibility;
+
+import io.vavr.control.Option;
+import org.bukkit.Bukkit;
+import org.bukkit.NamespacedKey;
+import org.bukkit.Server;
+import org.bukkit.World;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.mvplugins.multiverse.core.utils.ReflectHelper;
+
+import java.lang.reflect.Method;
+import java.nio.file.Path;
+
+/**
+ * Compatibility class used to handle API changes in {@link Bukkit} class.
+ */
+@ApiStatus.AvailableSince("5.6")
+public final class BukkitCompatibility {
+
+    private static final Option<Method> GET_LEVEL_DIRECTORY_METHOD;
+    private static final Option<Method> GET_WORLD_NAMESPACED_KEY_METHOD;
+
+    static {
+        GET_LEVEL_DIRECTORY_METHOD = Option.of(ReflectHelper.getMethod(Server.class, "getLevelDirectory"));
+        GET_WORLD_NAMESPACED_KEY_METHOD = Option.of(ReflectHelper.getMethod(Bukkit.class, "getWorld", NamespacedKey.class));
+    }
+
+    /**
+     * Gets the folder where all the worlds will be store. Before 26.1, all worlds are stored in the root directory
+     * of the server, which can be obtained by {@link Server#getWorldContainer()}.
+     * <br />
+     * After 26.1, PaperMC changed all worlds are stored in the "[level]/dimensions/minecraft" folder under the world
+     * level directory, which needs to be manually parsed.
+     *
+     * @return The location where all the worlds folders should be, depending on server's mc version.
+     */
+    @ApiStatus.AvailableSince("5.6")
+    @NotNull
+    public static Path getWorldFoldersDirectory() {
+        Server server = Bukkit.getServer();
+        return GET_LEVEL_DIRECTORY_METHOD.map(method -> ReflectHelper.invokeMethod(server, method))
+                .filter(Path.class::isInstance)
+                .map(Path.class::cast)
+                .map(path -> path.resolve("dimensions/minecraft"))
+                .getOrElse(() -> server.getWorldContainer().toPath());
+    }
+
+    /**
+     * Check if the world with the given name or namespaced key (e.g. minecraft:overworld) exists,
+     * and return it if it does.
+     * <br />
+     * Note that some default world names have different namespaced key matched with them.
+     * E.g.: world -> minecraft:overworld, world_nether -> minecraft:the_nether, world_the_end -> minecraft:the_end.
+     *
+     * @param nameOrKey Either a name or namespaced key string representation.
+     * @return The world if it exists
+     */
+    @ApiStatus.AvailableSince("5.6")
+    @NotNull
+    public static Option<World> getWorldByNameOrKey(@NotNull String nameOrKey) {
+        return Option.of(Bukkit.getWorld(nameOrKey))
+                .orElse(() -> GET_WORLD_NAMESPACED_KEY_METHOD
+                        .map(method -> ReflectHelper.invokeMethod(null, method, NamespacedKey.fromString(nameOrKey)))
+                        .filter(World.class::isInstance)
+                        .map(World.class::cast));
+    }
+}
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/compatibility/package-info.java b/src/main/java/org/mvplugins/multiverse/core/utils/compatibility/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * Contains classes to handle compatibility due to differing API methods across different server versions and the
+ * API gaps between PaperMC and Spigot.
+ */
+package org.mvplugins.multiverse.core.utils.compatibility;
diff --git a/src/main/java/org/mvplugins/multiverse/core/world/WorldConfig.java b/src/main/java/org/mvplugins/multiverse/core/world/WorldConfig.java
@@ -396,7 +396,7 @@ void deferenceMVWorld() {
     /**
      * Migrates the entry fee settings. Assumes entry fee is disabled if currency is not set.
      */
-    static final class EntryFeeMigrator implements MigratorAction {
+    private static final class EntryFeeMigrator implements MigratorAction {
         @Override
         public void migrate(ConfigurationSection config) {
             String currency = config.getString("entry-fee.currency", "");
diff --git a/src/main/java/org/mvplugins/multiverse/core/world/WorldManager.java b/src/main/java/org/mvplugins/multiverse/core/world/WorldManager.java
@@ -51,6 +51,7 @@
 import org.mvplugins.multiverse.core.utils.CaseInsensitiveStringMap;
 import org.mvplugins.multiverse.core.utils.ReflectHelper;
 import org.mvplugins.multiverse.core.utils.ServerProperties;
+import org.mvplugins.multiverse.core.utils.compatibility.BukkitCompatibility;
 import org.mvplugins.multiverse.core.utils.result.Attempt;
 import org.mvplugins.multiverse.core.utils.result.FailureReason;
 import org.mvplugins.multiverse.core.utils.FileUtils;
@@ -701,6 +702,7 @@ private Attempt<String, DeleteFailureReason> doDeleteWorld(@NotNull LoadedMultiv
     private Attempt<File, DeleteFailureReason> validateWorldToDelete(
             @NotNull LoadedMultiverseWorld world) {
         return world.getBukkitWorld().map(World::getWorldFolder)
+                .peek(folder -> Logging.finer("World folder for world %s is at: %s", world.getName(), folder.getPath()))
                 .filter(worldNameChecker::isValidWorldFolder)
                 .map(this::<File, DeleteFailureReason>worldActionResult)
                 .getOrElse(() -> {
@@ -768,8 +770,8 @@ private Attempt<CloneWorldOptions, CloneFailureReason> cloneWorldCopyFolder(@Not
                 loadedWorld.getBukkitWorld().peek(this::saveWorldWithFlush);
             });
         }
-        File worldFolder = new File(Bukkit.getWorldContainer(), options.fromWorld().getName());
-        File newWorldFolder = new File(Bukkit.getWorldContainer(), options.newWorldName());
+        File worldFolder = BukkitCompatibility.getWorldFoldersDirectory().resolve(options.fromWorld().getName()).toFile();
+        File newWorldFolder = BukkitCompatibility.getWorldFoldersDirectory().resolve(options.newWorldName()).toFile();
         return fileUtils.copyFolder(worldFolder, newWorldFolder, CLONE_IGNORE_FILES).fold(
                 exception -> worldActionResult(CloneFailureReason.COPY_FAILED,
                         options.fromWorld().getName(), exception),
@@ -827,6 +829,7 @@ public Attempt<LoadedMultiverseWorld, RegenFailureReason> regenWorld(@NotNull Re
         Location spawnLocation = world.getSpawnLocation();
 
         CreateWorldOptions createWorldOptions = CreateWorldOptions.worldName(world.getName())
+                .biome(world.getBiome())
                 .environment(world.getEnvironment())
                 .generateStructures(world.canGenerateStructures().getOrElse(true))
                 .generator(world.getGenerator())
@@ -976,12 +979,12 @@ private void throwUnloadException(World world) throws MultiverseWorldException {
      * @return A list of all potential worlds.
      */
     public List<String> getPotentialWorlds() {
-        File[] files = Bukkit.getWorldContainer().listFiles();
+        File[] files = BukkitCompatibility.getWorldFoldersDirectory().toFile().listFiles();
         if (files == null) {
             return Collections.emptyList();
         }
         return Arrays.stream(files)
-                .filter(file -> !isWorld(file.getName()))
+                .filter(file -> BukkitCompatibility.getWorldByNameOrKey(file.getName()).isEmpty())
                 .filter(worldNameChecker::isValidWorldFolder)
                 .map(File::getName)
                 .toList();
diff --git a/src/main/java/org/mvplugins/multiverse/core/world/helpers/WorldNameChecker.java b/src/main/java/org/mvplugins/multiverse/core/world/helpers/WorldNameChecker.java
@@ -1,15 +1,17 @@
 package org.mvplugins.multiverse.core.world.helpers;
 
 import java.io.File;
+import java.util.List;
 import java.util.Locale;
 import java.util.Set;
 
+import com.dumptruckman.minecraft.util.Logging;
 import io.vavr.control.Option;
-import org.bukkit.Bukkit;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jvnet.hk2.annotations.Service;
 import org.mvplugins.multiverse.core.utils.REPatterns;
+import org.mvplugins.multiverse.core.utils.compatibility.BukkitCompatibility;
 
 /**
  * <p>Utility class in helping to check the status of a world name and it's associated world folder.</p>
@@ -29,6 +31,18 @@ public final class WorldNameChecker {
             "plugins",
             "versions");
 
+    private static final List<WorldFolderSchema> WORLD_FOLDER_SCHEMA = List.of(
+            // OLD
+            WorldFolderSchema.file("level.dat"),
+            WorldFolderSchema.folder("DIM1"),
+            WorldFolderSchema.folder("DIM-1"),
+            // NEW
+            WorldFolderSchema.file("paper-world.yml"),
+            WorldFolderSchema.folder("data"),
+            WorldFolderSchema.folder("entities"),
+            WorldFolderSchema.folder("poi"),
+            WorldFolderSchema.folder("region"));
+
     /**
      * Checks if a world name is valid.
      *
@@ -105,7 +119,8 @@ public FolderStatus checkFolder(@Nullable String worldName) {
         if (worldName == null) {
             return FolderStatus.DOES_NOT_EXIST;
         }
-        File worldFolder = new File(Bukkit.getWorldContainer(), worldName);
+        File worldFolder = BukkitCompatibility.getWorldFoldersDirectory().resolve(worldName).toFile();
+        Logging.finer("Checking valid folder for world '%s' at: '%s'", worldName, worldFolder.getPath());
         return checkFolder(worldFolder);
     }
 
@@ -120,7 +135,7 @@ public FolderStatus checkFolder(@Nullable File worldFolder) {
         if (worldFolder == null || !worldFolder.exists() || !worldFolder.isDirectory()) {
             return FolderStatus.DOES_NOT_EXIST;
         }
-        if (!folderHasDat(worldFolder)) {
+        if (!folderWorldSchemaCheck(worldFolder)) {
             return FolderStatus.NOT_A_WORLD;
         }
         return FolderStatus.VALID;
@@ -133,9 +148,54 @@ public FolderStatus checkFolder(@Nullable File worldFolder) {
      * @param worldFolder   The File that may be a world.
      * @return True if it looks like a world, else false.
      */
-    private boolean folderHasDat(@NotNull File worldFolder) {
-        File[] files = worldFolder.listFiles((file, name) -> name.toLowerCase(Locale.ENGLISH).endsWith(".dat"));
-        return files != null && files.length > 0;
+    private boolean folderWorldSchemaCheck(@NotNull File worldFolder) {
+        return WORLD_FOLDER_SCHEMA.stream()
+                .filter(schema -> schema.check(worldFolder))
+                .count() >= 2;
+    }
+
+    /**
+     * Helper class to check if a file or folder exist.
+     */
+    private interface WorldFolderSchema {
+
+        static WorldFolderSchema file(String path) {
+            return new WorldFile(path);
+        }
+
+        static WorldFolderSchema folder(String path) {
+            return new WorldFolder(path);
+        }
+
+        boolean check(File worldFolder);
+
+        final class WorldFile implements WorldFolderSchema {
+            private final String path;
+
+            private WorldFile(String path) {
+                this.path = path;
+            }
+
+            @Override
+            public boolean check(File worldFolder) {
+                File thisFolder = worldFolder.toPath().resolve(path).toFile();
+                return thisFolder.exists() && thisFolder.isFile();
+            }
+        }
+
+        final class WorldFolder implements WorldFolderSchema {
+            private final String path;
+
+            private WorldFolder(String path) {
+                this.path = path;
+            }
+
+            @Override
+            public boolean check(File worldFolder) {
+                File thisFolder = worldFolder.toPath().resolve(path).toFile();
+                return thisFolder.exists() && thisFolder.isDirectory();
+            }
+        }
     }
 
     /**
diff --git a/src/test/java/org/mvplugins/multiverse/core/mock/MVServerMock.java b/src/test/java/org/mvplugins/multiverse/core/mock/MVServerMock.java
@@ -39,6 +39,8 @@ public World createWorld(@NotNull WorldCreator creator) {
         world.getWorldFolder().mkdirs();
         createFile(new File(world.getWorldFolder(), "uid.dat"));
         createFile(new File(world.getWorldFolder(), "level.dat"));
+        new File(world.getWorldFolder(), "region").mkdir();
+        new File(world.getWorldFolder(), "data").mkdir();
         addWorld(world);
         return world;
     }
diff --git a/src/test/java/org/mvplugins/multiverse/core/world/WorldManagerTest.kt b/src/test/java/org/mvplugins/multiverse/core/world/WorldManagerTest.kt
diff --git a/src/test/java/org/mvplugins/multiverse/core/world/WorldNameCheckerTest.kt b/src/test/java/org/mvplugins/multiverse/core/world/WorldNameCheckerTest.kt

Original file line number	Diff line number	Diff line change
`@@ -244,7 +244,7 @@ private void handleJoinLocation(Player player) {`
`244`	`244`	`}`
`245`	`245`
`246`	`246`	`private void teleportToDestinationOnJoin(Player player, DestinationInstance<?, ?> destination) {`
`247`		`- asyncSafetyTeleporter.to(destination).teleportSingle(player)`
	`247`	`+ asyncSafetyTeleporter.to(destination).passengerMode(config.getPassengerMode()).teleportSingle(player)`
`248`	`248`	`.onSuccess(result -> Logging.fine("Player %s has been teleported on join",`
`249`	`249`	`player.getName()))`
`250`	`250`	`.onFailure(failure -> Logging.warning("Failed to teleport player %s on join: %s",`