koishi-plugin-best-cave 1.6.0 → 1.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +60 -58
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "koishi-plugin-best-cave",
3
3
  "description": "功能最强的 cave 插件，支持黑白名单、审核与自动查重，人性化的添加方式，可添加图文甚至视频，可查阅投稿列表，完善的 ID 管理与 Hash 校验机制，比你听过的任何 cave 都强！",
4
- "version": "1.6.0",
4
+ "version": "1.6.1",
5
5
  "contributors": [
6
6
  "Yis_Rime <yis_rime@outlook.com>"
7
7
  ],
package/readme.md CHANGED
@@ -2,99 +2,101 @@
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/koishi-plugin-best-cave?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-best-cave)
4
4
 
5
- ## 简介
5
+ 功能最强的 cave 插件，支持黑白名单、审核与自动查重，人性化的添加方式，可添加图文甚至视频，可查阅投稿列表，完善的 ID 管理与 Hash 校验机制，比你听过的任何 cave 都强！
6
6
 
7
- 最好的 cave 插件，可开关的审核系统，可引用添加，支持图文混合内容，可查阅投稿列表，完美复刻你的 .cave 体验！
7
+ ## 功能亮点
8
8
 
9
- ### 核心功能
9
+ - 支持文字、图片与视频内容
10
+ - 审核与自动查重机制
11
+ - 黑白名单管理
12
+ - 完善的用户统计
13
+
14
+ ## 核心功能
10
15
 
11
16
  - **内容管理**
12
- - 支持文字与图片混合保存，自动保持布局顺序
17
+ - 文字与图片混合保存，自动保持布局顺序
13
18
  - 视频内容单独发送，支持多种格式
14
19
  - 自动文本格式化与排版
15
20
  - 引用消息自动解析和保存
16
- - 支持引用已有内容的布局
17
21
 
18
22
  - **重复检测**
19
- - 独立的文本与图片查重开关
20
- - 可配置的文本相似度阈值
21
- - 可配置的图片相似度阈值
22
23
  - 基于感知哈希的图片查重
23
24
  - 基于MD5的精确查重
24
- - 精确重复自动拒绝
25
25
  - 相似内容提示预览
26
26
 
27
27
  - **审核机制**
28
- - 可配置的审核开关与多级权限
29
- - 完整的黑白名单系统（支持用户/群组/频道）
28
+ - 完整的黑白名单系统
30
29
  - 白名单用户自动跳过审核
31
- - 支持单条和批量审核操作
32
30
  - 拒绝审核时自动清理媒体文件
33
- - 审核消息自动通知管理员
34
31
 
35
32
  - **媒体处理**
36
33
  - 智能处理多种类型媒体链接
37
34
  - 支持本地图片上传和URL引用
38
35
  - 自动文件大小检查与限制
39
- - 视频内容自动单独发送
40
- - MD5文件名防重复
41
- - 自动清理无效媒体
42
36
 
43
- - **使用体验**
44
- - 基于群组的调用冷却机制
45
- - 管理员操作不受冷却限制
46
- - 支持按页浏览投稿记录
47
- - 支持按用户ID查询统计
48
- - 临时消息自动清理
49
- - 错误提示自动消失
37
+ ## 指令说明
50
38
 
51
- ### 指令
39
+ ### 基础指令
52
40
 
53
- | 指令 | 说明 | 权限 |
41
+ | 指令 | 示例 | 说明 |
54
42
  |------|------|------|
55
- | `cave` | 随机展示一条回声洞 | 所有人 |
56
- | `cave -a <内容>` | 添加新回声洞（支持文字、图片与视频） | 所有人 |
57
- | `cave -g <编号>` | 查看指定回声洞 | 所有人 |
58
- | `cave -r <编号>` | 删除指定回声洞 | 内容贡献者/管理员 |
59
- | `cave -l [页码/用户ID]` | 查看投稿统计 | 所有人(仅自己)/管理员(全部) |
43
+ | `cave` | `cave` | 随机抽取一条回声洞 |
44
+ | `cave -a` | `cave -a 内容` | 添加新回声洞 |
45
+ | `cave -g` | `cave -g 123` | 查看指定编号回声洞 |
46
+ | `cave -r` | `cave -r 123` | 删除指定回声洞 |
47
+ | `cave -l` | `cave -l 2` 或 `cave -l 114514` | 查看统计或指定用户投稿 |
60
48
 
61
- #### 管理指令
49
+ ### 审核指令 (仅管理员)
62
50
 
63
- | 指令 | 说明 | 权限 |
51
+ | 指令 | 示例 | 说明 |
64
52
  |------|------|------|
65
- | `cave -p <编号/all>` | 通过待审核内容 | 管理员 |
66
- | `cave -d <编号/all>` | 拒绝待审核内容 | 管理员 |
53
+ | `cave.pass` | `cave.pass 123` 或 `cave.pass all` | 通过指定/所有待审核内容 |
54
+ | `cave.reject` | `cave.reject 123` 或 `cave.reject all` | 拒绝指定/所有待审核内容 |
55
+
56
+ ## 配置说明
67
57
 
68
- ### 配置项
58
+ ### 基础配置
69
59
 
70
60
  | 配置项 | 类型 | 默认值 | 说明 |
71
61
  |--------|------|--------|------|
72
- | manager | string[] | [] | 管理员用户ID列表 |
62
+ | manager | string[] | [] | 管理员ID列表 |
73
63
  | number | number | 60 | 冷却时间(秒) |
74
- | enableAudit | boolean | false | 是否启用审核 |
75
- | imageMaxSize | number | 4 | 图片大小限制(MB) |
76
- | enableImageDuplicate | boolean | true | 是否启用图片查重 |
77
- | imageDuplicateThreshold | number | 0.8 | 图片查重阈值(0-1) |
78
- | enableTextDuplicate | boolean | true | 是否启用文本查重 |
79
- | textDuplicateThreshold | number | 0.9 | 文本查重阈值(0-1) |
80
- | allowVideo | boolean | true | 是否允许视频 |
81
- | videoMaxSize | number | 16 | 视频大小限制(MB) |
82
- | enablePagination | boolean | false | 是否启用分页 |
83
- | itemsPerPage | number | 10 | 每页显示条数 |
84
- | blacklist | string[] | [] | 黑名单用户/群组ID |
85
- | whitelist | string[] | [] | 白名单用户/群组ID |
86
-
87
- ### 注意事项
64
+ | enablePagination | boolean | false | 启用统计分页 |
65
+ | itemsPerPage | number | 10 | 每页显示数目 |
66
+
67
+ ### 权限管理
68
+
69
+ | 配置项 | 类型 | 默认值 | 说明 |
70
+ |--------|------|--------|------|
71
+ | enableAudit | boolean | false | 启用审核机制 |
72
+ | blacklist | string[] | [] | 黑名单(用户) |
73
+ | whitelist | string[] | [] | 白名单(用户/群组/频道) |
74
+
75
+ ### 查重配置
76
+
77
+ | 配置项 | 类型 | 默认值 | 说明 |
78
+ |--------|------|--------|------|
79
+ | enableTextDuplicate | boolean | true | 启用文本查重 |
80
+ | textDuplicateThreshold | number | 0.9 | 文本相似度阈值 |
81
+ | enableImageDuplicate | boolean | true | 启用图片查重 |
82
+ | imageDuplicateThreshold | number | 0.8 | 图片相似度阈值 |
83
+
84
+ ### 媒体配置
85
+
86
+ | 配置项 | 类型 | 默认值 | 说明 |
87
+ |--------|------|--------|------|
88
+ | imageMaxSize | number | 4 | 图片最大大小(MB) |
89
+ | allowVideo | boolean | true | 允许视频上传 |
90
+ | videoMaxSize | number | 16 | 视频最大大小(MB) |
91
+
92
+ ## 注意事项
88
93
 
89
94
  1. 图片和视频会自动保存到本地，请确保存储空间充足
90
95
  2. 管理员不受群组冷却时间限制且可查看所有用户统计
91
- 3. 开启审核模式后，白名单内的用户/群组/频道可直接投稿
92
- 4. 引用消息添加时会保留原消息的格式与布局顺序
93
- 5. 支持两种重复检测机制：
96
+ 3. 开启审核模式后，白名单内的用户可直接投稿
97
+ 4. 支持两种重复检测机制：
94
98
  - 基于MD5的精确查重
95
99
  - 基于感知哈希的相似度查重
96
- 6. 黑名单中的用户无法使用任何功能
97
- 7. 支持按页码和用户ID查看投稿统计
98
- 8. 临时消息（如错误提示）会在10秒后自动消失
99
- 9. 视频内容会单独发送以保证正常显示
100
- 10. 支持自动清理被拒绝或删除的媒体文件
100
+ 5. 临时消息（如错误提示）会在10秒后自动消失
101
+ 6. 视频内容会单独发送以保证正常显示
102
+ 7. 支持自动清理被拒绝或删除的媒体文件