Separate paper into paper and adventure.

Biquaternions · Biquaternions · commit 3b7f76ddb8c5 · 2025-11-15T11:17:33.000-05:00
Paper (for plugins)
Adventure (for platforms or plugins too)
diff --git a/adventure/build.gradle.kts b/adventure/build.gradle.kts
@@ -0,0 +1,10 @@
+
+repositories {
+    maven("https://repo.papermc.io/repository/maven-public/")
+}
+
+dependencies {
+    compileOnly(project(":core"))
+    compileOnly("net.kyori:adventure-api:4.25.0")
+    compileOnly("net.kyori:adventure-text-minimessage:4.25.0")
+}
diff --git a/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/AdventureConfigHandler.java b/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/AdventureConfigHandler.java
@@ -0,0 +1,64 @@
+package net.j4c0b3y.api.config.platform.adventure;
+
+import net.j4c0b3y.api.config.ConfigHandler;
+import net.j4c0b3y.api.config.platform.adventure.provider.MiniMessageProvider;
+import net.j4c0b3y.api.config.platform.adventure.provider.PrefixedComponentProvider;
+import net.j4c0b3y.api.config.platform.adventure.types.MiniComponent;
+import net.j4c0b3y.api.config.platform.adventure.types.PrefixedComponent;
+import net.kyori.adventure.text.Component;
+
+import java.util.logging.Logger;
+
+/**
+ * Used for registering providers, backups,
+ * and general config management.
+ * Also binds bukkit specific providers.
+ *
+ * @author Biquaternions
+ * @version ConfigAPI
+ * @since 11/14/2025
+ */
+public class AdventureConfigHandler extends ConfigHandler {
+
+    /**
+     * Creates a new config handler instance,
+     * registers default resolvers and providers.
+     *
+     * @param logger The logger used to warn for destructive actions.
+     */
+    public AdventureConfigHandler(Logger logger, Component prefix) {
+        super(logger);
+
+        this.bind(MiniComponent.class, new MiniMessageProvider());
+        this.bind(PrefixedComponent.class, new PrefixedComponentProvider(prefix));
+    }
+
+    /**
+     * Creates a new config handler instance,
+     * registers default resolvers and providers.
+     * Uses a logger with name "ConfigAPI".
+     * Does not contain a prefix.
+     */
+    public AdventureConfigHandler() {
+        this(Logger.getLogger("ConfigAPI"), Component.empty());
+    }
+
+    /**
+     * Creates a new config handler instance,
+     * registers default resolvers and providers.
+     * Uses a logger with name "ConfigAPI".
+     */
+    public AdventureConfigHandler(Component prefix) {
+        this(Logger.getLogger("ConfigAPI"), prefix);
+    }
+
+    /**
+     * Creates a new config handler instance,
+     * registers default resolvers and providers.
+     * Does not contain a prefix.
+     */
+    public AdventureConfigHandler(Logger logger) {
+        this(logger, Component.empty());
+    }
+
+}
diff --git a/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/provider/MiniMessageProvider.java b/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/provider/MiniMessageProvider.java
@@ -0,0 +1,27 @@
+package net.j4c0b3y.api.config.platform.adventure.provider;
+
+import net.j4c0b3y.api.config.platform.adventure.types.MiniComponent;
+import net.j4c0b3y.api.config.provider.TypeProvider;
+import net.j4c0b3y.api.config.provider.context.LoadContext;
+import net.j4c0b3y.api.config.provider.context.SaveContext;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class MiniMessageProvider implements TypeProvider<MiniComponent> {
+
+    @NotNull
+    @Override
+    public MiniComponent load(@NotNull LoadContext context) {
+        if (context.getObject() instanceof String string) {
+            return new MiniComponent(string);
+        }
+        throw new IllegalStateException("Failed to parse MiniMessage");
+    }
+
+    @Nullable
+    @Override
+    public Object save(@NotNull SaveContext<MiniComponent> context) {
+        return context.getObject().getRaw();
+    }
+
+}
diff --git a/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/provider/PrefixedComponentProvider.java b/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/provider/PrefixedComponentProvider.java
@@ -1,6 +1,6 @@
-package net.j4c0b3y.api.config.platform.paper.provider;
+package net.j4c0b3y.api.config.platform.adventure.provider;
 
-import net.j4c0b3y.api.config.platform.paper.types.PrefixedComponent;
+import net.j4c0b3y.api.config.platform.adventure.types.PrefixedComponent;
 import net.j4c0b3y.api.config.provider.TypeProvider;
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
@@ -21,7 +21,7 @@ public PrefixedComponent load(@NotNull LoadContext context) {
         if (context.getObject() instanceof String string) {
             return new PrefixedComponent(this.prefix, string);
         }
-        throw new IllegalStateException();
+        throw new IllegalStateException("Failed to parse prefixed component");
     }
 
     @NotNull
diff --git a/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/types/MiniComponent.java b/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/types/MiniComponent.java
@@ -0,0 +1,20 @@
+package net.j4c0b3y.api.config.platform.adventure.types;
+
+import lombok.Getter;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.minimessage.MiniMessage;
+
+public class MiniComponent {
+
+    @Getter
+    private final String raw;
+
+    @Getter
+    private final Component component;
+
+    public MiniComponent(String raw) {
+        this.raw = raw;
+        this.component = MiniMessage.miniMessage().deserialize(this.raw);
+    }
+
+}
diff --git a/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/types/PrefixedComponent.java b/adventure/src/main/java/net/j4c0b3y/api/config/platform/adventure/types/PrefixedComponent.java
@@ -1,4 +1,4 @@
-package net.j4c0b3y.api.config.platform.paper.types;
+package net.j4c0b3y.api.config.platform.adventure.types;
 
 import lombok.Getter;
 import net.kyori.adventure.text.Component;
@@ -17,7 +17,7 @@ public class PrefixedComponent {
 
     public PrefixedComponent(Component prefix, String raw) {
         this.raw = raw;
-        this.unprefixed = MiniMessage.miniMessage().deserialize(raw);
+        this.unprefixed = MiniMessage.miniMessage().deserialize(this.raw);
         this.component = prefix.append(this.unprefixed);
     }
 
diff --git a/core/src/main/java/net/j4c0b3y/api/config/StaticConfig.java b/core/src/main/java/net/j4c0b3y/api/config/StaticConfig.java
@@ -152,11 +152,6 @@ public List<String> getFooter() {
         return Arrays.asList(footer.value());
     }
 
-    public final void initialize() {
-        this.load();
-        this.save();
-    }
-
     public void afterLoad() {}
 
     /**
@@ -199,6 +194,14 @@ public void load() {
                 }
             }
 
+            // Save the field values to the config document.
+            save();
+
+            // If configured, we should format values.
+            if (handler.isFormatValues()) {
+                format();
+            }
+
         } catch (Exception exception) {
             // Load was unsuccessful, prevent saving.
             success = false;
@@ -241,11 +244,6 @@ public void save() {
             // Set the additional custom comments specified by the user.
             this.setComments();
 
-            // If configured, we should format values.
-            if (handler.isFormatValues()) {
-                this.format();
-            }
-
             // Save the document values and comments to file.
             document.save();
         } catch (Exception exception) {
@@ -424,6 +422,8 @@ protected void format() throws IOException {
                 );
             }
 
+            // Save the formatted values to file.
+            document.save();
         } catch (Exception exception) {
             throw new IOException("Format failed for file '" + file.getName() + "'.", exception);
         }
diff --git a/paper/build.gradle.kts b/paper/build.gradle.kts
@@ -4,6 +4,8 @@ repositories {
 }
 
 dependencies {
-    implementation(project(":core"))
+    compileOnly(project(":core"))
+    implementation(project(":adventure"))
+
     compileOnly("io.papermc.paper:paper-api:1.21.10-R0.1-SNAPSHOT")
 }
diff --git a/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/PaperConfigHandler.java b/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/PaperConfigHandler.java
@@ -1,8 +1,7 @@
 package net.j4c0b3y.api.config.platform.paper;
 
-import net.j4c0b3y.api.config.ConfigHandler;
+import net.j4c0b3y.api.config.platform.adventure.AdventureConfigHandler;
 import net.j4c0b3y.api.config.platform.paper.provider.*;
-import net.j4c0b3y.api.config.platform.paper.types.PrefixedComponent;
 import net.j4c0b3y.api.config.platform.paper.types.WorldReference;
 import net.kyori.adventure.text.Component;
 import org.bukkit.Location;
@@ -20,7 +19,7 @@
  * @version ConfigAPI
  * @since 11/14/2025
  */
-public class PaperConfigHandler extends ConfigHandler {
+public class PaperConfigHandler extends AdventureConfigHandler {
 
     /**
      * Creates a new config handler instance,
@@ -29,12 +28,10 @@ public class PaperConfigHandler extends ConfigHandler {
      * @param logger The logger used to warn for destructive actions.
      */
     public PaperConfigHandler(Logger logger, Component prefix) {
-        super(logger);
+        super(logger, prefix);
 
-        this.bind(Component.class, new ComponentProvider());
         this.bind(ItemStack.class, new ItemStackProvider());
         this.bind(Location.class, new LocationProvider());
-        this.bind(PrefixedComponent.class, new PrefixedComponentProvider(prefix));
         this.bind(Vector.class, new VectorProvider());
         this.bind(WorldReference.class, new WorldProvider());
     }
@@ -43,17 +40,28 @@ public PaperConfigHandler(Logger logger, Component prefix) {
      * Creates a new config handler instance,
      * registers default resolvers and providers.
      * Uses a logger with name "ConfigAPI".
+     * Does not contain a prefix.
      */
     public PaperConfigHandler() {
-        this(Logger.getLogger("ConfigAPI"), Component.empty());
+        super(Logger.getLogger("ConfigAPI"), Component.empty());
     }
 
+    /**
+     * Creates a new config handler instance,
+     * registers default resolvers and providers.
+     * Uses a logger with name "ConfigAPI".
+     */
     public PaperConfigHandler(Component prefix) {
-        this(Logger.getLogger("ConfigAPI"), prefix);
+        super(Logger.getLogger("ConfigAPI"), prefix);
     }
+    /**
+     * Creates a new config handler instance,
+     * registers default resolvers and providers.
+     * Does not contain a prefix.
+     */
 
     public PaperConfigHandler(Logger logger) {
-        this(logger, Component.empty());
+        super(logger, Component.empty());
     }
 
 }
diff --git a/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/ComponentProvider.java b/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/ComponentProvider.java
diff --git a/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/ItemStackProvider.java b/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/ItemStackProvider.java
@@ -104,7 +104,7 @@ public ItemStack load(@NotNull LoadContext context) {
 
             return result.ensureServerConversions(); // Paper
         }
-        throw new IllegalStateException("Failed to load ItemStack");
+        throw new IllegalStateException("Failed to parse ItemStack");
     }
 
     @Nullable
diff --git a/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/LocationProvider.java b/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/LocationProvider.java
@@ -26,7 +26,7 @@ public Location load(@NotNull LoadContext context) {
             }
             return new Location(world, (double) map.get("x"), (double) map.get("y"), (double) map.get("z"), (float) map.get("yaw"), (float) map.get("pitch"));
         }
-        throw new IllegalStateException("Location format not valid");
+        throw new IllegalStateException("Failed to parse Location");
     }
 
     @NotNull
diff --git a/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/VectorProvider.java b/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/VectorProvider.java
@@ -31,7 +31,7 @@ public Vector load(@NotNull LoadContext context) {
 
             return new Vector(x, y, z);
         }
-        throw new IllegalStateException("Vector format not valid");
+        throw new IllegalStateException("Failed to parse Vector");
     }
 
     @Nullable
diff --git a/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/WorldProvider.java b/paper/src/main/java/net/j4c0b3y/api/config/platform/paper/provider/WorldProvider.java
@@ -15,7 +15,7 @@ public WorldReference load(@NotNull LoadContext context) {
         if (context.getObject() instanceof String) {
             return new WorldReference((String) context.getObject());
         }
-        throw new IllegalArgumentException("Cannot serialize world entry");
+        throw new IllegalArgumentException("Failed to parse world");
     }
 
     @Nullable
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,2 +1,2 @@
 rootProject.name = "ConfigAPI"
-include("core", "paper")
+include("core", "adventure", "paper")

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@ repositories {`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`dependencies {`
`7`		`- implementation(project(":core"))`
	`7`	`+ compileOnly(project(":core"))`
	`8`	`+ implementation(project(":adventure"))`
	`9`	`+`
`8`	`10`	`compileOnly("io.papermc.paper:paper-api:1.21.10-R0.1-SNAPSHOT")`
`9`	`11`	`}`