Home

插件配置文档

准备开始

• 本插件仅 Java 版服务端可用，基岩版无效
• 确保您已经部署完成 Yunzai 机器人以及 Minecraft 服务器
• 确保您使用的是Spigot、Velocity、Fabric、Forge端中的一种（其他端兼容情况请自行测试）

下载文件

1. 点击 此链接 跳转到服务器端插件/Mod 发布页，找到最新版本的 Release，找到 Assets 选项，下载对应服务端的插件/Mod，并安装到您的 Minecraft 服务器中，启动一遍服务器后，使用代码编辑工具打开生成的配置文件备用（后文将简称为服务端配置文件）

   对应服务端	配置文件生成位置
   Spigot、Velocity	./plugins/QueQiao/config.yml
   Forge、Fabric	./config/QueQiao/config.yml

2. 使用以下命令安装 Yunzai 机器人插件：

   // 克隆仓库
   git clone https://github.com/CikeyQi/mc-plugin.git ./plugins/mc-plugin
   // 安装依赖
   pnpm install --filter=mc-plugin

3. 安装Guoba-Plugin，打开本插件的配置文件页面备用（后文将简称为插件配置文件）

判断模式

根据机器人服务器与 Minecraft 服务器网络模式，分为以下四种运行模式，请选择合适的运行模式继续

网络模式	对应教程	备注
机器人服务器与 Minecraft 服务器在同一电脑上或同一内网中	本地模式配置文档	使用容器（TRSS Script 等）部署的可能会出现网络隔离的情况，请自行解决网络问题
机器人服务器有公网 IP	反向 WebSocket 配置文档	至少开放一个端口，无法使用 Rcon 功能（无法使用命令）
Minecraft 服务器有公网 IP	正向 WebSocket 配置文档	至少开放两个端口
机器人服务器与 Minecraft 服务器不在同一内外且均无公网 IP	——	自行使用内网穿透等服务，使得其中一方有公网 IP 即可

测试连接

向机器人发送 #mc 状态 指令可以查看当前机器人与服务器连接状态，WebSocket 已连接则代表可以进行双向消息同步，Rcon 已连接则代表可以在机器人端使用指令