- 使用 nb-cli
nb plugin install nonebot_plugin_memes_api
- 使用 pip
pip install nonebot_plugin_memes_api
并按照 NoneBot 加载插件 加载插件
插件需要“客户端型驱动器”(如 httpx)来下载图片等,驱动器安装和配置参考 NoneBot 选择驱动器
同时需要在 .env.* 配置文件中启用对应的驱动器,例如:
DRIVER=~fastapi+~httpx+~websockets
以下配置项可在
.env.*文件中设置,具体参考 NoneBot 配置方式
- 类型:
str - 默认:
http://127.0.0.1:2233 - 说明:
meme-generatorweb server 地址
- 类型:
List[str] | None - 默认:
None - 说明:命令前缀(仅作用于制作表情的命令);如果不设置默认使用 NoneBot 命令前缀
- 类型:
List[str] - 默认:
[] - 说明:禁用的表情包列表,需填写表情的
key,可在 meme-generator 表情列表 中查看。若只是临时关闭,可以用下文中的“表情包开关”
- 类型:
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"
}
'
- 类型:
bool - 默认:
False - 说明:在表情需要至少 1 张图且没有输入图片时,是否使用发送者的头像
- 类型:
bool - 默认:
False - 说明:在表情需要至少 1 段文字且没有输入文字时,是否使用默认文字
- 类型:
bool - 默认:
True - 说明:使用“随机表情”时是否同时发出表情关键词
- 类型:
MemeListImageConfig - 说明:表情列表图相关设置,其中具体设置项如下:
sort_by- 类型:
str - 默认:
"keywords" - 说明:表情排序方式,可用值:
"key"(按表情key排序)、"keywords"(按表情首个关键词排序)、"date_created"(按表情添加时间排序)、"date_modified"(按表情修改时间排序)
- 类型:
sort_reverse- 类型:
bool - 默认:
False - 说明:是否倒序排序
- 类型:
text_template- 类型:
str - 默认:
"{keywords}" - 说明:表情显示文字模板,可用变量:
"{index}"(序号)、"{key}"(表情名)、"{keywords}"(关键词)、"{shortcuts}"(快捷指令)、"{tags}"(标签)
- 类型:
add_category_icon- 类型:
bool - 默认:
True - 说明:是否添加图标以表示类型,即“图片表情包”和“文字表情包”
- 类型:
label_new_timedelta- 类型:
timedelta - 默认:
timedelta(days=30) - 说明:表情添加时间在该时间间隔以内时,添加
new图标
- 类型:
label_hot_threshold- 类型:
int - 默认:
21 - 说明:单位:次;表情在
label_hot_days内的调用次数超过该阈值时,添加hot图标
- 类型:
label_hot_days- 类型:
int - 默认:
7 - 说明:单位:天;表情调用次数统计周期
- 类型:
memes_list_image_config在.env文件中的设置示例如下:
memes_list_image_config='
{
"sort_by": "keywords",
"sort_reverse": false,
"text_template": "{keywords}",
"add_category_icon": true,
"label_new_timedelta": "P30D",
"label_hot_threshold": 21,
"label_hot_days": 7
}
'
- 类型:
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 基本一致