koishi-plugin-image-save-path
v1.6.0
Published
[<ruby>保存图片<rp>(</rp><rt>点我查看食用方法</rt><rp>)</rp></ruby>](https://www.npmjs.com/package/koishi-plugin-image-save-path) 💾支持[交互保存图片](https://i0.hdslb.com/bfs/article/a2780975ccbf74c422dd7f0333af0172312276085.png) 、 [回复保存图片](https://i0.hdslb.com/bfs/article/
Maintainers
Readme
图片保存配置项
1. 图片扩展名配置 (ImageExtension)
功能描述
ImageExtension 是一个用于定义图片保存时文件名前缀、后缀和默认扩展名的配置项。支持动态替换日期、随机数字以及 session 和 config 中的字段。
配置项格式
类型:数组(仅第一行视为有效配置)
默认值:
[ { prefix: "", suffix: "", extension: ".png" } ]示例:
ImageExtension: [ { prefix: "prefix_${YYYY}_", suffix: "_${session.userId}", extension: ".jpg" } ]
可用占位符
| 占位符 | 描述 |
| ------------ | -------------------------------------------------------------------- |
| ${YYYY} | 当前年份,例如 2023 |
| ${MM} | 当前月份,补零到两位,例如 01 到 12 |
| ${DD} | 当前日期,补零到两位,例如 01 到 31 |
| ${A} | 一位随机数字,范围 0 到 9 |
| ${BB} | 两位随机数字,范围 00 到 99 |
| ${CCC} | 三位随机数字,范围 000 到 999 |
| ${session} | 动态提取 session 对象的字段,例如 ${session.userId} |
| ${config} | 动态提取 config 对象的字段,例如 ${config.defaultImageExtension} |
示例
默认格式:
ImageExtension: [ { prefix: "", suffix: "", extension: ".png" } ]- 生成文件名:
2023-10-05-12-34-56-789.png。
- 生成文件名:
包含前缀和后缀:
ImageExtension: [ { prefix: "prefix_${YYYY}_", suffix: "_${session.userId}", extension: ".jpg" } ]- 生成文件名(假设
session.userId为12345):prefix_2023_2023-10-05-12-34-56-789_12345.jpg。
- 生成文件名(假设
包含配置项:
ImageExtension: [ { prefix: "prefix_${config.ImageExtension[0]?.extension}_", suffix: "_${CCC}", extension: ".png" } ]- 生成文件名(假设
config.defaultImageExtension为png):prefix_png_2023-10-05-12-34-56-789_123.png。
- 生成文件名(假设
2. 图片自动重命名规则 (autoRenameRules)
功能描述
autoRenameRules 是一个用于定义图片自动重命名规则的配置项。通过设置占位符,用户可以自定义生成的文件名格式。支持动态替换日期、随机数字以及 session 和 config 中的字段。
配置项格式
类型:字符串
默认值:
${YYYY}-${MM}-${DD}-${BB}-${BB}-${BB}-${CCC}示例:
autoRenameRules: "${YYYY}-${MM}-${DD}-${BB}-${BB}-${BB}-${CCC}-${session.userId}"
可用占位符
| 占位符 | 描述 |
| ------------ | -------------------------------------------------------------------- |
| ${YYYY} | 当前年份,例如 2023 |
| ${MM} | 当前月份,补零到两位,例如 01 到 12 |
| ${DD} | 当前日期,补零到两位,例如 01 到 31 |
| ${A} | 一位随机数字,范围 0 到 9 |
| ${BB} | 两位随机数字,范围 00 到 99 |
| ${CCC} | 三位随机数字,范围 000 到 999 |
| ${session} | 动态提取 session 对象的字段,例如 ${session.userId} |
| ${config} | 动态提取 config 对象的字段,例如 ${config.defaultImageExtension} |
示例
默认格式:
autoRenameRules: "${YYYY}-${MM}-${DD}-${BB}-${BB}-${BB}-${CCC}"- 生成文件名:
2023-10-05-12-34-56-789.png。
- 生成文件名:
包含用户 ID:
autoRenameRules: "${YYYY}-${MM}-${DD}-${BB}-${BB}-${BB}-${CCC}-${session.userId}"- 生成文件名(假设
session.userId为12345):2023-10-05-12-34-56-789-12345.png。
- 生成文件名(假设
包含配置项:
autoRenameRules: "${YYYY}-${MM}-${DD}-${BB}-${BB}-${BB}-${CCC}-${config.defaultImageExtension}"- 生成文件名(假设
config.defaultImageExtension为png):2023-10-05-12-34-56-789-png.png。
- 生成文件名(假设
