README.md

🌍English / 中文

鹊桥

✨ 连接 Minecraft 服务器的桥梁 ✨

📖Docs · ⬇️Modrinth · ⬇️CurseForge · 🐛Submit Suggestion/Bug

介绍

• 将 Minecraft 服务端玩家事件以 Json 格式通过 Websocket 分发的服务端 plugin/mod。
  • 已实现的 事件
    • 玩家聊天
    • 玩家命令
    • 玩家死亡 (Velocity 暂无)
    • 玩家加入
    • 玩家登出
• 通过 Websocket 接收 Json 消息，并转发至游戏玩家。
  • 已实现的接口
    • Broadcast
    • PrivateMessage
    • Title & SubTitle
    • ActionBar

快速开始

1. 安装服务端对应的 插件/Mod
2. 配置 config.yml 中的 websocket_server
   • enable: true # 是否启用
   • host: "127.0.0.1" # WebSocket Server 地址
   • port: 8080 # WebSocket Server 端口
3. 启动服务器，等待开启 Websocket Server
4. 使用 ApiFox 或其他API测试工具，或连接 对接 项目
   • 配置全局 Request Header

     {
       "x-self-name": "TestServer",
       // 必填
       // 服务器名称，必须与 config.yml 中的 'server_name' 一致
       "Authorization": "Bearer 123",
       // 选填
       // 鉴权，必须与 config.yml 中的 'access_token' 一致,如果 config.yml 中的 'auth_token' 为空，则可不设置此项
       "x-client-origin": "apifox"
       // 必填
       // 客户端来源，如果来源为 'minecraft'，则表示来自 Minecraft 的 Websocket Client，且会被 Minecraft 端的 Websocket Server 拒绝
     }

5. 开始游戏，加入服务器

帮助与下载

• 前往 Wiki 查看文档
• 前往 Modrinth 下载
• 前往 CurseForge 下载

对接

• @17TheWord/nonebot-adapter-minecraft：NoneBot2 适配器，与本模组连接
• @17TheWord/nonebot-plugin-mcqq：NoneBot2 插件，与 Minecraft 互通聊天
• @CikeyQi/mc-plugin：云崽插件，与 Minecraft 互通聊天

兼容

• @kitUIN/ChatImage：在 Minecraft 聊天栏中显示图片

特别感谢

• @kitUIN：提供代码上的帮助以及构建工具
• @kitUIN/ModMultiVersion：IDEA 多版本 MOD 插件
• @kitUIN/ModMultiVersionTool：多版本 MOD 构建工具

贡献与支持

• 觉得好用可以给这个项目点个 Star 或者去 爱发电 投喂我。

• 有意见或者建议也欢迎提交 Issues 和 Pull requests 。

开源许可

本项目使用 MIT 作为开源许可证。