Мод для Майнкрафт на Fabric, который открывает REST API и поток событий SSE для удалённого мониторинга и управления выделенным сервером. Подходит для получения статистики, отслеживания игроков и чата, а также запуска команд через внешние приложения или встроенную веб-панель.
Возможности
- Показывает TPS, MSPT, использование памяти и процессора, число игроков и свойства сервера.
- Передаёт данные об игроках: здоровье, голод, координаты, измерение, пинг, режим игры, статус оператора и ссылку на голову скина.
- Отдаёт сведения о мире: сид, время, погоду, сложность, число сущностей, загруженные чанки и статистику по измерениям.
- В поток SSE поступают сообщения чата, входы и выходы игроков, смерти, команды и игровые сообщения.
- Позволяет выполнять серверные команды через API.
- Веб-панель
/adminсодержит страницы со статистикой, игроками, миром, чатом, консолью, ключами, CORS и настройками. - Встроенная документация API доступна в Swagger UI по пути
/api/docs.
Как пользоваться
Для закрытых конечных точек передавайте ключ в заголовке:
Authorization: Bearer mcsapi_xxxxxxxxxxxxxxxx
Для подключения браузерного SSE-клиента ключ передаётся параметром ?auth=: браузерный EventSource не поддерживает собственные заголовки. Поток событий находится по адресу /api/events/stream.
Основные пути API:
GET /api/server— статистика сервера;GET /api/players— игроки в сети;GET /api/world— данные мира;GET /api/chat— история событий;POST /api/command— выполнение команды.
Настройки
Конфигурация находится в config/mcrestapi.json. Параметр port задаёт порт HTTP-сервера, bindAddress — адрес привязки, а maxConnections — число одновременных подключений. По умолчанию сервер слушает только 127.0.0.1 на порту 8080.
swagger включает документацию Swagger, cors задаёт разрешённые источники для CORS, а auth.enabled отключает проверку ключей при передаче авторизации доверенному обратному прокси. Ключи API хранятся в виде хешей PBKDF2-SHA256 и показываются только при создании.
Права ключей: server.read, players.read, world.read, chat.read, chat.stream, command.execute; * даёт полный доступ. Главный ключ нужен для /api/admin/* и панели /admin.
Требования и совместимость
Мод работает только на стороне сервера Fabric и требует Fabric API, Fabric Loader и подходящую JDK. Для удалённого доступа автор рекомендует использовать обратный прокси с HTTPS.
