| Name | nonebot-plugin-essence-message JSON |
| Version |
0.5.4
JSON |
| download |
| home_page | None |
| Summary | Used to organize essence messages |
| upload_time | 2025-01-19 15:45:13 |
| maintainer | None |
| docs_url | None |
| author | beis |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
<br>
<p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
</div>
<div align="center">
# nonebot-plugin-essence-message
_✨ 用于整理精华消息 ✨_
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/BEISNWKZNAN/nonebot-plugin-essence-message.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-essence-message">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-essence-message.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">
</div>
## 📖 介绍
如果你群有精华消息过多的困扰, 可以考虑使用此插件.
请注意，此插件可能进一步推进你群精华消息通货膨胀。
## 💿 安装
<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot_plugin_essence_message
</details>
<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
<details>
<summary>pip</summary>
pip install nonebot_plugin_essence_message
</details>
打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
plugins = ["nonebot_plugin_essence_message"]
</details>
## ⚙️ 配置
在 nonebot2 项目的`.env`文件中添加下表中的必填配置
| 配置项 | 必填 | 默认值 | 说明 |
| :-------------------------: | :---: | :----: | :----------------------------------------------------------------------------------------------------------: |
| essence_random_limit | 否 | 5 | `essence random` 指令的使用次数上限 |
| essence_random_cooldown | 否 | 5 | `essence random` 指令的使用次数冷却时间 |
| essence_enable_groups | 否 | all | 启用群号列表，默认为 `all` 表示所有群都启用 |
| good_essence_enable_groups | 否 | [] | 是否启用n赞加精功能,会对点赞数超过good_bound的消息自动加精,默认不启用 |
| good_bound | 否 | 3 | 如上 |
| whale_essnece_enable_groups | 否 | [] | 是否使用Reaction🐳代替设精,用于防止精华消息过于泛滥导致刷屏 |
如果要寻找数据库和缓存的位置,请参考nonebot文档的[data-storing](https://nonebot.dev/docs/best-practice/data-storing)章节
## 🎉 使用
### 指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
| :-------------------: | :----: | :---: | :---: | :------------------------------------: |
| essence help | 群员 | 否 | 群聊 | 显示所有可用指令及其说明 |
| essence random | 群员 | 否 | 群聊 | 随机发送一条精华消息 |
| essence rank sender | 群员 | 否 | 群聊 | 显示发送者精华消息排行榜 |
| essence rank operator | 群员 | 否 | 群聊 | 显示管理员设精数量精华消息排行榜 |
| essence fetchall | 管理员 | 否 | 群聊 | 获取群内所有精华消息，并存储到数据库中 |
| essence export | 管理员 | 否 | 群聊 | 导出当前群的精华消息数据库文件 |
| essence saveall | 管理员 | 否 | 群聊 | 将群内所有精华消息中的图片保存至本地 |
| essence clean | 管理员 | 否 | 群聊 | 删除群里所有精华消息（数据库中保留） |
### 精华事件
- 本插件在正常工作时,会对精华消息做出响应,随之把消息存入或删除数据库.
- 当精华消息空间满了之后,可以使用essence clean删除精华消息,这次清理不会删除数据库中的精华消息.
### Reaction事件
- 本插件在正常工作时,会对🐳(code:128051)和👍(code:74)做出响应.
- 如果启用了n赞加精功能,此功能会对点赞数超过good_bound的消息自动加精,使得每个群友都有设精权
- 如果启用了 whale-essnece 功能,此功能会对管理员(包括SUPERUSER,群主和群管理员)的🐳(code:128051)Reaction事件做出反应,把该条消息放入数据库,并回复一个✨(code:10024)表示操作完成
- 如果两个功能同时启用,n赞加精会用🐳代替设精
### 效果图
Raw data
{
"_id": null,
"home_page": null,
"name": "nonebot-plugin-essence-message",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "beis",
"author_email": "havaagoodtime@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/cc/5f/7bc6e7b58b8879e9c4f0f383096d843c562ac460b1eb448c64a22cc8975a/nonebot_plugin_essence_message-0.5.4.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://v2.nonebot.dev/store\"><img src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png\" width=\"180\" height=\"180\" alt=\"NoneBotPluginLogo\"></a>\n <br>\n <p><img src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg\" width=\"240\" alt=\"NoneBotPluginText\"></p>\n</div>\n\n<div align=\"center\">\n\n# nonebot-plugin-essence-message\n\n_\u2728 \u7528\u4e8e\u6574\u7406\u7cbe\u534e\u6d88\u606f \u2728_\n\n\n<a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/BEISNWKZNAN/nonebot-plugin-essence-message.svg\" alt=\"license\">\n</a>\n<a href=\"https://pypi.python.org/pypi/nonebot-plugin-essence-message\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-essence-message.svg\" alt=\"pypi\">\n</a>\n<img src=\"https://img.shields.io/badge/python-3.9+-blue.svg\" alt=\"python\">\n\n</div>\n\n\n## \ud83d\udcd6 \u4ecb\u7ecd\n\n\u5982\u679c\u4f60\u7fa4\u6709\u7cbe\u534e\u6d88\u606f\u8fc7\u591a\u7684\u56f0\u6270, \u53ef\u4ee5\u8003\u8651\u4f7f\u7528\u6b64\u63d2\u4ef6. \n\u8bf7\u6ce8\u610f\uff0c\u6b64\u63d2\u4ef6\u53ef\u80fd\u8fdb\u4e00\u6b65\u63a8\u8fdb\u4f60\u7fa4\u7cbe\u534e\u6d88\u606f\u901a\u8d27\u81a8\u80c0\u3002\n\n## \ud83d\udcbf \u5b89\u88c5\n\n<details open>\n<summary>\u4f7f\u7528 nb-cli \u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u6839\u76ee\u5f55\u4e0b\u6253\u5f00\u547d\u4ee4\u884c, \u8f93\u5165\u4ee5\u4e0b\u6307\u4ee4\u5373\u53ef\u5b89\u88c5\n\n nb plugin install nonebot_plugin_essence_message\n\n</details>\n\n<details>\n<summary>\u4f7f\u7528\u5305\u7ba1\u7406\u5668\u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c, \u6839\u636e\u4f60\u4f7f\u7528\u7684\u5305\u7ba1\u7406\u5668, \u8f93\u5165\u76f8\u5e94\u7684\u5b89\u88c5\u547d\u4ee4\n\n<details>\n<summary>pip</summary>\n\n pip install nonebot_plugin_essence_message\n</details>\n\n\u6253\u5f00 nonebot2 \u9879\u76ee\u6839\u76ee\u5f55\u4e0b\u7684 `pyproject.toml` \u6587\u4ef6, \u5728 `[tool.nonebot]` \u90e8\u5206\u8ffd\u52a0\u5199\u5165\n\n plugins = [\"nonebot_plugin_essence_message\"]\n\n</details>\n\n## \u2699\ufe0f \u914d\u7f6e\n\n\u5728 nonebot2 \u9879\u76ee\u7684`.env`\u6587\u4ef6\u4e2d\u6dfb\u52a0\u4e0b\u8868\u4e2d\u7684\u5fc5\u586b\u914d\u7f6e\n\n| \u914d\u7f6e\u9879 | \u5fc5\u586b | \u9ed8\u8ba4\u503c | \u8bf4\u660e |\n| :-------------------------: | :---: | :----: | :----------------------------------------------------------------------------------------------------------: |\n| essence_random_limit | \u5426 | 5 | `essence random` \u6307\u4ee4\u7684\u4f7f\u7528\u6b21\u6570\u4e0a\u9650 |\n| essence_random_cooldown | \u5426 | 5 | `essence random` \u6307\u4ee4\u7684\u4f7f\u7528\u6b21\u6570\u51b7\u5374\u65f6\u95f4 |\n| essence_enable_groups | \u5426 | all | \u542f\u7528\u7fa4\u53f7\u5217\u8868\uff0c\u9ed8\u8ba4\u4e3a `all` \u8868\u793a\u6240\u6709\u7fa4\u90fd\u542f\u7528 |\n| good_essence_enable_groups | \u5426 | [] | \u662f\u5426\u542f\u7528n\u8d5e\u52a0\u7cbe\u529f\u80fd,\u4f1a\u5bf9\u70b9\u8d5e\u6570\u8d85\u8fc7good_bound\u7684\u6d88\u606f\u81ea\u52a8\u52a0\u7cbe,\u9ed8\u8ba4\u4e0d\u542f\u7528 |\n| good_bound | \u5426 | 3 | \u5982\u4e0a |\n| whale_essnece_enable_groups | \u5426 | [] | \u662f\u5426\u4f7f\u7528Reaction\ud83d\udc33\u4ee3\u66ff\u8bbe\u7cbe,\u7528\u4e8e\u9632\u6b62\u7cbe\u534e\u6d88\u606f\u8fc7\u4e8e\u6cdb\u6ee5\u5bfc\u81f4\u5237\u5c4f |\n\n\u5982\u679c\u8981\u5bfb\u627e\u6570\u636e\u5e93\u548c\u7f13\u5b58\u7684\u4f4d\u7f6e,\u8bf7\u53c2\u8003nonebot\u6587\u6863\u7684[data-storing](https://nonebot.dev/docs/best-practice/data-storing)\u7ae0\u8282\n## \ud83c\udf89 \u4f7f\u7528\n### \u6307\u4ee4\u8868\n| \u6307\u4ee4 | \u6743\u9650 | \u9700\u8981@ | \u8303\u56f4 | \u8bf4\u660e |\n| :-------------------: | :----: | :---: | :---: | :------------------------------------: |\n| essence help | \u7fa4\u5458 | \u5426 | \u7fa4\u804a | \u663e\u793a\u6240\u6709\u53ef\u7528\u6307\u4ee4\u53ca\u5176\u8bf4\u660e |\n| essence random | \u7fa4\u5458 | \u5426 | \u7fa4\u804a | \u968f\u673a\u53d1\u9001\u4e00\u6761\u7cbe\u534e\u6d88\u606f |\n| essence rank sender | \u7fa4\u5458 | \u5426 | \u7fa4\u804a | \u663e\u793a\u53d1\u9001\u8005\u7cbe\u534e\u6d88\u606f\u6392\u884c\u699c |\n| essence rank operator | \u7fa4\u5458 | \u5426 | \u7fa4\u804a | \u663e\u793a\u7ba1\u7406\u5458\u8bbe\u7cbe\u6570\u91cf\u7cbe\u534e\u6d88\u606f\u6392\u884c\u699c |\n| essence fetchall | \u7ba1\u7406\u5458 | \u5426 | \u7fa4\u804a | \u83b7\u53d6\u7fa4\u5185\u6240\u6709\u7cbe\u534e\u6d88\u606f\uff0c\u5e76\u5b58\u50a8\u5230\u6570\u636e\u5e93\u4e2d |\n| essence export | \u7ba1\u7406\u5458 | \u5426 | \u7fa4\u804a | \u5bfc\u51fa\u5f53\u524d\u7fa4\u7684\u7cbe\u534e\u6d88\u606f\u6570\u636e\u5e93\u6587\u4ef6 |\n| essence saveall | \u7ba1\u7406\u5458 | \u5426 | \u7fa4\u804a | \u5c06\u7fa4\u5185\u6240\u6709\u7cbe\u534e\u6d88\u606f\u4e2d\u7684\u56fe\u7247\u4fdd\u5b58\u81f3\u672c\u5730 |\n| essence clean | \u7ba1\u7406\u5458 | \u5426 | \u7fa4\u804a | \u5220\u9664\u7fa4\u91cc\u6240\u6709\u7cbe\u534e\u6d88\u606f\uff08\u6570\u636e\u5e93\u4e2d\u4fdd\u7559\uff09 |\n\n### \u7cbe\u534e\u4e8b\u4ef6\n- \u672c\u63d2\u4ef6\u5728\u6b63\u5e38\u5de5\u4f5c\u65f6,\u4f1a\u5bf9\u7cbe\u534e\u6d88\u606f\u505a\u51fa\u54cd\u5e94,\u968f\u4e4b\u628a\u6d88\u606f\u5b58\u5165\u6216\u5220\u9664\u6570\u636e\u5e93. \n- \u5f53\u7cbe\u534e\u6d88\u606f\u7a7a\u95f4\u6ee1\u4e86\u4e4b\u540e,\u53ef\u4ee5\u4f7f\u7528essence clean\u5220\u9664\u7cbe\u534e\u6d88\u606f,\u8fd9\u6b21\u6e05\u7406\u4e0d\u4f1a\u5220\u9664\u6570\u636e\u5e93\u4e2d\u7684\u7cbe\u534e\u6d88\u606f.\n\n### Reaction\u4e8b\u4ef6\n- \u672c\u63d2\u4ef6\u5728\u6b63\u5e38\u5de5\u4f5c\u65f6,\u4f1a\u5bf9\ud83d\udc33(code:128051)\u548c\ud83d\udc4d(code:74)\u505a\u51fa\u54cd\u5e94. \n- \u5982\u679c\u542f\u7528\u4e86n\u8d5e\u52a0\u7cbe\u529f\u80fd,\u6b64\u529f\u80fd\u4f1a\u5bf9\u70b9\u8d5e\u6570\u8d85\u8fc7good_bound\u7684\u6d88\u606f\u81ea\u52a8\u52a0\u7cbe,\u4f7f\u5f97\u6bcf\u4e2a\u7fa4\u53cb\u90fd\u6709\u8bbe\u7cbe\u6743 \n- \u5982\u679c\u542f\u7528\u4e86 whale-essnece \u529f\u80fd,\u6b64\u529f\u80fd\u4f1a\u5bf9\u7ba1\u7406\u5458(\u5305\u62ecSUPERUSER,\u7fa4\u4e3b\u548c\u7fa4\u7ba1\u7406\u5458)\u7684\ud83d\udc33(code:128051)Reaction\u4e8b\u4ef6\u505a\u51fa\u53cd\u5e94,\u628a\u8be5\u6761\u6d88\u606f\u653e\u5165\u6570\u636e\u5e93,\u5e76\u56de\u590d\u4e00\u4e2a\u2728(code:10024)\u8868\u793a\u64cd\u4f5c\u5b8c\u6210\n- \u5982\u679c\u4e24\u4e2a\u529f\u80fd\u540c\u65f6\u542f\u7528,n\u8d5e\u52a0\u7cbe\u4f1a\u7528\ud83d\udc33\u4ee3\u66ff\u8bbe\u7cbe\n\n### \u6548\u679c\u56fe\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Used to organize essence messages",
"version": "0.5.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5874a230a7fd4ff12ab26a2abfc8e90d9db3b8a2f3ce46a94d7b50a7fbc83c6b",
"md5": "cbbe301305eef1339211a6a40b80d660",
"sha256": "c5f91ad878caffdfa46d4e33146551355b453649be31de505e8998df0d4a6301"
},
"downloads": -1,
"filename": "nonebot_plugin_essence_message-0.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cbbe301305eef1339211a6a40b80d660",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 13640,
"upload_time": "2025-01-19T15:45:12",
"upload_time_iso_8601": "2025-01-19T15:45:12.600719Z",
"url": "https://files.pythonhosted.org/packages/58/74/a230a7fd4ff12ab26a2abfc8e90d9db3b8a2f3ce46a94d7b50a7fbc83c6b/nonebot_plugin_essence_message-0.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cc5f7bc6e7b58b8879e9c4f0f383096d843c562ac460b1eb448c64a22cc8975a",
"md5": "c30395712ad54f06c2794da59ee7a0fb",
"sha256": "7b0e5171dfe0ec80b39d7f6b6c72fe1139a044a8fb2c5d8389305fa8f57a9f2a"
},
"downloads": -1,
"filename": "nonebot_plugin_essence_message-0.5.4.tar.gz",
"has_sig": false,
"md5_digest": "c30395712ad54f06c2794da59ee7a0fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 13072,
"upload_time": "2025-01-19T15:45:13",
"upload_time_iso_8601": "2025-01-19T15:45:13.549695Z",
"url": "https://files.pythonhosted.org/packages/cc/5f/7bc6e7b58b8879e9c4f0f383096d843c562ac460b1eb448c64a22cc8975a/nonebot_plugin_essence_message-0.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 15:45:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nonebot-plugin-essence-message"
}
