cslist

English version below.

CSList nagradza graczy za głosowanie na Twój serwer na CraftSerwery.pl.

Jak to działa

1. Gracz wpisuje /cs-link, dostaje link i głosuje na serwer na CraftSerwery.pl.
2. Gracz wpisuje /cs-nagroda.
3. Plugin sprawdza głos i wykonuje z konsoli komendy z nagrodami ustawione w pliku konfiguracyjnym.

Wymagania

• Spigot lub Paper, Minecraft od 1.8.8 do 26.3
• Java 8 lub nowsza
• serwer dodany do CraftSerwery.pl i przypisany do Twojego konta

Folia nie jest wspierana.

Instalacja

1. Wrzuć plik .jar do folderu plugins na serwerze.
2. Uruchom serwer. Plugin utworzy plik plugins/CSList/config.yml.
3. Wpisz w nim authKey, który znajdziesz w panelu serwera na CraftSerwery.pl.
4. Wpisz /cs-reload albo zrestartuj serwer.

Komendy

• /cs-link – wysyła graczowi link do głosowania. Można jej użyć raz na 15 sekund.
• /cs-nagroda – sprawdza, czy gracz zagłosował, i wydaje nagrody. Można jej użyć raz na 5 sekund.
• /cs-reload – wczytuje ponownie plik konfiguracyjny. Działa też z konsoli.

Uprawnienia

• cslist.reward – używanie /cs-link i /cs-nagroda. Sprawdzane tylko, gdy w konfiguracji jest requiredPermission: true.
• cslist.admin – używanie /cs-reload oraz informacja o nowej wersji pluginu przy wejściu na serwer.

Operatorzy serwera (OP) mają oba uprawnienia domyślnie.

Przykładowa konfiguracja

# Klucz dla twojego serwera Minecraft, który znajdziesz w ustawieniach na https://craftserwery.pl
authKey: ""

# Czy plugin ma wymagać uprawnień "cslist.reward"
requiredPermission: false

# Czy plugin ma informować o nowych wersjach?
checkUpdates: true

# Komendy do wykonania gdy użytkownik zagłosował
# %player% - placeholder dla nicknamu gracza
# Komendy wykonują się w konsoli, komendy wpisujemy bez /
commands:
  - give %player% diamond 1

Komunikaty dla graczy zmienisz w sekcji messages tego samego pliku. Dostępne placeholdery: %player% (w komendach), %timeLeft% (sekundy do ponownego użycia komendy), %link% (link do głosowania).

Jakie dane wysyła plugin

Plugin łączy się tylko z https://craftserwery.pl:

• /cs-link wysyła klucz serwera (authKey), żeby pobrać link do głosowania,
• /cs-nagroda wysyła klucz serwera i nick gracza, żeby sprawdzić głos,
• przy checkUpdates: true, gdy na serwer wchodzi OP lub gracz z cslist.admin, plugin pobiera numer najnowszej wersji i nic przy tym nie wysyła.

Jak przy każdym połączeniu z internetem, portal widzi adres IP serwera. Plugin nie zbiera innych danych. Zapytania działają poza głównym wątkiem serwera, więc brak odpowiedzi portalu nie zatrzymuje gry.

Linki

• Pełna instrukcja: dokumentacja
• Dodanie serwera: CraftSerwery.pl
• Kod źródłowy: GitLab
• Błędy i pytania: [email protected]

Licencja: MIT.

English

CSList rewards players for voting for your server on CraftSerwery.pl.

How it works

1. A player types /cs-link, gets a link and votes for the server on CraftSerwery.pl.
2. The player types /cs-nagroda.
3. The plugin checks the vote and runs the reward commands from the config file in the console.

Requirements

• Spigot or Paper, Minecraft 1.8.8 to 26.3
• Java 8 or newer
• your server added to CraftSerwery.pl and assigned to your account

Folia is not supported.

Installation

1. Put the .jar file in the server's plugins folder.
2. Start the server. The plugin creates plugins/CSList/config.yml.
3. Set authKey in that file. You will find the key in your server panel on CraftSerwery.pl.
4. Type /cs-reload or restart the server.

Commands

• /cs-link – sends the player a voting link. Can be used once every 15 seconds.
• /cs-nagroda – checks whether the player has voted and gives the rewards. Can be used once every 5 seconds.
• /cs-reload – reloads the config file. Also works from the console.

Permissions

• cslist.reward – use /cs-link and /cs-nagroda. Checked only when the config has requiredPermission: true.
• cslist.admin – use /cs-reload and see a notice about new plugin versions when joining the server.

Server operators (OP) have both permissions by default.

Configuration

Options in the example config above:

• authKey – your server key from the server panel on CraftSerwery.pl,
• requiredPermission – whether /cs-link and /cs-nagroda require cslist.reward,
• checkUpdates – whether to tell admins about new plugin versions,
• commands – console commands run when a player claims a reward, written without /. %player% is replaced with the player's name.

Player messages are in Polish by default. You can change them in the messages section of the same file. Placeholders: %timeLeft% (seconds until the command can be used again), %link% (voting link).

What data the plugin sends

The plugin connects only to https://craftserwery.pl:

• /cs-link sends the server key (authKey) to get the voting link,
• /cs-nagroda sends the server key and the player's name to check the vote,
• with checkUpdates: true, when an OP or a player with cslist.admin joins, the plugin fetches the latest version number and sends no data.

Like any internet connection, the portal sees the server's IP address. The plugin collects no other data. Requests run off the server's main thread, so an unresponsive portal does not freeze the game.

Links

• Full guide (in Polish): CraftSerwery.pl
• Add your server: CraftSerwery.pl
• Source code: GitLab
• Bugs and questions: [email protected]

License: MIT.