Stable 1.21.4 and API 4.0 release

.gitignore

@@ -1,18 +1,17 @@
-*.iml
-*.ipr
-*.iws
 .idea/
-.classpath
-.project
-.settings/
-slimeworldmanager-test/
-.DS_Store/
-release.properties
-libs/
-.gradle/
+.vscode/
+
+**/.gradle/
+.DS_Store
 build/
-slimeworldmanager-api
-slimeworldmanager-server
-run
-*.hprof
-paper-api-generator
+**/run/
+
+**/*.iml
+
+aspaper-server/build.gradle.kts
+aspaper-server/src/minecraft/
+paper-server/
+aspaper-api/build.gradle.kts
+paper-api/
+paper-api-generator/
+aspaper-server/.gradle/

README.md

@@ -14,8 +14,6 @@ builds can be found in the [Discord](https://discord.gg/YevvsMa) under the #aspa
 ## Wiki
 For API and usage info check out the docs at https://infernalsuite.com/
 
-**If you run into any Flow-NBT errors when building your project, add the additional repository: `https://repo.rapture.pw/repository/maven-releases/`**
-
 ## Javadocs
 The Javadocs can be found [here](https://docs.infernalsuite.com/).
 

api/build.gradle.kts

@@ -1,96 +1,16 @@
 plugins {
-    `java-library`
-     `maven-publish`
-    signing
+    id("asp.base-conventions")
+    id("asp.publishing-conventions")
 }
 
 dependencies {
-    api("com.flowpowered:flow-nbt:2.0.2")
-    api("org.jetbrains:annotations:23.0.0")
+    api(libs.annotations)
+    api(libs.adventure.nbt)
 
-    compileOnly("io.papermc.paper:paper-api:1.21-R0.1-SNAPSHOT")
+    compileOnly(paperApi())
 }
 
-version = "3.0.0-SNAPSHOT"
-
-java {
-    withSourcesJar()
-    withJavadocJar()
-}
-
-profiles {
-    profile("publish") {
-        activation {
-            property {
-                setKey("publish")
-                setValue("true")
-            }
-        }
-        action {
-            publishing {
-                publications {
-                    create<MavenPublication>("maven") {
-                        groupId = "${project.group}"
-                        artifactId = project.name
-                        version = "${project.version}"
-
-                        from(components["java"])
-
-                        pom {
-                            name.set("Advanced Slime Paper API")
-                            description.set("API for ASP")
-                            url.set("https://github.com/InfernalSuite/AdvancedSlimePaper")
-                            licenses {
-                                license {
-                                    name.set("GNU General Public License, Version 3.0")
-                                    url.set("https://www.gnu.org/licenses/gpl-3.0.txt")
-                                }
-                            }
-                            developers {
-                                developer {
-                                    id.set("InfernalSuite")
-                                    name.set("The InfernalSuite Team")
-                                    url.set("https://github.com/InfernalSuite")
-                                    email.set("infernalsuite@gmail.com")
-                                }
-                            }
-                            scm {
-                                connection.set("scm:git:https://github.com:InfernalSuite/AdvancedSlimePaper.git")
-                                developerConnection.set("scm:git:ssh://github.com:InfernalSuite/AdvancedSlimePaper.git")
-                                url.set("https://github.com/InfernalSuite/AdvancedSlimePaper/")
-                            }
-                            issueManagement {
-                                system.set("Github")
-                                url.set("https://github.com/InfernalSuite/AdvancedSlimePaper/issues")
-                            }
-                        }
-
-                        versionMapping {
-                            usage("java-api") {
-                                fromResolutionOf("runtimeClasspath")
-                            }
-                            usage("java-runtime") {
-                                fromResolutionResult()
-                            }
-                        }
-                    }
-                }
-                repositories {
-                    maven {
-                        name = "infernalsuite"
-                        url = uri("https://repo.infernalsuite.com/repository/maven-snapshots/")
-                        credentials {
-                            username = project.property("ISUsername") as String?
-                            password = project.property("ISPassword") as String?
-                        }
-                    }
-                }
-            }
-
-            signing {
-                useGpgCmd()
-                sign(publishing.publications["maven"])
-            }
-        }
-    }
+publishConfiguration {
+    name = "Advanced Slime Paper API"
+    description = "API for Advanced Slime Paper"
 }

api/src/main/java/com/infernalsuite/aswm/api/AdvancedSlimePaperAPI.java → api/src/main/java/com/infernalsuite/asp/api/AdvancedSlimePaperAPI.java

@@ -1,9 +1,17 @@
-package com.infernalsuite.aswm.api;
+package com.infernalsuite.asp.api;
 
-import com.infernalsuite.aswm.api.exceptions.*;
-import com.infernalsuite.aswm.api.world.SlimeWorld;
-import com.infernalsuite.aswm.api.world.properties.SlimePropertyMap;
-import com.infernalsuite.aswm.api.loaders.SlimeLoader;
+import com.infernalsuite.asp.api.exceptions.CorruptedWorldException;
+import com.infernalsuite.asp.api.exceptions.InvalidWorldException;
+import com.infernalsuite.asp.api.exceptions.NewerFormatException;
+import com.infernalsuite.asp.api.exceptions.UnknownWorldException;
+import com.infernalsuite.asp.api.exceptions.WorldAlreadyExistsException;
+import com.infernalsuite.asp.api.exceptions.WorldLoadedException;
+import com.infernalsuite.asp.api.exceptions.WorldTooBigException;
+import com.infernalsuite.asp.api.loaders.SlimeSerializationAdapter;
+import com.infernalsuite.asp.api.world.SlimeWorld;
+import com.infernalsuite.asp.api.world.SlimeWorldInstance;
+import com.infernalsuite.asp.api.world.properties.SlimePropertyMap;
+import com.infernalsuite.asp.api.loaders.SlimeLoader;
 import net.kyori.adventure.util.Services;
 import org.bukkit.World;
 import org.jetbrains.annotations.ApiStatus;
@@ -44,28 +52,28 @@ SlimeWorld readWorld(SlimeLoader loader, String worldName, boolean readOnly, Sli
      * @param worldName the name of the world to get
      * @return the loaded world, or {@code null} if no loaded world matches the given name
      */
-    SlimeWorld getLoadedWorld(String worldName);
+    SlimeWorldInstance getLoadedWorld(String worldName);
 
     /**
      * Gets a list of worlds which have been loaded by ASWM.
      * Note: The returned list is immutable, and encompasses a view of the loaded worlds at the time of the method call.
      *
      * @return a list of worlds
      */
-    List<SlimeWorld> getLoadedWorlds();
+    List<SlimeWorldInstance> getLoadedWorlds();
 
     /**
      * Generates a Minecraft World from a {@link SlimeWorld} and
      * adds it to the server's world list.
      * <br>
      * <b>This method must be called in sync with the Server Thread</b>
      *
-     * @param world              {@link SlimeWorld} world to be added to the server's world list
+     * @param world              {@link SlimeWorldInstance} world to be added to the server's world list
      * @param callWorldLoadEvent Whether to call {@link org.bukkit.event.world.WorldLoadEvent}
      * @throws IllegalArgumentException if the world is already loaded
      * @return Returns a slime world representing a live minecraft world
      */
-    SlimeWorld loadWorld(SlimeWorld world, boolean callWorldLoadEvent) throws IllegalArgumentException;
+    SlimeWorldInstance loadWorld(SlimeWorld world, boolean callWorldLoadEvent) throws IllegalArgumentException;
 
     /**
      * Checks if a {@link SlimeWorld} is loaded on the server.
@@ -126,6 +134,17 @@ SlimeWorld readWorld(SlimeLoader loader, String worldName, boolean readOnly, Sli
      */
     SlimeWorld readVanillaWorld(File worldDir, String worldName, @Nullable SlimeLoader loader) throws InvalidWorldException, WorldLoadedException, WorldTooBigException, IOException, WorldAlreadyExistsException;
 
+    /**
+     * Returns the {@link SlimeSerializationAdapter} used to serialize and deserialize SlimeWorlds.
+     * Manual de-/serialization is considered experimental and may change in future versions.
+     * <p>
+     * <strong>Please use SlimeLoaders where possible</strong>
+     *
+     * @return A adapter for serializing and deserializing SlimeWorlds
+     */
+    @ApiStatus.Experimental
+    SlimeSerializationAdapter getSerializer();
+
     /**
      * Gets the instance of the AdvancedSlimePaper API.
      *

api/src/main/java/com/infernalsuite/asp/api/SlimeDataConverter.java

@@ -0,0 +1,22 @@
+package com.infernalsuite.asp.api;
+
+import com.infernalsuite.asp.api.world.SlimeWorld;
+import net.kyori.adventure.nbt.CompoundBinaryTag;
+import net.kyori.adventure.nbt.ListBinaryTag;
+import org.jetbrains.annotations.ApiStatus;
+
+import java.util.List;
+
+@ApiStatus.Internal
+public interface SlimeDataConverter {
+
+    // Will return new (fixed) instance
+    SlimeWorld applyDataFixers(SlimeWorld world);
+
+    CompoundBinaryTag convertChunkTo1_13(CompoundBinaryTag globalTag);
+
+    List<CompoundBinaryTag> convertEntities(List<CompoundBinaryTag> input, int from, int to);
+    List<CompoundBinaryTag> convertTileEntities(List<CompoundBinaryTag> input, int from, int to);
+    ListBinaryTag convertBlockPalette(ListBinaryTag input, int from, int to);
+
+}

api/src/main/java/com/infernalsuite/aswm/api/SlimeNMSBridge.java → api/src/main/java/com/infernalsuite/asp/api/SlimeNMSBridge.java

@@ -1,15 +1,16 @@
-package com.infernalsuite.aswm.api;
+package com.infernalsuite.asp.api;
 
-import com.flowpowered.nbt.CompoundMap;
-import com.flowpowered.nbt.CompoundTag;
-import com.infernalsuite.aswm.api.world.SlimeWorld;
-import com.infernalsuite.aswm.api.world.SlimeWorldInstance;
+import com.infernalsuite.asp.api.world.SlimeWorld;
+import com.infernalsuite.asp.api.world.SlimeWorldInstance;
+import net.kyori.adventure.nbt.CompoundBinaryTag;
+import net.kyori.adventure.nbt.ListBinaryTag;
 import net.kyori.adventure.util.Services;
 import org.bukkit.World;
 import org.bukkit.persistence.PersistentDataContainer;
 import org.jetbrains.annotations.ApiStatus;
 
 import java.io.IOException;
+import java.util.List;
 
 @ApiStatus.Internal
 public interface SlimeNMSBridge {
@@ -27,24 +28,18 @@ public interface SlimeNMSBridge {
 
     SlimeWorldInstance getInstance(World world);
 
-    // Will return new (fixed) instance
-    SlimeWorld applyDataFixers(SlimeWorld world);
-
     int getCurrentVersion();
 
     static SlimeNMSBridge instance() {
         return Holder.INSTANCE;
     }
 
-    void extractCraftPDC(PersistentDataContainer source, CompoundMap target);
+    void extractCraftPDC(PersistentDataContainer source, CompoundBinaryTag.Builder builder);
 
-    PersistentDataContainer extractCompoundMapIntoCraftPDC(CompoundMap source);
+    SlimeDataConverter getSlimeDataConverter();
 
     @ApiStatus.Internal
     class Holder {
         private static final SlimeNMSBridge INSTANCE = Services.service(SlimeNMSBridge.class).orElseThrow();
     }
-
-    CompoundTag convertChunkTo1_13(CompoundTag tag);
-
 }

api/src/main/java/com/infernalsuite/aswm/api/events/LoadSlimeWorldEvent.java → api/src/main/java/com/infernalsuite/asp/api/events/LoadSlimeWorldEvent.java

@@ -1,6 +1,6 @@
-package com.infernalsuite.aswm.api.events;
+package com.infernalsuite.asp.api.events;
 
-import com.infernalsuite.aswm.api.world.SlimeWorld;
+import com.infernalsuite.asp.api.world.SlimeWorldInstance;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.NotNull;
@@ -10,9 +10,9 @@
 public class LoadSlimeWorldEvent extends Event {
 
   private static final HandlerList handlers = new HandlerList();
-  private final SlimeWorld slimeWorld;
+  private final SlimeWorldInstance slimeWorld;
 
-  public LoadSlimeWorldEvent(SlimeWorld slimeWorld) {
+  public LoadSlimeWorldEvent(SlimeWorldInstance slimeWorld) {
     super(false);
     this.slimeWorld = Objects.requireNonNull(slimeWorld, "slimeWorld cannot be null");
   }
@@ -26,7 +26,7 @@ public static HandlerList getHandlerList() {
     return handlers;
   }
 
-  public SlimeWorld getSlimeWorld() {
+  public SlimeWorldInstance getSlimeWorld() {
     return slimeWorld;
   }
 }

api/src/main/java/com/infernalsuite/aswm/api/exceptions/CorruptedWorldException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/CorruptedWorldException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Exception thrown when a world could not

api/src/main/java/com/infernalsuite/asp/api/exceptions/InvalidWorldException.java

@@ -0,0 +1,28 @@
+package com.infernalsuite.asp.api.exceptions;
+
+import java.io.File;
+import java.nio.file.Path;
+
+/**
+ * Exception thrown when a folder does
+ * not contain a valid Minecraft world.
+ */
+public class InvalidWorldException extends SlimeException {
+
+    public InvalidWorldException(Path worldDir, String reason) {
+        super("Directory " + worldDir.toString() + " does not contain a valid MC world! " + reason);
+    }
+
+    public InvalidWorldException(Path worldDir) {
+        super("Directory " + worldDir.toString() + " does not contain a valid MC world!");
+    }
+
+    public static InvalidWorldException legacy(File worldDir, String reason) {
+        return new InvalidWorldException(worldDir.toPath(), reason);
+    }
+
+    public static InvalidWorldException legacy(File worldDir) {
+        return new InvalidWorldException(worldDir.toPath());
+    }
+
+}

api/src/main/java/com/infernalsuite/aswm/api/exceptions/NewerFormatException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/NewerFormatException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Exception thrown when a world is encoded

api/src/main/java/com/infernalsuite/aswm/api/exceptions/SlimeException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/SlimeException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Generic SWM exception.

api/src/main/java/com/infernalsuite/aswm/api/exceptions/UnknownWorldException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/UnknownWorldException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Exception thrown when a

api/src/main/java/com/infernalsuite/aswm/api/exceptions/WorldAlreadyExistsException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/WorldAlreadyExistsException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Exception thrown when a world

api/src/main/java/com/infernalsuite/aswm/api/exceptions/WorldLoadedException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/WorldLoadedException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Exception thrown when a world is loaded

api/src/main/java/com/infernalsuite/aswm/api/exceptions/WorldTooBigException.java → api/src/main/java/com/infernalsuite/asp/api/exceptions/WorldTooBigException.java

@@ -1,4 +1,4 @@
-package com.infernalsuite.aswm.api.exceptions;
+package com.infernalsuite.asp.api.exceptions;
 
 /**
  * Exception thrown when a MC world is