QueQiao

📖 Документация · ⬇️ Modrinth · ⬇️ CurseForge · 🐛 Сообщить о проблеме

Введение

• Передаёт события игроков с сервера в формате JSON через WebSocket

  • Реализованные события:

    • Чат игрока
    • Команда игрока
    • Смерть игрока (недоступно для Velocity)
    • Вход игрока
    • Выход игрока
    • Достижение игрока

• Принимает сообщения JSON через WebSocket и пересылает их игрокам на сервере

  • Реализованные API:

    • Broadcast
    • PrivateMessage
    • Title & SubTitle
    • ActionBar
    • Rcon Command

Документация

• Подробная документация доступна на ApiFox QueQiao

Не нашли подходящую версию мода/плагина? Смело создавайте Issue

Быстрый старт

1. Установите соответствующий плагин/мод на сервер

2. Настройте websocket_server в config.yml:

   • enable: true # Включить WebSocket-сервер
   • host: "127.0.0.1" # Адрес WebSocket-сервера
   • port: 8080 # Порт WebSocket-сервера
3. Запустите сервер и дождитесь инициализации WebSocket Server

4. Используйте ApiFox или другие инструменты для тестирования API, либо подключитесь через проекты из раздела Интеграции

   • Настройте глобальный Request Header:

     {
     // Обязательно: имя сервера, должно совпадать с 'server_name' в config.yml
     "x-self-name": "TestServer",
     // Необязательно: токен авторизации, должен совпадать с 'access_token' в config.yml (пропустите, если пусто)
     "Authorization": "Bearer 123"
     }

5. Запустите игру и зайдите на сервер
6. Обратитесь к документации API, чтобы отправлять сообщения или слушать события игроков.

Проекты интеграции

• @17TheWord/nonebot-adapter-minecraft: адаптер для NoneBot2
• @17TheWord/nonebot-plugin-mcqq: плагин для NoneBot2
• @CikeyQi/mc-plugin: плагин для YunZai
• @Twiyan0/koishi-plugin-minecraft-sync-msg: плагин для Koishi
• @17TheWord/zerobot-plugin-mcqq: плагин для ZeroBot
• @kterna/astrbot_plugin_mcqq: плагин для AstrBot
• @KroMiose/nekro-agent: AI-агент

Связанные проекты

• @kterna/queqiao_mcdr: реализация QueQiao на MCDR для обмена сообщениями

Совместимость

• @kitUIN/ChatImage: отображает изображения в чате Minecraft

Сообщество

• Discord

Особая благодарность

• @kitUIN: за помощь с кодом и инструментами сборки
• @kitUIN/ModMultiVersion: плагин IDEA для мультиверсионных модов
• @kitUIN/ModMultiVersionTool: инструмент сборки мультиверсионных модов

Поддержка и участие

• Поставь звезду проекту, если он тебе полезен, или поддержи меня на Afdian
• Предложения и баги — через Issues
• Вклад в разработку — через Pull requests

Лицензия

Проект распространяется под лицензией MIT.