Adventure

Support for net.kyori:adventure types.

Installation

Add the following to your build configuration:

pom.xml

<dependencies>
    <dependency>
        <groupId>me.sparky983.warp</groupId>
        <artifactId>warp-adventure</artifactId>
        <version>0.2</version>
    </dependency>
</dependencies>

build.gradle.kts

build.gradle

Mini Message

Warp provides a deserializer for Adventure's MiniMessage format. Warp's architecture allows for strong support of the features of MiniMessage such as and formatters.

Placeholders

A property method returning Component may declare any number of parameters to represent the placeholders to use during deserialization.

Regular Placeholders

A regular placeholder or component placeholder simply replaces the placeholder with the argument provided. The parameter can be most common types as well as Component.

Java

import me.sparky983.warp.Configuration;
import me.sparky983.warp.Property;
import me.sparky983.warp.adventure.Placeholder;
import net.kyori.adventure.text.Component;

@Configuration
interface Messages {
  @Property("greet")
  String greetString(@Placeholder("name") String name);
  
  @Property("greet")
  String greetComponent(@Placeholder("name") Component name);
}

import static net.kyori.adventure.text.format.NamedTextColor.RED;
import me.sparky983.warp.Warp;
import me.sparky983.warp.adventure.ComponentDeserializer;
import net.kyori.adventure.text.Component;

Messages messages = Warp.builder(Messages.class)
    .source(...) // greet: Hello <name>
    .deserializer(Component.class, ComponentDeserializer.miniMessage())
    .build();

assert Component.text("Hello world").equals(messages.greetString("world"));
assert Component.text("Hello ").append(Component.text("world", RED))
    .equals(messages.greetComponent(Component.text("world", RED)));

Kotlin

Parsed Placeholders

@Placeholder.Parsed is used to insert a placeholder that will be parsed by MiniMessage:

Java

import me.sparky983.warp.Configuration;
import me.sparky983.warp.Configuration;
import me.sparky983.warp.adventure.Placeholder;
import net.kyori.adventure.text.Component;

@Configuration
interface Messages {
  @Property("greet")
  String greet(@Placeholder.Parsed("name") String name);
}

import static net.kyori.adventure.text.format.NamedTextColor.RED;
import me.sparky983.warp.Warp;
import me.sparky983.warp.adventure.ComponentDeserializer;
import net.kyori.adventure.text.Component;

Messages messages = Warp.builder(Messages.class)
    .source(...) // greet: Hello <name>
    .deserializer(Component.class, ComponentDeserializer.miniMessage())
    .build();

assert Component.text("Hello ").append(Component.text("world", RED))
    .equals(messages.greet("<red>world"));

Kotlin

Choice Placeholders

Choice placeholders allow for conditional replacements based on the value:

Java

import me.sparky983.warp.Configuration;
import me.sparky983.warp.Property;
import me.sparky983.warp.adventure.Placeholder;

@Configuration
interface Messages {
  @Property("people")
  Component people(@Placeholder.Choice("people") int numberOfPeople);

  @Property("yes-no")
  Component yesNo(@Placeholder.Choice("bool") boolean bool);
}

import me.sparky983.warp.Warp;
import me.sparky983.warp.adventure.ConfigurationDeserializer;
import net.kyori.adventure.text.Component;

Messages messages = Warp.builder(PeopleConfiguration.class)
    .source(...) // people: <people:'0#no one|1#someone|1<everyone'>
                 // yes-no: <bool:yes:no>
    .deserializer(Component.class, ConfigurationDeserializer.miniMessage())
    .build();

assert Component.text("no one").equals(messages.people(0));
assert Component.text("someone").equals(messages.people(1));
assert Component.text("everyone").equals(messages.people(2));
assert Component.text("everyone").equals(messages.people(3));
assert Component.text("yes").equals(messages.yesNo(true));
assert Component.text("no").equals(messages.yesNo(false));

Kotlin

Format Placeholders

Format placeholders apply a format before replacing the placeholder:

Java

import java.time.LocalDate;
import me.sparky983.warp.Configuration;
import me.sparky983.warp.Property;
import me.sparky983.warp.adventure.Placeholder;

@Configuration
interface Messages {
  @Property("balance")
  Component balance(@Placeholder.Format("balance") double balance);

  @Property("date")
  Component date(@Placeholder.Format("date") LocalDate date);
}

import java.time.LocalDate;
import me.sparky983.warp.Warp;
import me.sparky983.warp.adventure.ConfigurationDeserializer;
import net.kyori.adventure.text.Component;

Messages messages = Warp.builder(PeopleConfiguration.class)
    .source(...) // balance: Your balance is $<balance:'#.00'>
                 // date: Today's date is <date:'d/M/yyyy'>
    .deserializer(Component.class, ConfigurationDeserializer.miniMessage())
    .build();

assert Component.text("Your balance is $10.50").equals(messages.balance(10.50));
assert Component.text("Today's date is 19/12/2025").equals(messages.date(LocalDate.of(2025, 12, 19));

Kotlin

Generic Deserializer

A Warp deserializer can be made from any Adventure component deserializer.

Java

import me.sparky983.warp.Configuration;
import me.sparky983.warp.Property;
import net.kyori.adventure.text.Component;

@Configuration
interface Messages {
  @Property("startup-log")
  Component startup();
}

import static net.kyori.adventure.text.format.NamedTextColor.GRAY;
import me.sparky983.warp.Warp;
import me.sparky983.warp.adventure.ComponentDeserializer;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;

Messages messages = Warp.builder(Messages.class)
    .source(...) // startup-log: &7Plugin successfully started
    .deserializer(Component.class, ComponentDeserializer.deserializer(LegacyComponentSerializer.legacyAmpersand()))
    .build();

assert Component.text("Plugin successfully started", GRAY).equals(messages.startup());

Kotlin