Merge pull request #15 from MemeCrafters/rust

use meme-generator-rs

Author: MeetWq

README.md

@@ -9,7 +9,7 @@
 _✨ [Nonebot2](https://github.com/nonebot/nonebot2) 表情包制作插件 调用 api 版本 ✨_
 
 <p align="center">
-  <img src="https://img.shields.io/github/license/noneplugin/nonebot-plugin-memes-api" alt="license">
+  <img src="https://img.shields.io/github/license/MemeCrafters/nonebot-plugin-memes-api" alt="license">
   <img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="Python">
   <img src="https://img.shields.io/badge/nonebot-2.3.0+-red.svg" alt="NoneBot">
   <a href="https://pypi.org/project/nonebot-plugin-memes-api">
@@ -22,9 +22,9 @@ _✨ [Nonebot2](https://github.com/nonebot/nonebot2) 表情包制作插件 调
 
 </div>
 
-> 本插件为 [nonebot-plugin-memes](https://github.com/noneplugin/nonebot-plugin-memes) 调用 api 版本
+> 本插件为 [nonebot-plugin-memes](https://github.com/MemeCrafters/nonebot-plugin-memes) 调用 api 版本
 >
-> 可以将本插件与 [meme-generator](https://github.com/MeetWq/meme-generator) 分开部署
+> 可以将本插件与 [meme-generator](https://github.com/MemeCrafters/meme-generator-rs) 分开部署
 
 ### 安装
 
@@ -42,7 +42,7 @@ pip install nonebot_plugin_memes_api
 
 并按照 [NoneBot 加载插件](https://nonebot.dev/docs/tutorial/create-plugin#加载插件) 加载插件
 
-#### 配置驱动器​
+#### 配置驱动器 ​
 
 插件需要“客户端型驱动器”（如 httpx）来下载图片等，驱动器安装和配置参考 [NoneBot 选择驱动器](https://nonebot.dev/docs/advanced/driver)
 
@@ -52,12 +52,6 @@ pip install nonebot_plugin_memes_api
 DRIVER=~fastapi+~httpx+~websockets
 ```
 
-#### meme-generator 部署
-
-按照 [meme-generator 安装](https://github.com/MeetWq/meme-generator#安装) 中的说明安装，并下载图片、安装字体等
-
-之后通过 `meme run` 启动 web server
-
 ### 配置项
 
 > 以下配置项可在 `.env.*` 文件中设置，具体参考 [NoneBot 配置方式](https://nonebot.dev/docs/appendices/config)
@@ -80,23 +74,50 @@ DRIVER=~fastapi+~httpx+~websockets
 - 默认：`[]`
 - 说明：禁用的表情包列表，需填写表情的`key`，可在 [meme-generator 表情列表](https://github.com/MeetWq/meme-generator/blob/main/docs/memes.md) 中查看。若只是临时关闭，可以用下文中的“表情包开关”
 
-#### `memes_prompt_params_error`
+#### `memes_params_mismatch_policy`
 
-- 类型：`bool`
-- 默认：`False`
-- 说明：是否在图片/文字数量不符时提示（谨慎使用，容易误触发）
+- 类型：`MemeParamsMismatchPolicy`
+- 说明：图片/文字数量不符时的处理方式，其中具体设置项如下：
+  - `too_much_text`
+    - 类型：`str`
+    - 默认：`"ignore"`
+    - 可选项：`"ignore"`（忽略本次命令）、 `"prompt"`（发送提示）, `"drop"`（去掉多余的文字）
+  - `too_few_text`
+    - 类型：`str`
+    - 默认：`"ignore"`
+    - 可选项：`"ignore"`（忽略本次命令）、 `"prompt"`（发送提示）, `"get"`（交互式获取所需的文字）
+  - `too_much_image`
+    - 类型：`str`
+    - 默认：`"ignore"`
+    - 可选项：`"ignore"`（忽略本次命令）、 `"prompt"`（发送提示）, `"drop"`（去掉多余的图片）
+  - `too_few_image`
+    - 类型：`str`
+    - 默认：`"ignore"`
+    - 可选项：`"ignore"`（忽略本次命令）、 `"prompt"`（发送提示）, `"get"`（交互式获取所需的图片）
+- `memes_params_mismatch_policy` 在 `.env` 文件中的设置示例如下：
+
+```
+memes_params_mismatch_policy='
+{
+  "too_much_text": "drop",
+  "too_few_text": "get",
+  "too_much_image": "drop",
+  "too_few_image": "get"
+}
+'
+```
 
 #### `memes_use_sender_when_no_image`
 
 - 类型：`bool`
 - 默认：`False`
-- 说明：在表情需要至少1张图且没有输入图片时，是否使用发送者的头像（谨慎使用，容易误触发）
+- 说明：在表情需要至少 1 张图且没有输入图片时，是否使用发送者的头像
 
 #### `memes_use_default_when_no_text`
 
 - 类型：`bool`
 - 默认：`False`
-- 说明：在表情需要至少1段文字且没有输入文字时，是否使用默认文字（谨慎使用，容易误触发）
+- 说明：在表情需要至少 1 段文字且没有输入文字时，是否使用默认文字
 
 #### `memes_random_meme_show_info`
 
@@ -152,6 +173,34 @@ memes_list_image_config='
 '
 ```
 
+#### `memes_multiple_image_config`
+
+- 类型：`MultipleImageConfig`
+- 说明：发送多张图片时的相关设置，其中具体设置项如下：
+  - `direct_send_threshold`
+    - 类型：`int`
+    - 默认：`10`
+    - 说明：发送图片数量大于该数目时，不再直接发送，而是以文件或合并转发消息的形式发送
+  - `send_zip_file`
+    - 类型：`bool`
+    - 默认：`True`
+    - 说明：发送图片数量大于 `direct_send_threshold` 时，是否打包为zip以文件形式发送
+  - `send_forward_msg`
+    - 类型：`bool`
+    - 默认：`False`
+    - 说明：发送图片数量大于 `direct_send_threshold` 时，是否发送合并转发消息
+- `memes_multiple_image_config` 在 `.env` 文件中的设置示例如下：
+
+```
+memes_multiple_image_config='
+{
+  "direct_send_threshold": 10,
+  "send_zip_file": true,
+  "send_forward_msg": true
+}
+'
+```
+
 ### 使用
 
-使用方式与 [nonebot-plugin-memes](https://github.com/noneplugin/nonebot-plugin-memes) 基本一致
+使用方式与 [nonebot-plugin-memes](https://github.com/MemeCrafters/nonebot-plugin-memes) 基本一致

nonebot_plugin_memes_api/__init__.py

@@ -18,33 +18,35 @@
     description="制作各种沙雕表情包",
     usage=(
         "- 表情列表\n"
-        "发送 “表情包制作” 查看表情列表\n"
+        "  发送“表情包制作”查看表情列表\n\n"
         "- 表情详情\n"
-        "发送 “表情详情 + 表情名/关键词” 查看表情详细信息和表情预览\n"
+        "  发送“表情详情 + 关键词”查看表情详细信息和表情预览\n\n"
         "- 表情搜索\n"
-        "发送 “表情搜索 + 关键词” 查找相关的表情\n"
-        "- 表情包开关\n"
-        "- “超级用户” 和 “管理员” 可以启用或禁用某些表情包\n"
-        "发送 启用表情/禁用表情 表情名/关键词，如：禁用表情 摸\n"
-        "- “超级用户” 可以设置某个表情包的管控模式（黑名单/白名单）\n"
-        "发送 全局启用表情 表情名/关键词 可将表情设为黑名单模式；\n"
-        "发送 全局禁用表情 表情名/关键词 可将表情设为白名单模式；\n"
+        "  发送“表情搜索 + 关键词”查找相关的表情\n\n"
+        "- 表情开关\n"
+        "  - “超级用户”和“管理员”可以启用或禁用某些表情\n"
+        "    发送“启用表情/禁用表情 + 关键词”，如：“禁用表情 摸”\n"
+        "  - “超级用户” 可以设置某个表情包的管控模式（黑名单/白名单）\n"
+        "    发送“全局启用表情 + 关键词”可将表情设为黑名单模式；\n"
+        "    发送“全局禁用表情 + 关键词”可将表情设为白名单模式；\n\n"
         "- 表情使用\n"
-        f"发送 “{memes_prefix}关键词 + 图片/文字” 制作表情\n"
-        "可使用 “自己”、“@某人” 获取指定用户的头像作为图片\n"
-        "可使用 “@ + 用户id” 指定任意用户获取头像，如 “摸 @114514”\n"
-        "可将回复中的消息作为文字和图片的输入\n"
+        f"  发送 “{memes_prefix}关键词 + 图片/文字” 制作表情\n"
+        "  可使用“自己”、“@某人”获取指定用户的头像作为图片，如“摸 自己”\n"
+        "  可使用“@ + 用户id”指定任意用户获取头像，如“摸 @114514”\n"
+        "  可将回复中的消息作为文字和图片的输入\n"
+        "  指定用户时将使用用户昵称作为“图片名”\n"
+        "  可使用“# + 名字”指定“图片名”，如“小天使 #name 自己”\n\n"
         "- 随机表情\n"
-        "发送 “随机表情 + 图片/文字” 可随机制作表情\n"
-        "随机范围为 图片/文字 数量符合要求的表情\n"
+        "  发送“随机表情 + 图片/文字”可随机制作表情\n"
+        "  随机范围为 图片/文字 数量符合要求的表情\n\n"
         "- 表情调用统计\n"
-        "发送 “[我的][全局]<时间段>表情调用统计 [表情名]” 获取表情调用次数统计图\n"
-        "“我的”、“全局”、<时间段>、“表情名” 均为可选项\n"
-        "<时间段> 的关键词有：日、本日、周、本周、月、本月、年、本年\n"
-        "如：“我的今日表情调用统计 petpet”"
+        "  发送 “[我的][全局]<时间段>表情调用统计 + [表情名]” 获取表情调用次数统计图\n"
+        "  “我的”、“全局”、<时间段>、“表情名” 均为可选项\n"
+        "  <时间段> 可以为：日、本日、周、本周、月、本月、年、本年\n"
+        "  如：“我的今日表情调用统计 petpet”"
     ),
     type="application",
-    homepage="https://github.com/noneplugin/nonebot-plugin-memes",
+    homepage="https://github.com/noneplugin/nonebot-plugin-memes-api",
     config=Config,
     supported_adapters=inherit_supported_adapters(
         "nonebot_plugin_alconna", "nonebot_plugin_uninfo"