Skip to content

Latest commit

 

History

History
111 lines (93 loc) · 6.67 KB

README.md

File metadata and controls

111 lines (93 loc) · 6.67 KB

MessageHandler

Opis

Autorska biblioteka do kompleksowej obsługi wiadomości i plików językowych dla pluginów oparta na rozwiązaniach net.kyori:adventure.

Warianty

  • MessageHandler-Paper – wersja dla serwerów Paper/Folia i kompatybilnych forków.
  • MessageHandler-Spigot – odpowiednik dla serwerów Bukkit/Spigot.
  • MessageHandler-BungeeCord – wersja przygotowana pod proxy BungeeCord.
  • MessageHandler-Velocity – wersja przygotowana pod proxy Velocity.

Jak dodać?

Dodaj do build.gradle.kts odpowiednią wersję:

Paper/Spigot

  • Release: Latest Release

  • Snapshot: Latest Snapshot

repositories {
    mavenCentral()
    maven("https://nexus.syntaxdevteam.pl/repository/maven-snapshots/") //SyntaxDevTeam
    maven("https://nexus.syntaxdevteam.pl/repository/maven-releases/") //SyntaxDevTeam
}

dependencies {
    // Paper/Purpur/Folia
    implementation("pl.syntaxdevteam:messageHandler-paper:1.1.1-R0.1SNAPSHOT")
    // lub Spigot/Bukkit
    // implementation("pl.syntaxdevteam:messageHandler-spigot:1.1.1-R0.1-SNAPSHOT")
    // lub BungeeCord
    // implementation("pl.syntaxdevteam:messageHandler-bungeecord:1.1.1-R0.1-SNAPSHOT")
    // lub Velocity
    // implementation("pl.syntaxdevteam:messageHandler-velocity:1.1.1-R0.1-SNAPSHOT")
    compileOnly("com.github.ben-manes.caffeine:caffeine:${latestVersion}")
    compileOnly("net.kyori:adventure-text-serializer-legacy:${latestVersion}")
    compileOnly("net.kyori:adventure-text-minimessage:${latestVersion}")
    compileOnly("net.kyori:adventure-text-serializer-plain:${latestVersion}")
    compileOnly("net.kyori:adventure-text-serializer-ansi:${latestVersion}")
}

W klasie głównej dodaj:

import pl.syntaxdevteam.message.SyntaxMessages

class TwojPLuginX : JavaPlugin() {
    lateinit var messageHandler: MessageHandler

  override fun onEnable() {
        SyntaxMessages.initialize(this)
        messageHandler = SyntaxMessages.messages
  }
}

Opisy podstawowych metod do obsługi wiadomości

  • reloadMessages() – ponownie wczytuje konfigurację językową i czyści wszystkie cache wiadomości, by kolejne odczyty korzystały z aktualnych danych. Dodaje się najczęściej do komendy reload.

  • getPrefix() – zwraca aktualny prefiks dodawany do wiadomości użytkownika.

  • stringMessageToComponent(category, key, placeholders) – podstawowa metoda która buduje komponent MiniMessage z prefiksem na podstawie wpisu YAML i podstawionych placeholderów. image

    Przykład użycia:

    val wiadomosc = messageHandler.stringMessageToComponent("errors", "no-permission", map.of("player", playerName))

  • stringMessageToString(category, key, placeholders) – zwraca sformatowany tekst MiniMessage jako String z prefiksem, zachowując kolory i placeholdery stosowana tam gdzie wymagany jest czysty String zamiast komponentu. image

  • stringMessageToStringNoPrefix(category, key, placeholders) – tak jak powyższa metoda ale ta zwraca treść wiadomości jako „czysty” String bez prefiksu, ale po przetworzeniu MiniMessage. image

  • stringMessageToComponentNoPrefix(category, key, placeholders) – generuje komponent przeznaczony nie tylko do logów ale napisany z myślą o nich, konwertując zapis legacy/section na MiniMessage i pomijając prefiks. image

    Przykłąd użycia:

    val logWiadomosc = messageHandler.stringMessageToComponentNoPrefix("logs", "user-joined", map.of("user", userName))
logger.info(logWiadomosc)

  • getSmartMessage(category, key, placeholders) – inteligentnie obsługuje zarówno pojedynczy wpis tekstowy, jak i listę, zwracając listę komponentów gotowych do wyświetlenia. Przykład zastosowania w pliku YAML:

    Wersja 1 – pojedynczy wpis tekstowy:

      broadcast: "<dark_gray>Gracz <gray><player></gray> został wyrzucony z powodu <gray><reason></gray></dark_gray>"
    image

    Wersja 2 – lista wpisów tekstowych:

     broadcast:
   - "<dark_gray>*************** Twoja Nazwa Serwera *************** </dark_gray>"
   - ""
   - "<red>   Gracz <white><player></white> został wyrzucony</red>"
   - "   Powód: <white><reason></white>"
   - ""
   - "<dark_gray>*************************************************** </dark_gray>"
    image

Metody do formatowania tekstu

  • formatLegacyText(message) – konwertuje tekst w formacie &-color na komponent MiniMessage. Czyli formatowanie wszystkich formatów Minecraft typu &a, &l, &n itp.
  • formatHexAndLegacyText(message) – obsługuje zarówno kody &#rrggbb, jak i § podczas konwersji do komponentu.
  • miniMessageFormat(message) – parsuje surowy ciąg MiniMessage do komponentu Adventure.
  • getANSIText(component) – serializuje komponent do kolorowego ANSI (np. na konsolę).
  • getPlainText(component) – sprowadza komponent do czystego tekstu pozbawionego formatowania.
  • formatMixedTextToMiniMessage(message, resolver) – przyjmuje tekst mieszany (MiniMessage + legacy + § + sekwencje \uXXXX) i zwraca poprawnie zdeserializowany komponent, opcjonalnie z resolverem placeholderów. Najczęściej używane do przetwarzania tekstu wprowadzonych przez użytkowników, bo kompleksowo żąda wszystkie możliwe formaty.
  • formatMixedTextToLegacy(message, resolver)` – przyjmuje tekst mieszany (MiniMessage + legacy + § + sekwencje \uXXXX) i zwraca poprawnie zdeserializowany komponent, opcjonalnie z resolverem placeholderów. Najczęściej używane do przetwarzania tekstu wprowadzonych przez użytkowników, bo kompleksowo żąda wszystkie możliwe formaty.