PaperUI

A Java/Kotlin library for creating user interfaces on Paper servers

How to use

You need to add PaperUI as a plugin to your Paper server. To develop plugins, add PaperUI to your dependencies in plugin.yml or paper-plugin.yml and add Maven dependency to your buildscript.

Maven

<repositories>
    <repository>
        <id>DiruptioPublic</id>
        <url>https://repo.diruptio.de/repository/maven-public</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>de.fabiexe</groupId>
        <artifactId>PaperUI</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

Gradle

repositories {
    maven("https://repo.diruptio.de/repository/maven-public")
}

dependencies {
    compileOnly("de.fabiexe:PaperUI:VERSION")
}

DialogUI

A dialog user interface can have properties/inputs, buttons and action buttons. Example:

Kotlin

enum class PizzaType {
    MARGHERITA, FUNGHI, PROSCIUTTO
}

fun create(audience: Audience) = DialogUI(audience).apply {
    title("Order a Pizza")
    val type = enumProperty("Type", PizzaType::class.java)
    val extraCheese = booleanProperty("Add Extra Cheese")
    val radius = doubleProperty("Radius (cm)", 15.0, 20.0)
    val amount = integerProperty("Amount", 1, 10, 1)
    val address = stringProperty("Address")

    actionButton("Order") {
        var pizza = "${type.get()} with radius ${radius.get()}cm"
        if (extraCheese.get()) {
            pizza += " with extra cheese"
        }
        val message = "We will deliver ${amount.get()} $pizza to ${address.get()}"
        audience.sendMessage(Component.text(message))
    }
    actionButton("Cancel")
}

fun doSomething() {
    create(player).open()
}

Java (short)

public class OrderDrugsUI extends DialogUI<Audience> {
    public OrderDrugsUI(@NotNull Audience audience) {
        super(audience);

        title("Order drugs");
        Property<DrugType> type = enumProperty("Type", DrugType.class);
        Property<Double> dosis = doubleProperty("Dosis (%)", 50, 120, 100);
        Property<Integer> amount = integerProperty("Amount", 1, 10);
        Property<String> address = stringProperty("Address");

        actionButton("Order", () -> {
            String drug = type.get() + " with dosis " + dosis.get() + "%";
            String message = "We will deliver " + amount.get() + " " + drug + " to " + address.get();
            audience.sendMessage(Component.text(message));
        });
        actionButton("Cancel");
    }

    private enum DrugType {
        CANNABIS, COCAINE, HEROIN, FENTANYL
    }
}

public void doSomething() {
    new OrderDrugsUI(player).open();
}

Java (long)

public class OrderCoffeeUI extends DialogUI<Audience> {
    private final Property<CoffeeType> type;
    private final Property<Double> size;
    private final Property<Boolean> milk;
    private final Property<Integer> amount;
    private final Property<String> address;

    public OrderCoffeeUI(@NotNull Audience audience) {
        super(audience);

        title("Order a Coffee");
        type = enumProperty("Type", CoffeeType.class);
        size = doubleProperty("Size (liters)", 0.25, 1, 0.33);
        milk = booleanProperty("Add milk");
        amount = integerProperty("Amount", 1, 10);
        address = stringProperty("Address");

        actionButton("Order", this::order);
        actionButton("Cancel");
    }

    private void order() {
        String coffee = type.get() + " with size " + size.get() + "l";
        if (milk.get()) {
            coffee += " with milk";
        }
        String message = "We will deliver " + amount.get() + " " + coffee + " to " + address.get();
        audience.sendMessage(Component.text(message));
    }

    private enum CoffeeType {
        COFFEE, ESPRESSO, CHOCOLATE_COFFEE, DOUBLE_CHOCOLATE_COFFEE
    }
}

public void doSomething() {
    new OrderCoffeUI(player).open();
}