|
| 1 | +# 🧍 PlayerChecker |
| 2 | + |
| 3 | +**PlayerChecker** — это простой плагин для **Paper**, который позволяет быстро проверить, заходил ли игрок на сервер и узнать его текущую группу (ранг) через API **LuckPerms**. |
| 4 | +Идеально подходит для интеграции с веб-сайтами, системами авторизации или панелями управления игроками. |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## ⚙️ Возможности |
| 9 | + |
| 10 | +- Проверяет, заходил ли указанный игрок когда-либо на сервер. |
| 11 | +- Определяет его **ранг (primary group)** из **LuckPerms**. |
| 12 | +- Возвращает короткие статусы, удобные для парсинга внешними системами (RCON / HTTP). |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## 🧩 Зависимости |
| 17 | + |
| 18 | +Для корректной работы требуется установленный плагин: |
| 19 | + |
| 20 | +```yml |
| 21 | +- LuckPerms |
| 22 | +``` |
| 23 | +
|
| 24 | +--- |
| 25 | +
|
| 26 | +## 💡 Команды |
| 27 | +
|
| 28 | +| Команда | Описание | Разрешение | |
| 29 | +|--------:|:---------|:----------------------------------| |
| 30 | +| `/checkplayer <ник>` | Проверяет наличие игрока и его ранг | `playerchecker.use` (по умолчанию `op`) | |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## 📤 Форматы возвращаемых данных |
| 35 | + |
| 36 | +Команда `/checkplayer <ник>` возвращает один из следующих форматов: |
| 37 | + |
| 38 | +| Ответ | Описание | |
| 39 | +|------:|:---------| |
| 40 | +| `NOT_FOUND` | Игрок **никогда не заходил** на сервер и не найден в базе данных. | |
| 41 | +| `FOUND:NO_RANK` | Игрок найден, но у него **нет назначенной группы** (ранга) в LuckPerms. | |
| 42 | +| `FOUND:<rank>` | Игрок найден, и у него установлен ранг `<rank>`. Например: `FOUND:default`, `FOUND:vip`. | |
| 43 | +| `ERROR:<сообщение>` | Произошла внутренняя ошибка при выполнении команды. | |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 🧠 Примеры использования |
| 48 | + |
| 49 | +**Пример 1 — игрок не найден:** |
| 50 | +```bash |
| 51 | +/checkplayer Steve |
| 52 | +# → NOT_FOUND |
| 53 | +``` |
| 54 | + |
| 55 | +**Пример 2 — найден без ранга:** |
| 56 | +```bash |
| 57 | +/checkplayer Alex |
| 58 | +# → FOUND:NO_RANK |
| 59 | +``` |
| 60 | + |
| 61 | +**Пример 3 — найден с рангом:** |
| 62 | +```bash |
| 63 | +/checkplayer Denis |
| 64 | +# → FOUND:vip |
| 65 | +``` |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +## 🧱 Пример интеграции (RCON) |
| 70 | + |
| 71 | +Пример вызова через mcrcon: |
| 72 | +```bash |
| 73 | +mcrcon -H 127.0.0.1 -P 25575 -p mypass "checkplayer Steve" |
| 74 | +# Ответ: FOUND:vip (или NOT_FOUND / FOUND:NO_RANK) |
| 75 | +``` |
| 76 | + |
| 77 | +Пример обработки в Python: |
| 78 | +```python |
| 79 | +result = rcon_command(f"checkplayer {username}").strip() |
| 80 | +if result.startswith("FOUND:"): |
| 81 | + rank = result.split("FOUND:")[1].strip() |
| 82 | + # rank может быть "NO_RANK" или реальный ранг |
| 83 | +elif result == "NOT_FOUND": |
| 84 | + # игрок не найден |
| 85 | +else: |
| 86 | + # обработка ошибок |
| 87 | +``` |
| 88 | + |
| 89 | +--- |
| 90 | + |
| 91 | +## 🛠 Установка |
| 92 | + |
| 93 | +1. Скачайте **последний релиз** из раздела [Releases](../../releases) |
| 94 | +2. Помести `.jar` в папку `plugins/` сервера. |
| 95 | +3. Убедись, что установлен **LuckPerms**. |
| 96 | +4. Перезапусти сервер. |
| 97 | +5. Проверь работу командой: |
| 98 | + ```bash |
| 99 | + /checkplayer <ник> |
| 100 | + ``` |
| 101 | + |
| 102 | +--- |
| 103 | + |
| 104 | +## 🔍 Совместимость |
| 105 | + |
| 106 | +| Платформа | Версия | |
| 107 | +|----------:|:-------| |
| 108 | +| Paper | 1.21+ | |
| 109 | +| LuckPerms | v5+ | |
| 110 | + |
| 111 | +--- |
| 112 | + |
| 113 | +## 📜 Лицензия |
| 114 | + |
| 115 | +Проект распространяется под лицензией **MIT**. |
0 commit comments