koishi-plugin-echo-cave 1.3.0 → 1.3.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 pynickle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,73 @@
-# koishi-plugin-cave
+# 📣 koishi-plugin-echo-cave
 
 [![npm](https://img.shields.io/npm/v/koishi-plugin-echo-cave?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-echo-cave)
+[![downloads](https://img.shields.io/npm/dm/koishi-plugin-echo-cave?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-echo-cave)
+[![license](https://img.shields.io/github/license/pynickle/koishi-plugin-echo-cave?style=flat-square)](LICENSE)
 
-Group echo cave
+## 🌌 插件简介
+
+**koishi-plugin-echo-cave** 是一个为 Koishi 机器人框架设计的群聊消息存储与回溯插件。它能够将群聊中的消息（包括普通消息和转发消息）存储到"回声洞"中，并支持随时随机或指定 ID 调取这些消息，为群聊增添更多互动乐趣和记录功能。
+
+## ✨ 功能特性
+
+- 📥 **消息存储**：支持存储普通消息和转发消息到数据库
+- 🖼️ **图片保存**：自动保存消息中的图片资源到本地
+- 🔍 **消息查询**：支持随机获取消息或通过 ID 精确查找
+- 🗑️ **消息管理**：支持删除特定 ID 的消息（需要管理员权限）
+- 📊 **数据持久化**：使用 Koishi 数据库系统，确保数据不会丢失
+
+## 📋 命令列表
+
+| 命令               | 说明             | 权限要求            |
+|------------------|----------------|-----------------|
+| `cave`           | 随机获取一条回声洞消息    | 所有人             |
+| `cave <id>`      | 获取特定 ID 的回声洞消息 | 所有人             |
+| `cave.echo`      | 将引用的消息存入回声洞    | 所有人             |
+| `cave.wipe <id>` | 删除特定 ID 的回声洞消息 | 消息存储者、原始发送者或管理员 |
+
+## 🚀 使用指南
+
+### 1. 安装插件
+
+```bash
+npm install koishi-plugin-echo-cave
+```
+
+### 2. 基本使用
+
+1. **存储消息**：在群聊中引用一条消息，然后发送命令 `cave.echo`
+2. **查看随机消息**：发送命令 `cave` 获取一条随机消息
+3. **查看特定消息**：发送命令 `cave <id>` 查看指定 ID 的消息
+4. **删除消息**：管理员发送命令 `cave.wipe <id>` 删除指定 ID 的消息
+
+## 📁 文件结构
+
+```
+src/
+├── index.ts              # 插件主入口，命令注册和核心功能
+├── forward-helper.ts     # 转发消息处理辅助函数
+├── image-helper.ts       # 图片保存辅助函数
+└── msg-helper.ts         # 消息发送辅助函数
+```
+
+## 🔧 技术说明
+
+- 插件使用 Koishi 数据库系统存储消息记录
+- 图片会保存在 `data/cave/images` 目录下
+- 支持嵌套转发消息的处理
+- 自动检测重复消息，避免存储重复内容
+
+## 📝 注意事项
+
+- 插件只能在群聊中使用，私聊模式下无法正常工作
+- 使用 `cave.echo` 命令前必须先引用一条消息
+- 删除消息需要消息存储者、原始发送者或管理员权限（权限等级 4）
+- 存储的转发消息会保留原始发送者信息
+
+## 🤝 贡献指南
+
+欢迎提交 Issue 或 Pull Request 来帮助改进这个插件！
+
+## 📄 许可证
+
+本项目采用 MIT 许可证 - 详情请查看 [LICENSE](LICENSE) 文件

package/lib/index.cjs

@@ -146,12 +146,12 @@ function apply(ctx) {
     "cave [id:number]",
     "\u968F\u673A\u83B7\u53D6 / \u83B7\u53D6\u7279\u5B9A id \u7684\u56DE\u58F0\u6D1E\u4FE1\u606F"
   ).action(async ({ session }, id) => await getCave(ctx, session, id));
-  ctx.command("cave.echo", "\u5C06\u6D88\u606F\u5B58\u5165\u56DE\u58F0\u6D1E\u7A74").action(
+  ctx.command("cave echo", "\u5C06\u6D88\u606F\u5B58\u5165\u56DE\u58F0\u6D1E\u7A74").action(
     async ({ session }) => await addCave(ctx, session)
   );
-  ctx.command("cave.wipe <id:number>", "\u62B9\u53BB\u7279\u5B9A id \u7684\u56DE\u58F0\u6D1E\u4FE1\u606F", {
-    authority: 4
-  }).action(async ({ session }, id) => await deleteCave(ctx, session, id));
+  ctx.command("cave wipe <id:number>", "\u62B9\u53BB\u7279\u5B9A id \u7684\u56DE\u58F0\u6D1E\u4FE1\u606F").action(
+    async ({ session }, id) => await deleteCave(ctx, session, id)
+  );
 }
 async function getCave(ctx, session, id) {
   if (!session.guildId) {
@@ -184,6 +184,11 @@ async function deleteCave(ctx, session, id) {
   if (caves.length === 0) {
     return "\u{1F50D} \u672A\u627E\u5230\u8BE5 ID \u7684\u56DE\u58F0\u6D1E\u6D88\u606F";
   }
+  const caveMsg = caves[0];
+  const currentUserId = session.userId;
+  if (currentUserId !== caveMsg.userId && currentUserId !== caveMsg.originUserId && (await session.getUser(currentUserId)).authority < 4) {
+    return "\u26D4 \u60A8\u6CA1\u6709\u6743\u9650\u5220\u9664\u6B64\u6D88\u606F\uFF01\u53EA\u6709\u6D88\u606F\u7684\u5B58\u50A8\u8005\u3001\u539F\u59CB\u53D1\u9001\u8005\u6216\u7BA1\u7406\u5458\u53EF\u4EE5\u5220\u9664\u3002";
+  }
   await ctx.database.remove("echo_cave", id);
   return `\u2705 \u5DF2\u6210\u529F\u62B9\u53BB\u56DE\u58F0\u6D1E\u6D88\u606F ID\uFF1A${id}`;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-echo-cave",
   "description": "Group echo cave",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "main": "lib/index.cjs",
   "typings": "lib/index.d.ts",
   "type": "module",