Native Support for Adventure Library #60

zvyap · 2026-01-28T14:55:33Z

This pull request addresses issue #29, which I opened previously, to add native support for the Adventure API Component.

Changes in this PR

Added a new module: configlib-adventure, shaded into the Paper and Velocity modules (since both natively support Adventure).
Implemented serializers for Component, Key, and Sound.
Added related tests (some were initially AI-generated, but I reviewed, modified, and approved them).
Added related Javadocs.
Updated readme

Notes

I noticed that running gradle test at the root or within any module only executed tests in the core module. I am not sure whether this behavior was intentional.
I modified the behavior so that:
- Running tests at the root executes all tests across all modules.
- Running tests inside a specific library module runs only that module’s tests.
- Running tests inside a plugin module continues to run core tests, as per the previous behavior.
If the previous test configuration was intentional, please let me know and I will revert the changes accordingly.
I also fixed two failing tests in the core module that were caused by Windows-specific behavior (as shown in the screenshot). All core module tests now pass on Windows.
If you are not satisfied with the changes mentioned above, I am willing to revert or adjust them as needed.

Emibergo02 · 2026-01-28T15:08:17Z

This is cool!

Exlll · 2026-01-30T12:13:12Z

Hey, thanks a lot for your contribution! I have a lot of stuff going on in my private life lately but I will try to find some time this weekend to have a look at it.

Exlll

Besides the things that I commented: I generally try to stay below 80 chars per line. 90 chars per line is a hard limit except for some edge cases and in tests. Could you please reformat your code so that the line length is within these limits?
Also please prefix all top-level classes with Adventure, i.e. AdventureComponentSerializer, AdventureComponentFormat, etc.
Overall pretty nice work 👍

Exlll · 2026-02-01T22:20:35Z

configlib-adventure/src/main/java/de/exlll/configlib/ComponentFormat.java

+    // Hack to avoid compiler error while singleton pattern initialization
+    private static class Patterns {
+        // Pattern to detect any <tag> in a string
+        static final Pattern MINI_MESSAGE_PATTERN = Pattern.compile("<[^>]+>");


This pattern is overly broad and matches strings like < gre eeen > and 3 < 4 and 4 > 2.

Exlll · 2026-02-01T22:23:05Z

configlib-adventure/src/main/java/de/exlll/configlib/ComponentFormat.java

+ */
+public enum ComponentFormat {
+    /** MiniMessage format with tags like {@code <red>} or {@code <bold>}. */
+    MINI_MESSAGE(input -> Patterns.MINI_MESSAGE_PATTERN.matcher(input).find()),


You can just use Pattern.compile("...").asPredicate()

Exlll · 2026-02-01T22:26:31Z

configlib-adventure/src/main/java/de/exlll/configlib/ComponentSerializer.java

+     * @param formats the formats to use, in order of preference
+     */
+    public ComponentSerializer(ComponentFormat... formats) {
+        this(Arrays.asList(formats), Arrays.asList(formats));


You should make a defensive copy here, too. Calling asList is not enough.

I already called List.copyOf in another constructor. This constructor just converts the array to a List to pass it to the other constructor. or I miss understanding here?

Exlll · 2026-02-01T22:27:46Z

configlib-adventure/src/main/java/de/exlll/configlib/ComponentSerializer.java

+            try {
+                return serialize(element, format);
+            } catch (Exception ignored) {
+                // This should never happen, but in case of adventure library issue
+                ignored.printStackTrace();
+            }


Don't do this.

Exlll · 2026-02-01T22:27:53Z

configlib-adventure/src/main/java/de/exlll/configlib/ComponentSerializer.java

+            try {
+                return deserialize(element, format);
+            } catch (Exception ignored) {
+                // This should never happen, but in case of adventure library issue
+                ignored.printStackTrace();
+            }


Don't do this.

Exlll · 2026-02-01T22:58:22Z

configlib-adventure/src/test/java/de/exlll/configlib/KeySerializerTest.java

+        // Key.key("default", "namespace:value") will throw InvalidKeyException because
+        // ':' is not allowed in value
+        assertThrows(Exception.class, () -> serializer.deserialize("namespace:value"));


Don't expect Exception but InvalidKeyException in this case

Exlll · 2026-02-01T23:00:28Z

configlib-core/src/test/java/de/exlll/configlib/SerializersTest.java

            assertThat(
                    serializer.deserialize(new File(TMP_CONFIG_PATH)),
-                    is("/tmp/config.yml")
+                    is(TestUtils.isWindows() ? "C:\\tmp\\config.yml" : "/tmp/config.yml")


Thanks for fixing this. You can use TestUtils.createPlatformSpecificFilePath here.

Exlll · 2026-02-01T23:05:36Z

configlib-velocity/src/main/java/de/exlll/configlib/ConfigLib.java

+@Plugin(id = "configlib", name = "ConfigLib", version = "4.8.0", url = "https://github.com/Exlll/ConfigLib", description = "A library for working with YAML configurations.", authors = {
+        "Exlll" })


Please restore the original format.

Exlll · 2026-02-01T23:08:55Z

configlib-adventure/src/main/java/de/exlll/configlib/SoundSerializer.java

+    @Override
+    public String serialize(Sound element) {
+        StringBuilder builder = new StringBuilder(element.name().asString());
+        if (element.source() != null) {


This if statement is always true.

Exlll · 2026-02-01T23:35:16Z

configlib-adventure/src/main/java/de/exlll/configlib/SoundSerializer.java

+    public Sound deserialize(String element) {
+        String[] parts = element.split(DELIMINATOR);
+        float pitch = 1.0f;
+        float volume = 1.0f;
+        Sound.Source source = defaultSource;
+
+        int endIndex = parts.length - 1;
+
+        // Try to parse source
+        if (endIndex >= 0) {
+            try {
+                source = Sound.Source.valueOf(parts[endIndex]);
+                endIndex--;
+            } catch (IllegalArgumentException ignored) {
+            }
+        }
+
+        // Try to parse volume and pitch
+        if (endIndex >= 0) {
+            Float lastFloat = tryParseFloat(parts[endIndex]);
+            if (lastFloat != null) {
+                boolean hasSecondFloat = false;
+                if (endIndex > 0) {
+                    Float secondLastFloat = tryParseFloat(parts[endIndex - 1]);
+                    if (secondLastFloat != null) {
+                        volume = lastFloat;
+                        pitch = secondLastFloat;
+                        endIndex -= 2;
+                        hasSecondFloat = true;
+                    }
+                }
+
+                if (!hasSecondFloat) {
+                    pitch = lastFloat;
+                    endIndex--;
+                }
+            }
+        }
+
+        Key key = buildKey(parts, endIndex);
+        return Sound.sound(key, source, volume, pitch);
+    }


This parsing logic seems overly complex. Perhaps you can replace this with a Pattern? Something like this:

Pattern pattern = Pattern.compile( """ ^(?<key>[a-zA-Z:]+)\ (?:\\s+(?<volume>\\d+(?:\\.\\d+)?)?)?\ (?:\\s+(?<pitch>\\d+(?:\\.\\d+)?)?)?\ (?:\\s+(?<source>MASTER|AMBIENT|MUSIC)?)?\ \\s*$\ """); Matcher matcher = pattern.matcher("minecraft 0.4 MASTER"); System.out.println(matcher.matches()); System.out.println(matcher.group("key")); System.out.println(matcher.group("volume")); System.out.println(matcher.group("pitch")); System.out.println(matcher.group("source"));

zvyap added 6 commits January 28, 2026 22:06

Implemented adventure library support as additional module

a16c29a

Optimize imports

5943851

Make paper & velocity module depend on adventure on compile

857be59

Fix comment formatted by IDE

dbb4807

Fix tests failed due to windows os

0b47e1e

Added javadocs

9683ceb

Updated readme

4081dcf

Exlll self-assigned this Jan 30, 2026

Exlll requested changes Feb 1, 2026

View reviewed changes

		@Plugin(id = "configlib", name = "ConfigLib", version = "4.8.0", url = "https://github.com/Exlll/ConfigLib", description = "A library for working with YAML configurations.", authors = {
		"Exlll" })

Native Support for Adventure Library #60

Are you sure you want to change the base?

Native Support for Adventure Library #60

Conversation

zvyap commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes in this PR

Notes

Uh oh!

Emibergo02 commented Jan 28, 2026

Uh oh!

Exlll commented Jan 30, 2026

Uh oh!

Exlll left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zvyap commented Jan 28, 2026 •

edited

Loading