<div align="center">
<a href="https://nonebot.dev/">
<img src="https://nonebot.dev/logo.png" width="200" height="200" alt="nonebot">
</a>
# nonebot-plugin-memes-api
_✨ [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/badge/python-3.8+-blue.svg" alt="Python">
<img src="https://img.shields.io/badge/nonebot-2.2.0+-red.svg" alt="NoneBot">
<a href="https://pypi.org/project/nonebot-plugin-memes-api">
<img src="https://badgen.net/pypi/v/nonebot-plugin-memes-api" alt="pypi">
</a>
<a href="https://jq.qq.com/?_wv=1027&k=wDVNrMdr">
<img src="https://img.shields.io/badge/QQ%E7%BE%A4-682145034-orange" alt="qq group">
</a>
</p>
</div>
> 本插件为 [nonebot-plugin-memes](https://github.com/noneplugin/nonebot-plugin-memes) 调用 api 版本
>
> 可以将本插件与 [meme-generator](https://github.com/MeetWq/meme-generator) 分开部署
### 安装
- 使用 nb-cli
```
nb plugin install nonebot_plugin_memes_api
```
- 使用 pip
```
pip install nonebot_plugin_memes_api
```
并按照 [NoneBot 加载插件](https://nonebot.dev/docs/tutorial/create-plugin#加载插件) 加载插件
#### 配置驱动器
插件需要“客户端型驱动器”（如 httpx）来下载图片等，驱动器安装和配置参考 [NoneBot 选择驱动器](https://nonebot.dev/docs/advanced/driver)
同时需要在 `.env.*` 配置文件中启用对应的驱动器，例如：
```
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)
#### `meme_generator_base_url`
- 类型：`str`
- 默认：`http://127.0.0.1:2233`
- 说明：meme-generator web server 地址
#### `memes_command_start`
- 类型：`List[str]`
- 默认：`[]`
- 说明：命令前缀，若不配置则使用 [NoneBot 命令前缀](https://nonebot.dev/docs/appendices/config#command-start-和-command-separator)
#### `memes_command_force_whitespace`
- 类型：`bool`
- 默认：`True`
- 说明：是否强制要求命令后加空格（仅当命令后是文本时需要加空格）
#### `memes_disabled_list`
- 类型：`List[str]`
- 默认：`[]`
- 说明：禁用的表情包列表，需填写表情的`key`，可在 [meme-generator 表情列表](https://github.com/MeetWq/meme-generator/blob/main/docs/memes.md) 中查看。若只是临时关闭，可以用下文中的“表情包开关”
#### `memes_prompt_params_error`
- 类型：`bool`
- 默认：`False`
- 说明：是否在图片/文字数量不符或参数解析错误时提示（若没有设置命令前缀不建议开启，否则极易误触发）
#### `memes_use_sender_when_no_image`
- 类型：`bool`
- 默认：`False`
- 说明：在表情需要至少1张图且没有输入图片时，是否使用发送者的头像（谨慎使用，容易误触发）
#### `memes_use_default_when_no_text`
- 类型：`bool`
- 默认：`False`
- 说明：在表情需要至少1段文字且没有输入文字时，是否使用默认文字（谨慎使用，容易误触发）
#### `memes_random_meme_show_info`
- 类型：`bool`
- 默认：`False`
- 说明：使用“随机表情”时是否同时发出表情关键词
### 使用
使用方式与 [nonebot-plugin-memes](https://github.com/noneplugin/nonebot-plugin-memes) 基本一致
Raw data
{
"_id": null,
"home_page": "https://github.com/noneplugin/nonebot-plugin-memes-api",
"name": "nonebot_plugin_memes_api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "meetwq",
"author_email": "meetwq@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/66/ff/5bc1f15dcdab211663bb463cf3ca952a68ee5ccd039bd010f231f79a0c6d/nonebot_plugin_memes_api-0.3.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n <a href=\"https://nonebot.dev/\">\n <img src=\"https://nonebot.dev/logo.png\" width=\"200\" height=\"200\" alt=\"nonebot\">\n </a>\n\n# nonebot-plugin-memes-api\n\n_\u2728 [Nonebot2](https://github.com/nonebot/nonebot2) \u8868\u60c5\u5305\u5236\u4f5c\u63d2\u4ef6 \u8c03\u7528 api \u7248\u672c \u2728_\n\n<p align=\"center\">\n <img src=\"https://img.shields.io/github/license/noneplugin/nonebot-plugin-memes-api\" alt=\"license\">\n <img src=\"https://img.shields.io/badge/python-3.8+-blue.svg\" alt=\"Python\">\n <img src=\"https://img.shields.io/badge/nonebot-2.2.0+-red.svg\" alt=\"NoneBot\">\n <a href=\"https://pypi.org/project/nonebot-plugin-memes-api\">\n <img src=\"https://badgen.net/pypi/v/nonebot-plugin-memes-api\" alt=\"pypi\">\n </a>\n <a href=\"https://jq.qq.com/?_wv=1027&k=wDVNrMdr\">\n <img src=\"https://img.shields.io/badge/QQ%E7%BE%A4-682145034-orange\" alt=\"qq group\">\n </a>\n</p>\n\n</div>\n\n> \u672c\u63d2\u4ef6\u4e3a [nonebot-plugin-memes](https://github.com/noneplugin/nonebot-plugin-memes) \u8c03\u7528 api \u7248\u672c\n>\n> \u53ef\u4ee5\u5c06\u672c\u63d2\u4ef6\u4e0e [meme-generator](https://github.com/MeetWq/meme-generator) \u5206\u5f00\u90e8\u7f72\n\n### \u5b89\u88c5\n\n- \u4f7f\u7528 nb-cli\n\n```\nnb plugin install nonebot_plugin_memes_api\n```\n\n- \u4f7f\u7528 pip\n\n```\npip install nonebot_plugin_memes_api\n```\n\n\u5e76\u6309\u7167 [NoneBot \u52a0\u8f7d\u63d2\u4ef6](https://nonebot.dev/docs/tutorial/create-plugin#\u52a0\u8f7d\u63d2\u4ef6) \u52a0\u8f7d\u63d2\u4ef6\n\n#### \u914d\u7f6e\u9a71\u52a8\u5668\u200b\n\n\u63d2\u4ef6\u9700\u8981\u201c\u5ba2\u6237\u7aef\u578b\u9a71\u52a8\u5668\u201d\uff08\u5982 httpx\uff09\u6765\u4e0b\u8f7d\u56fe\u7247\u7b49\uff0c\u9a71\u52a8\u5668\u5b89\u88c5\u548c\u914d\u7f6e\u53c2\u8003 [NoneBot \u9009\u62e9\u9a71\u52a8\u5668](https://nonebot.dev/docs/advanced/driver)\n\n\u540c\u65f6\u9700\u8981\u5728 `.env.*` \u914d\u7f6e\u6587\u4ef6\u4e2d\u542f\u7528\u5bf9\u5e94\u7684\u9a71\u52a8\u5668\uff0c\u4f8b\u5982\uff1a\n\n```\nDRIVER=~fastapi+~httpx+~websockets\n```\n\n#### meme-generator \u90e8\u7f72\n\n\u6309\u7167 [meme-generator \u5b89\u88c5](https://github.com/MeetWq/meme-generator#\u5b89\u88c5) \u4e2d\u7684\u8bf4\u660e\u5b89\u88c5\uff0c\u5e76\u4e0b\u8f7d\u56fe\u7247\u3001\u5b89\u88c5\u5b57\u4f53\u7b49\n\n\u4e4b\u540e\u901a\u8fc7 `meme run` \u542f\u52a8 web server\n\n### \u914d\u7f6e\u9879\n\n> \u4ee5\u4e0b\u914d\u7f6e\u9879\u53ef\u5728 `.env.*` \u6587\u4ef6\u4e2d\u8bbe\u7f6e\uff0c\u5177\u4f53\u53c2\u8003 [NoneBot \u914d\u7f6e\u65b9\u5f0f](https://nonebot.dev/docs/appendices/config)\n\n#### `meme_generator_base_url`\n\n- \u7c7b\u578b\uff1a`str`\n- \u9ed8\u8ba4\uff1a`http://127.0.0.1:2233`\n- \u8bf4\u660e\uff1ameme-generator web server \u5730\u5740\n\n#### `memes_command_start`\n\n- \u7c7b\u578b\uff1a`List[str]`\n- \u9ed8\u8ba4\uff1a`[]`\n- \u8bf4\u660e\uff1a\u547d\u4ee4\u524d\u7f00\uff0c\u82e5\u4e0d\u914d\u7f6e\u5219\u4f7f\u7528 [NoneBot \u547d\u4ee4\u524d\u7f00](https://nonebot.dev/docs/appendices/config#command-start-\u548c-command-separator)\n\n#### `memes_command_force_whitespace`\n\n- \u7c7b\u578b\uff1a`bool`\n- \u9ed8\u8ba4\uff1a`True`\n- \u8bf4\u660e\uff1a\u662f\u5426\u5f3a\u5236\u8981\u6c42\u547d\u4ee4\u540e\u52a0\u7a7a\u683c\uff08\u4ec5\u5f53\u547d\u4ee4\u540e\u662f\u6587\u672c\u65f6\u9700\u8981\u52a0\u7a7a\u683c\uff09\n\n#### `memes_disabled_list`\n\n- \u7c7b\u578b\uff1a`List[str]`\n- \u9ed8\u8ba4\uff1a`[]`\n- \u8bf4\u660e\uff1a\u7981\u7528\u7684\u8868\u60c5\u5305\u5217\u8868\uff0c\u9700\u586b\u5199\u8868\u60c5\u7684`key`\uff0c\u53ef\u5728 [meme-generator \u8868\u60c5\u5217\u8868](https://github.com/MeetWq/meme-generator/blob/main/docs/memes.md) \u4e2d\u67e5\u770b\u3002\u82e5\u53ea\u662f\u4e34\u65f6\u5173\u95ed\uff0c\u53ef\u4ee5\u7528\u4e0b\u6587\u4e2d\u7684\u201c\u8868\u60c5\u5305\u5f00\u5173\u201d\n\n#### `memes_prompt_params_error`\n\n- \u7c7b\u578b\uff1a`bool`\n- \u9ed8\u8ba4\uff1a`False`\n- \u8bf4\u660e\uff1a\u662f\u5426\u5728\u56fe\u7247/\u6587\u5b57\u6570\u91cf\u4e0d\u7b26\u6216\u53c2\u6570\u89e3\u6790\u9519\u8bef\u65f6\u63d0\u793a\uff08\u82e5\u6ca1\u6709\u8bbe\u7f6e\u547d\u4ee4\u524d\u7f00\u4e0d\u5efa\u8bae\u5f00\u542f\uff0c\u5426\u5219\u6781\u6613\u8bef\u89e6\u53d1\uff09\n\n#### `memes_use_sender_when_no_image`\n\n- \u7c7b\u578b\uff1a`bool`\n- \u9ed8\u8ba4\uff1a`False`\n- \u8bf4\u660e\uff1a\u5728\u8868\u60c5\u9700\u8981\u81f3\u5c111\u5f20\u56fe\u4e14\u6ca1\u6709\u8f93\u5165\u56fe\u7247\u65f6\uff0c\u662f\u5426\u4f7f\u7528\u53d1\u9001\u8005\u7684\u5934\u50cf\uff08\u8c28\u614e\u4f7f\u7528\uff0c\u5bb9\u6613\u8bef\u89e6\u53d1\uff09\n\n#### `memes_use_default_when_no_text`\n\n- \u7c7b\u578b\uff1a`bool`\n- \u9ed8\u8ba4\uff1a`False`\n- \u8bf4\u660e\uff1a\u5728\u8868\u60c5\u9700\u8981\u81f3\u5c111\u6bb5\u6587\u5b57\u4e14\u6ca1\u6709\u8f93\u5165\u6587\u5b57\u65f6\uff0c\u662f\u5426\u4f7f\u7528\u9ed8\u8ba4\u6587\u5b57\uff08\u8c28\u614e\u4f7f\u7528\uff0c\u5bb9\u6613\u8bef\u89e6\u53d1\uff09\n\n#### `memes_random_meme_show_info`\n\n- \u7c7b\u578b\uff1a`bool`\n- \u9ed8\u8ba4\uff1a`False`\n- \u8bf4\u660e\uff1a\u4f7f\u7528\u201c\u968f\u673a\u8868\u60c5\u201d\u65f6\u662f\u5426\u540c\u65f6\u53d1\u51fa\u8868\u60c5\u5173\u952e\u8bcd\n\n### \u4f7f\u7528\n\n\u4f7f\u7528\u65b9\u5f0f\u4e0e [nonebot-plugin-memes](https://github.com/noneplugin/nonebot-plugin-memes) \u57fa\u672c\u4e00\u81f4\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Nonebot2 plugin for making memes",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/noneplugin/nonebot-plugin-memes-api",
"Repository": "https://github.com/noneplugin/nonebot-plugin-memes-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "faf76e19c7c6da34a5f3387d549ac840f4d4e419524980ebdaf84ae520b94146",
"md5": "f561b24bcef298dd3e7689f4ac0c28a3",
"sha256": "10ac2ec5bd36d8fb2030c54fba1d245db2d8055fb08deced64fef848bc48d595"
},
"downloads": -1,
"filename": "nonebot_plugin_memes_api-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f561b24bcef298dd3e7689f4ac0c28a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 15532,
"upload_time": "2024-03-12T09:44:02",
"upload_time_iso_8601": "2024-03-12T09:44:02.760534Z",
"url": "https://files.pythonhosted.org/packages/fa/f7/6e19c7c6da34a5f3387d549ac840f4d4e419524980ebdaf84ae520b94146/nonebot_plugin_memes_api-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66ff5bc1f15dcdab211663bb463cf3ca952a68ee5ccd039bd010f231f79a0c6d",
"md5": "eb6e75fa589b5692efad5898d46f7992",
"sha256": "87eded8d11c6050c3228047dc84ae0a8f4112083f3992407b61d6b740d4084b2"
},
"downloads": -1,
"filename": "nonebot_plugin_memes_api-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "eb6e75fa589b5692efad5898d46f7992",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 13669,
"upload_time": "2024-03-12T09:44:04",
"upload_time_iso_8601": "2024-03-12T09:44:04.101997Z",
"url": "https://files.pythonhosted.org/packages/66/ff/5bc1f15dcdab211663bb463cf3ca952a68ee5ccd039bd010f231f79a0c6d/nonebot_plugin_memes_api-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 09:44:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "noneplugin",
"github_project": "nonebot-plugin-memes-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nonebot_plugin_memes_api"
}
JSON
