Velocity Web API

Плагин для прокси-сервера Velocity, который открывает HTTP API с данными об игроках и подключённых серверах. Он пригодится для сайтов, ботов и систем мониторинга; в браузере также доступна встроенная страница.

Возможности

• Список подключённых игроков с именем, UUID и текущим сервером.
• Общее число игроков онлайн.
• Данные конкретного подключённого игрока: UUID, сервер, пинг и длительность сессии.
• Число игроков на каждом сервере прокси.
• Лёгкая проверка работоспособности для мониторинга.

Команды

• /vwapi reload — перечитать config.cfg и перезапустить HTTP-сервер, если изменились port или bindAddress.
• /vwapi version — показать сведения о версии плагина.
• /vwapi debug [on|off] — включить или выключить подробные сообщения в консоли.
• /vwapi status — показать состояние HTTP-сервера, адрес и порт.
• /vwapi help — вывести справку по командам.

Права

• vwapi.admin — доступ ко всем командам /vwapi.

Настройка

Параметры находятся в config.cfg в папке данных плагина:

• port — порт HTTP-сервера.
• bindAddress — адрес, на котором слушает HTTP-сервер. Значение 127.0.0.1 ограничивает доступ текущей машиной.
• debugEnabled — подробные сообщения в консоли.
• allowedOrigins — разрешённые источники CORS для запросов к API.
• checkUpdates и snapshotUpdates — параметры проверки обновлений.

Требования

Плагин рассчитан на Velocity. Для доступа к API плагин должен находиться в папке plugins/ прокси-сервера.

Эндпоинты

• / — встроенная веб-страница.
• /playerlist — список игроков и их общее количество.
• /count — количество игроков онлайн.
• /player/<username> или /player?username=<name> — сведения об игроке; поиск учитывает регистр и работает только для игроков онлайн.
• /servers — количество игроков на каждом сервере.
• /health — проверка работоспособности API.