Konfiguracja

Wszystkie ustawienia są w plugins/CoreStatus/config.yml, z komentarzami po angielsku i po polsku. Po każdej zmianie wpisz /corestatus reload: wczytuje wszystko, także język i interwały.

Kolory zapisuj w cudzysłowie jako "#rrggbb". Bez cudzysłowu YAML uznaje # za komentarz.

Wartość, której nie da się użyć, zostaje zastąpiona domyślną, a konsola (i /corestatus reload) mówi jednym zdaniem, który klucz i co poprawić. Zdania te są po angielsku. Plik, który nie jest poprawnym YAML-em, daje ustawienia domyślne dla wszystkiego. Żaden z tych błędów nie zatrzymuje pluginu, a komunikaty nigdy nie cytują pliku, więc token webhooka nie trafia do konsoli.

Na proxy pierwsze uruchomienie zapisuje inny plik, zobacz Tryb sieci.

Poziom główny

Wiadomość ze statusem: status

Jedna wiadomość, wysyłana za pierwszym razem, potem edytowana w miejscu. Po restarcie nadal edytowana jest ta sama wiadomość. Jeśli wiadomość usunięto na Discordzie, plugin wysyła nową.

Linie są pogrupowane pod trzema nagłówkami: Gracze (liczba i lista), Wydajność (TPS i MSPT) oraz Serwer (wersja i adres). Nagłówek, którego linie są wszystkie wyłączone w status.show albo których serwer nie potrafi podać (Spigot nie ma MSPT, wersja bywa nieznana), znika razem z nimi. Każda wiadomość ze statusem kończy się linią „Ostatnia aktualizacja” z czasem, który Discord pokazuje w strefie czasowej czytającego. Wartości są pokazywane jako kod, nagłówki pogrubione.

Wiadomość z wszystkim włączonym (i ustawionym status.description) wygląda tak:

📊 Status serwera
Wpadaj! Status odświeża się co minutę.

🟢 Online od 4 h 12 min

👥 Gracze
» Online: 12/100
» Steve, Alex, Notch, Jeb, Dinnerbone +7 więcej

⚙️ Wydajność
» TPS: 🟢 20.0
» MSPT: 1.6 ms

🖥️ Serwer
» Wersja: Paper 1.21.4
» Adres: play.example.com

Ostatnia aktualizacja: minutę temu

Gdy serwer się zatrzymuje, wiadomość robi się czerwona i podaje, od kiedy serwer nie działa, w godzinie widocznej w strefie czasowej czytającego:

📊 Status serwera
🔴 Offline od 14:32
Serwer jest wyłączony. Wiadomość zmieni się sama, gdy wróci.

🖥️ Serwer
» Adres: play.example.com

Ostatnia aktualizacja: 3 minuty temu

Część „Serwer” pojawia się tylko wtedy, gdy ustawiono status.show.address.

Kolory TPS

TPS to średnia z ostatniej minuty, najwyżej 20. Kółko zależy od wartości w takiej postaci, jaka jest pokazana (jedno miejsce po przecinku):

Na Paperze i Purpurze TPS podaje serwer. Na Spigocie i na Folii (jej globalny region) CoreStatus sam liczy ticki.

Start i stop: start-stop

Krótka wiadomość przy starcie i przy zatrzymaniu serwera. Przy zatrzymaniu najpierw status zmienia się na „Offline”, potem wysyłana jest wiadomość „Serwer zatrzymany”. CoreStatus czeka na Discorda najwyżej 5 sekund, więc wolny Discord nigdy nie zatrzyma wyłączania serwera.

Po awarii CoreStatus nie zdąży się pożegnać. Przy następnym starcie wysyła „Serwer był offline od” z czasem ostatniego śladu życia, jeszcze przed „Serwer uruchomiony”. Dzieje się tak, gdy ostatni ślad życia jest starszy niż dwa interwały statusu. Zwykłe zatrzymanie tego nie wywołuje.

Wejścia i wyjścia: join-leave

Wiadomość, gdy gracz wchodzi lub wychodzi. Domyślnie wyłączona, bo wysyła nicki graczy na Discorda. Gracze w vanish nie są ogłaszani.

Niski TPS: low-tps

Jedno ostrzeżenie, gdy TPS przez kilka minut jest poniżej ustawionej wartości. Następne dopiero wtedy, gdy TPS wróci do tej wartości lub powyżej i znów spadnie. Przy ustawieniach domyślnych: poniżej 15 przez 5 minut.

TPS jest sprawdzany przy każdym odświeżeniu statusu, więc ostrzeżenie przychodzi po pierwszym niskim odczycie plus ustawione minuty. Sprawdzanie działa także wtedy, gdy status.enabled ma wartość false.

Więcej niż jeden webhook

Każda funkcja może pisać na własny kanał przez własny webhook. Pusty webhook oznacza ten ze status.webhook. Jeśli i on jest pusty, funkcja nic nie wysyła.

Kanał publiczny i kanał dla administracji. Status oraz wiadomości o starcie i zatrzymaniu są pisane z myślą o graczach, więc pasuje do nich kanał publiczny. Ostrzeżenie o niskim TPS, a także wejścia i wyjścia, jeśli zostaną włączone, są dla administracji: warto utworzyć drugi webhook na kanale dla administracji i wpisać go w low-tps.webhook (oraz join-leave.webhook). Dopóki te klucze są puste, wiadomości trafiają na kanał statusu, czyli do publiczności. /corestatus test i /corestatus status wypisują każdy ustawiony adres, po jednym razie, niezależnie od tego, czy jego funkcja jest włączona.

Po zmianie adresu statusu CoreStatus wysyła tam nową wiadomość ze statusem. Stara zostaje, gdzie była: trzeba ją usunąć na Discordzie.

Tryb sieci: Velocity i BungeeCord

Na proxy pierwsze uruchomienie zapisuje plugins/CoreStatus/config.yml dla wiadomości o sieci. Są w nim language, status, network i footer. Sekcji start-stop, join-leave i low-tps tam nie ma: każdy serwer za proxy ogłasza własne zdarzenia własnym CoreStatus.

Na proxy działa tylko pięć kluczy status; stylizują one wiadomość o sieci:

Sama wiadomość o sieci:

network:
  enabled: true
  webhook: "https://discord.com/api/webhooks/123/abc…"
  servers:
    - id: lobby
      label: "Lobby"
    - id: survival
      label: "Survival"

• id musi być nazwą serwera z configu proxy: nazwą pod [servers] w velocity.toml Velocity albo pod servers w config.yml BungeeCord. Należy ją zapisać dokładnie tak jak tam. Nazwa, której proxy nie zna, jest pomijana w wiadomości, a konsola raz o tym informuje.
• label to nazwa widoczna na Discordzie. Puste: id.
• Stan online lub offline wynika z pingu proxy do serwera (proxy czeka najwyżej 10 sekund). Liczba graczy to liczba graczy, których proxy ma połączonych z tym serwerem.

Wiadomość o sieci wygląda tak:

🌐 Status sieci
👥 Gracze w sieci: 19
🟢 Lobby » 12 graczy • TPS 🟢 20.0
🟢 Survival » 7 graczy • TPS —
🔴 Creative » offline

Ostatnia aktualizacja: minutę temu

Serwery offline zostają na swoim miejscu na liście, w kolejności z network.servers.

TPS w sieci

Proxy nie potrafi zmierzyć TPS. Podaje go każdy serwer docelowy:

• CoreStatus musi być zainstalowany na serwerze docelowym, ten sam jar. Do tego nie potrzebuje webhooka.
• Serwer wysyła swój TPS raz na status.interval-seconds (własny interwał serwera, domyślnie 60) przez gracza połączonego z tym serwerem. Dlatego na tym serwerze musi być online co najmniej jeden gracz. Bez gracza nic nie może zostać wysłane.
• Proxy pokazuje TPS dopóki ostatni raport nie jest starszy niż dwa interwały network.interval-seconds. Potem, i dla serwera, który nigdy nic nie zgłosił, pokazuje kreskę (—). Aby kreska nie migała między raportami, interwał serwera docelowego powinien być co najwyżej dwa razy dłuższy niż interwał proxy.

Gdy proxy się zatrzymuje, wiadomość zmienia się tak, że każdy serwer jest offline.

Zmiana tekstów

Każdy tekst, który pisze CoreStatus, pochodzi z messages_en.yml lub messages_pl.yml, zależnie od language. Pliki są w jarze. Aby zmienić tekst:

1. Utwórz plugins/CoreStatus/messages_pl.yml (albo messages_en.yml).
2. Wpisz do niego tylko klucze, które mają się zmienić. Pozostałe zachowują wbudowany tekst.
3. Wpisz /corestatus reload.

status:
  title: "Nasz serwer survival"
event:
  joined: "{player} jest już online"

Zmienne w {nawiasach klamrowych} zostaw bez zmian: wstawia je plugin. Klucz, którego plugin nie zna, jest pomijany.

Pozostałe klucze (na przykład footer, status.title, status.online, status.offline, status.offline-note, status.section-players, status.section-performance, status.section-server, event.started, event.stopped, event.test, network.title, network.unknown-tps, command.usage, command.reloaded, command.admincontrol i console.no-webhook) nie mają zmiennych. Raporty o nieudanej wysyłce w konsoli są zawsze po angielsku.

Emoji, znaczniki pogrubienia i grawisy wokół wartości są częścią tekstów, więc można je zmienić lub usunąć. Wartość między grawisami Discord pokazuje jako kod.