为了您更好的体验,请前往Github查看
[MD]# HuHoBot BDSAdapter Adapter
[](https://github.com/HuHoBot/BDSAdapter/releases)
[](https://github.com/HuHoBot/BDSAdapter/blob/main/LICENSE)
专为BDS设计的下一代基岩版服务器管理解决方案,提供安全的无第三方QQ机器人依赖管理体验。
##

| 特性 | 传统方案 | HuHoBot |
|--------|------------------|-------------------|
| 账号安全 |


| 部署复杂度 |


| 服务器兼容性 |


| 协议更新影响 |


****
##

### 核心功能
- **无缝绑定**:通过WebSocket实现服务器与控制端即时绑定
- **智能风控规避**:基于事件驱动的非侵入式通信协议
### 功能列表
| 命令 | 描述 |
|--------|----------------|
| /添加白名单 | 向服务器内添加一个白名单 |
| /删除白名单 | 向服务器内删除一个白名单 |
| /绑定 | 绑定服务器 |
| /设置名称 | 设置自己在本群群服互通的名称 |
| /发信息 | 群服互通向服务器内发送消息 |
| /执行命令 | 向服务器发送执行命令的请求 |
| /查白名单 | 查询服务器内置白名单 |
| /查在线 | 查询服务器在线名单 |
| /在线服务器 | 查询在线服务器 |
| /执行 | 执行自定义指令 |
| /管理员执行 | 以管理员身份运行自定义内容 |
</details>
### 进阶功能
- **扩展API**
- 自定义命令系统(详见下文)
##

### 环境要求
- LegacyScriptEngine 0.9.4+
### 快速开始
1. **访问 GitHub Releases 页面**:
- 打开浏览器,访问 [HuHoBot-BDSAdapter Releases](https://github.com/HuHoBot/BDSAdapter/releases)
- 下载最新版本的 `HuHoBot-BDS-vx.x.x.zip` 文件
2. **放置插件文件**:
- 将下载的 `HuHoBot-BDS-vx.x.x.zip` 文件`解压后`放入服务器的 `plugins` 目录中
3. **重启服务器**:
- 重启你的 Minecraft 服务器以加载新插件
4. **添加机器人**
- [加入交流群](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=N6tVRxGR8sDwYHBx9YgAhkqRTp1gseyk&authKey=M7Fd3Op6nHjXjSXefBtHBPqIq2wtX8AfufZor9DrfRrJkhyS2rohkt7iuOSwbtn8&noverify=0&group_code=1005746321) 点击HuHo_Bot头像并添加到群聊
5. **完成绑定**:
- 按照控制台提示完成服务器与机器人的绑定操作
### 高级配置(可选)
- 如果需要自定义功能,请参考`

---
##

```json5
{
"serverId": "", //不用管
"hashKey": "", //不用管
"serverName": "server", // 服务器名称
"addSimulatedPlayerTip": true, //是否添加模拟玩家提示
"chatFormat": {
"game": "<{name}> {msg}", // 群聊格式
"group": "群:<{nick}> {msg}"
},
"motd": {
"server_ip": "play.easecation.net", //使用/查在线的时候显示的图片地址(改成你自己的进服IP)
"server_port": 19132, //使用/查在线的时候显示的图片地址(改成你自己的进服端口)
"api": "https://motdbe.blackbe.work/status_img?host={server_ip}:{server_port}", //使用"/查在线"时的Motd图片地址Api(无特殊需求勿动)(必须返回图片)
"text": "共{online}人在线", //使用"/查在线"时的Motd文本,留空不显示
"output_online_list": true, //是否显示在线列表
"post_img": true //是否显示Motd图片
},
"customCommand": [
{
"key": "加白名", //执行关键词,可使用"/执行 关键词 参数1 参数2"来执行自定义命令
"command": "whitelist add &1", //&1为参数占位符,第一个参数为&1,第二个&2,以此类推
"permission": 0 //0是普通权限,大于0则为管理员权限
},
{
"key": "管理加白名",
"command": "whitelist add &1",
"permission": 1
}
],
"version": 2
}
```
##

####

- 检查控制台是否输出"握手成功"的字段
- 如果未出现,请使用/huhobot reconnect手动重新建立连接
####

- 完全不需要!本方案采用全新的通信协议,彻底摆脱对第三方聊天平台的依赖。
####

- 支持热重载配置:/huhobot reload
####

- 本机器人不支持群服消息互通,因官方机器人API限制每个群每月仅能发送三条主动消息
####

- 请修改配置文件中的 motdUrl 字段为你的服务器地址
- 示例:`motdUrl: "play.yourserver.com:25565"`
####

> 排查步骤:
> 检查连接状态,使用 /huhobot reconnect 重连
> 尝试清空 motdUrl 字段:"motdUrl": ""
####

- 注意命令格式区别:
- `/执行 加白` → 用于自定义指令回调
- `/执行命令 list` → 向控制台发送命令
####

- 请按上文配置文件示例配置 customCommand 字段
- 使用方式:`/执行 加白 "玩家ID"`(带空格参数需加引号)
####

- 在群内使用指令:
- `/管理帮助` → 查看管理指令列表
####

- 当前版本每个群仅支持绑定一个服务器,多服务器绑定功能正在开发中
- 如需管理多服务器,建议为每个服务器创建独立群组
### 配置自定义命令
#### 通过配置文件设置
在 `config.json` 文件中,你可以通过 `customCommand` 字段来定义自定义命令。每个自定义命令包含以下属性:
- **key**:触发命令的关键词(字符串)
- **command**:实际执行的服务器命令(字符串)
- **permission**:权限级别(整数)
示例配置如下:
```json5
{
"customCommand": [
{
"key": "加白名", //执行关键词,可使用"/执行 关键词 参数1 参数2"来执行自定义命令
"command": "whitelist add &1", //&1为参数占位符,第一个参数为&1,第二个&2,以此类推
"permission": 0 //0是普通权限,大于0则为管理员权限
},
{
"key": "管理加白名",
"command": "whitelist add &1",
"permission": 1
}
]
}
```
#### 通过插件设置
您可以按如下代码创建一个插件,编写一个HuHoBot拓展模块,并使用HuHoBot的API注册回调函数
```javascript
const HUHONAMESPACE = 'HuHo_Bot' //勿动
const NAMESPACE = 'Test' //修改成你自己想要的Namespace
/**
* 回调函数
* @param {array} keyWord
*/
function Callback(params){
return "测试成功" //可以返回一个文本消息到群内
}
/**
* 注册回调函数
* @param {string} keyWord
* @param {function} func
*/
function regCallbackEvent(type,keyWord,func){
if(!ll.hasExported(HUHONAMESPACE,'regEvent')){
return;
}
let regEvent = ll.imports(HUHONAMESPACE,'regEvent')
ll.exports(func,NAMESPACE,func.name)
regEvent(type,keyWord,NAMESPACE,func.name)
}
mc.listen("onServerStarted",()=>{
let keyWord = "测试" //触发关键词
regCallbackEvent("run",keyWord,Callback)
})
```
##

[GNU General Public License v3.0](LICENSE) - 自由使用、修改和分发,但需遵守以下条款:
- **开源义务**:任何衍生作品必须保持开源
- **相同许可**:修改后的版本必须使用相同许可证
- **版权声明**:必须保留原始版权声明
完整协议文本请查看 [LICENSE](LICENSE) 文件
##

欢迎提交PR或通过[Discussions](https://github.com/HuHoBot/BDSAdapter/discussions)提出建议
[/MD]