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 👍

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

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

configlib-adventure/src/main/java/de/exlll/configlib/AdventureComponentSerializer.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?

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

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

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

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

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

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"));

Fixed by using regex (provide by you) with dynamic generation to respect DELIMINATOR field and Sound.Source enum

Should I fallback to defaultSource if input source is not valid or throw an Exception? The current way is fallback to defaultSource.

Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment)

Copilot

Pull request overview

Adds first-party Adventure API type support to ConfigLib via a new configlib-adventure module, and wires it into the Paper and Velocity plugin modules for convenient defaults.

Changes:

Introduces configlib-adventure with serializers/default-registration for Component, Key, and Sound, plus new tests.
Integrates Adventure defaults into Paper/Velocity (PAPER_DEFAULT_PROPERTIES, VELOCITY_DEFAULT_PROPERTIES) and updates their Gradle dependencies.
Improves Windows portability in core tests and updates README documentation for the new module.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
settings.gradle.kts	Adds the new `configlib-adventure` module to the Gradle build.
configlib-adventure/build.gradle.kts	Declares Adventure-related dependencies and test dependencies for the new module.
configlib-adventure/src/main/java/de/exlll/configlib/AdventureConfigLib.java	Adds a helper to register Adventure serializers onto a properties builder.
configlib-adventure/src/main/java/de/exlll/configlib/AdventureComponentSerializer.java	Implements `Component` serialization/deserialization across multiple formats.
configlib-adventure/src/main/java/de/exlll/configlib/AdventureComponentFormat.java	Defines format detection/matching for `Component` strings.
configlib-adventure/src/main/java/de/exlll/configlib/AdventureKeySerializer.java	Implements `Key` serialization/deserialization with optional default namespace behavior.
configlib-adventure/src/main/java/de/exlll/configlib/AdventureSoundSerializer.java	Implements compact `Sound` string serialization/deserialization.
configlib-adventure/src/test/java/de/exlll/configlib/AdventureTestConfiguration.java	Adds a configuration type covering many Adventure values for round-trip testing.
configlib-adventure/src/test/java/de/exlll/configlib/AdventureConfigurationTests.java	Adds round-trip tests for saving/loading Adventure-backed configurations.
configlib-adventure/src/test/java/de/exlll/configlib/AdventureComponentTests.java	Adds tests validating multi-format `Component` deserialization order.
configlib-adventure/src/test/java/de/exlll/configlib/AdventureKeySerializerTest.java	Adds tests for `Key` serialization/deserialization behavior.
configlib-adventure/src/test/java/de/exlll/configlib/AdventureSoundSerializerTest.java	Adds tests for `Sound` serialization/deserialization behavior.
configlib-paper/src/main/java/de/exlll/configlib/ConfigLib.java	Adds `PAPER_DEFAULT_PROPERTIES` and refactors builder construction.
configlib-paper/build.gradle.kts	Adds dependency on `configlib-adventure` and ensures its checks run for plugin compilation.
configlib-velocity/src/main/java/de/exlll/configlib/ConfigLib.java	Adds `VELOCITY_DEFAULT_PROPERTIES` for Adventure-enabled defaults.
configlib-velocity/build.gradle.kts	Adds dependency on `configlib-adventure` and ensures its checks run for plugin compilation.
configlib-core/src/testFixtures/java/de/exlll/configlib/TestUtils.java	Adds `isWindows()` and refactors Windows path handling helper.
configlib-core/src/test/java/de/exlll/configlib/SerializersTest.java	Updates expected file-path strings to be platform-specific.
buildSrc/src/main/kotlin/libs-config.gradle.kts	Removes cross-project `compileJava` → `core:check` dependency from libs config.
README.md	Documents Adventure module usage and Paper default properties updates.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

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

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

README.md

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

README.md

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

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

zvyap · 2026-02-03T08:03:03Z

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 👍

Reformatted code to 80 chars per line, 90 chars hard limit
Preffixed Adventure related top level classes
Changes completed except question waiting for reply
Reviewed and make changes accordingly with suggestion from copilot

@Exlll

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

zvyap added 6 commits February 3, 2026 10:31

Fix PR requested changes

50a1adf

Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment) Fix: Exlll#60 (comment)

Change MiniMessage detection pattern to more strict

e6dd5bd

Make sound source generate dynamically

1f81d39

Format code to 80 chars per line

2e6490a

Prefix all top level file

60883de

Make sound serializer regex respect DELIMINATOR

c5ff729

Copilot AI review requested due to automatic review settings February 3, 2026 06:29

Copilot started reviewing on behalf of zvyap February 3, 2026 06:29 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

zvyap and others added 6 commits February 3, 2026 14:48

Update README.md for miss type

ddf147e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update JavaDocs for grammer error by AI

5347252

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix readme class name

6add010

Merge branch 'master' of https://github.com/zvyap/ConfigLib

35c6c5f

Fix issue mention by copilot

0350ec4

Add test and fix TranslatableComponent round trip issue

e016dad

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!

Uh oh!

Uh oh!

Exlll Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

zvyap Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Exlll Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

zvyap Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

zvyap Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zvyap commented Feb 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zvyap commented Jan 28, 2026 •

edited

Loading