Quill Notifications

Quill Notifications представляет собой компактную библиотеку для Minecraft, которая обеспечивает стильную и эффективную систему уведомлений для игроков. Мод позволяет отправлять сообщения как активным, так и неактивным пользователям, гарантируя доставку даже при их временном отсутствии в игре.

Установка и требования

Для корректной работы мода необходимо установить Fabric API и SQLib. Хотя использование Adventure API не является обязательным, оно настоятельно рекомендуется разработчикам для расширения функциональности.

После установки мода на сервер при первом запуске автоматически создается конфигурационный файл. Вам потребуется настроить его, указав путь к файлу или параметры подключения к базе данных MySQL.

Для разработчиков

Начало работы

Чтобы подключить библиотеку к своему проекту, добавьте следующие зависимости:

repositories {
    maven { url "https://api.modrinth.com/maven" }
    // Adventure API не является обязательным, но позволяет использовать компонентные сообщения
    maven {
        name = "sonatype-oss-snapshots1"
        url = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
        mavenContent { snapshotsOnly() }
    }
}

dependencies {
    modImplementation("maven.modrinth:quill:1.2.3")
    // Adventure API не является обязательным, но полезен и позволяет использовать компонентные сообщения
    modImplementation include("net.kyori:adventure-platform-fabric:6.4.0")
}

Основное использование

Notification notification = NotificationBuilder.Notification(receiverUUID) // Инициализация нового уведомления
    .setMessage(message) // setMessage() принимает переменные String, MutableText или Component (сохраняется только последнее установленное сообщение)
    .setStyle(Scribe.INFO) // setStyle() работает только для строковых сообщений
    .setMetadata(jsonData) // добавление JSON данных для использования с системой событий
    .setSound(SoundEvents.BLOCK_BELL_USE) // установка звукового события при получении уведомления
    .setCommands(commandString, commandString2) // установка команд для выполнения при получении уведомления
    .setCommandDelay(10, TimeUnit.SECONDS) // установка задержки для команд (также можно передать число в миллисекундах)
    .setExpiry(15, TimeUnit.MINUTES) // установка времени истечения срока действия уведомления (также можно передать число в миллисекундах)
    .build();
Pigeon.send(notification); // отправка уведомления игроку

for (Notification message: QuillNotifications.getNotifications(receiverUUID)) { // получение всех ожидающих уведомлений для игрока (от старых к новым)
    if (notification.getMessage().toString().equals("Test message plz delete")) message.cancel() // отмена уведомления перед отправкой игроку
}

Система событий

// Система событий предоставляет объект уведомления для изменения данных перед отправкой
QuillEvents.PRE_SEND_NOTIFICATION.register((notification) -> {
  System.out.println(notification.getPlayerEntity().getName().getString());
  // возврат true разрешает отправку сообщения, возврат false останавливает
  // возврат false останавливает показ сообщения
  return true;
  // Делайте крутые вещи с метаданными или другими переменными, система событий - ваш инструмент.
});