首次提交
This commit is contained in:
175
PLUGINS.md
Normal file
175
PLUGINS.md
Normal file
@@ -0,0 +1,175 @@
|
||||
# 蛋定助手插件文档
|
||||
|
||||
## 项目概述
|
||||
|
||||
蛋定助手是一个基于NoneBot2框架开发的QQ机器人，提供多种功能插件，包括AI聊天、管理API、自动撤回消息等。该机器人主要面向特定用户群体，提供游戏辅助和社群管理功能。
|
||||
|
||||
## 插件总览
|
||||
|
||||
| 插件名称 | 描述 | 权限要求 |
|
||||
|---------|------|---------|
|
||||
| chatai | AI聊天功能，对接DeepSeek | 所有用户 |
|
||||
| auto_recall | 消息自动撤回 | 系统自动执行 |
|
||||
| damo_balance | 大漠账户余额查询 | 特定用户 |
|
||||
| danding_api | 蛋定助手管理API | 超级用户 |
|
||||
| danding_help | 帮助信息 | 特定群用户 |
|
||||
| command_list | 命令列表管理 | 系统使用 |
|
||||
|
||||
## 详细插件文档
|
||||
|
||||
### 1. chatai - AI聊天插件
|
||||
|
||||
#### 功能描述
|
||||
基于DeepSeek AI的聊天功能，支持将AI回复转换为图片形式，并在一定时间后自动撤回。
|
||||
|
||||
#### 使用方法
|
||||
- 发送以 `*` 开头的消息触发AI回复
|
||||
- AI回复会自动转为图片显示
|
||||
- 回复会在120秒后自动撤回
|
||||
|
||||
#### 配置项
|
||||
```env
|
||||
DEEPSEEK_TOKEN=你的DeepSeek API密钥
|
||||
```
|
||||
|
||||
#### 技术实现
|
||||
- 使用OpenAI客户端连接DeepSeek API
|
||||
- 使用Pyppeteer将Markdown转为图片
|
||||
- 内置Chrome浏览器实例管理
|
||||
|
||||
#### 示例
|
||||
用户: *你好，请介绍一下自己
|
||||
AI: [图片形式回复] 👋 你好呀！我是蛋定助手，一个活泼可爱的AI助手！😊 很高兴认识你！有什么我能帮到你的吗？✨
|
||||
|
||||
---
|
||||
|
||||
### 2. auto_recall - 自动撤回插件
|
||||
|
||||
#### 功能描述
|
||||
监控所有发出的消息，并在指定时间后自动撤回，保持聊天环境整洁。
|
||||
|
||||
#### 使用方法
|
||||
- 无需手动调用，插件会自动监控并撤回消息
|
||||
|
||||
#### 配置项
|
||||
```env
|
||||
RECALL_DELAY=110 # 撤回延迟时间，单位为秒
|
||||
```
|
||||
|
||||
#### 技术实现
|
||||
- 使用NoneBot的API拦截功能
|
||||
- 异步定时任务管理
|
||||
- 错误处理与日志记录
|
||||
|
||||
---
|
||||
|
||||
### 3. damo_balance - 大漠账户余额查询
|
||||
|
||||
#### 功能描述
|
||||
查询大漠平台账户余额，需要验证码验证。
|
||||
|
||||
#### 使用方法
|
||||
- 命令：`大漠余额`或`余额查询`
|
||||
- 需要验证码验证
|
||||
|
||||
#### 权限要求
|
||||
- 仅特定用户(ID:1424473282)可使用
|
||||
|
||||
---
|
||||
|
||||
### 4. danding_api - 蛋定助手管理API
|
||||
|
||||
#### 功能描述
|
||||
提供管理员操作接口，包括在线人数查询、卡密管理和用户时长管理功能。
|
||||
|
||||
#### 使用方法
|
||||
主要命令：
|
||||
- `在线人数`：查询当前在线用户数
|
||||
- `添加卡密 [类型] [卡密]`：添加指定类型的卡密
|
||||
- `生成卡密 [类型]`：生成新卡密
|
||||
- `用户加时 [用户名] [类型]`：为指定用户增加使用时长
|
||||
|
||||
#### 卡密类型
|
||||
- 天卡/day/Day/DAY/天
|
||||
- 周卡/week/Week/WEEK/周
|
||||
- 月卡/month/Month/MONTH/月
|
||||
|
||||
#### 权限要求
|
||||
- 仅超级用户可使用
|
||||
|
||||
#### 配置项
|
||||
```env
|
||||
SUPERUSERS=["1424473282"] # 超级用户ID列表
|
||||
```
|
||||
|
||||
#### 示例
|
||||
```
|
||||
在线人数
|
||||
> 当前在线用户数: 42
|
||||
|
||||
添加卡密 天卡 ABCD1234
|
||||
> 添加卡密成功：天卡 ABCD1234
|
||||
|
||||
生成卡密 周卡
|
||||
> 生成卡密成功：周卡 XYZ789ABC
|
||||
|
||||
用户加时 test_user 月卡
|
||||
> 用户加时成功：test_user 增加了30天
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 5. danding_help - 帮助信息
|
||||
|
||||
#### 功能描述
|
||||
提供各种帮助信息和指南，支持图片形式的教程和指引。
|
||||
|
||||
#### 使用方法
|
||||
主要命令：
|
||||
- `帮助`：显示帮助菜单
|
||||
- `下载`：显示下载信息
|
||||
- `公益版`/`正式版`：显示版本信息
|
||||
- `正式版御魂双开`：显示双开教程
|
||||
- `正式版如何运行`：显示运行教程
|
||||
- `正式版内测计划`：显示内测信息
|
||||
|
||||
#### 权限要求
|
||||
- 仅在特定群(621016172)可用
|
||||
|
||||
#### 技术实现
|
||||
- 使用图片回复提供直观的教程
|
||||
- 文本与图片混合响应
|
||||
|
||||
---
|
||||
|
||||
### 6. command_list - 命令列表管理
|
||||
|
||||
#### 功能描述
|
||||
管理系统命令列表，提供命令过滤和权限控制。
|
||||
|
||||
#### 使用方法
|
||||
- 系统内部使用，不直接暴露给用户
|
||||
|
||||
## 常见问题
|
||||
|
||||
### Q1: 如何启动蛋定助手？
|
||||
A1: 使用`nb run`命令启动，确保已安装所有依赖。
|
||||
|
||||
### Q2: 机器人回复后自动撤回的时间可以修改吗？
|
||||
A2: 可以，在`.env`文件中修改`RECALL_DELAY`的值（单位为秒）。
|
||||
|
||||
### Q3: 如何成为超级用户？
|
||||
A3: 在`.env`文件的`SUPERUSERS`列表中添加您的QQ号。
|
||||
|
||||
### Q4: AI聊天功能如何配置？
|
||||
A4: 需要在`.env`文件中设置`DEEPSEEK_TOKEN`，填入您的DeepSeek API密钥。
|
||||
|
||||
### Q5: 为什么帮助命令在某些群不可用？
|
||||
A5: 帮助命令仅在特定群(621016172)内可用，这是一种权限控制机制。
|
||||
|
||||
## 技术支持
|
||||
|
||||
如有问题，可以：
|
||||
1. 在群内@机器人并提问
|
||||
2. 访问帮助文档：https://www.danding.icu
|
||||
3. 联系超级用户获取支持
|
||||
Reference in New Issue
Block a user