| Name | nonebot-plugin-zxui JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-12-27 02:14:44 |
| maintainer | None |
| docs_url | None |
| author | HibiKier |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align=center>
<img width="250" height="312" src="https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt.jpg"/>
</div>
<div align="center">
<p>
<img src="https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/template/plugin.svg" alt="NoneBotPluginText">
</p>
# nonebot-plugin-zxui
_✨ 基于 [NoneBot2](https://github.com/nonebot/nonebot2) 的 小真寻WebUi API实现 ✨_
[](https://github.com/HibiKier/zhenxun_bot/blob/main/LICENSE)
</div>
## 📖 介绍
[小真寻](https://github.com/HibiKier/zhenxun_bot)具象化了。
内置 [ZXPM插件管理](https://github.com/HibiKier/nonebot-plugin-zxpm)（帮助看这个readme）
> [!NOTE]
>
> <div align="center"><b>小真寻也很可爱呀，也会很喜欢你！</b></div>
>
> <div align="center">
> <img width="235" height="235" src="https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt3.png"/>
> <img width="235" height="235" src="https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt1.png"/>
> <img width="235" height="235" src="https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt2.png"/>
> </div>
## 💿 安装
```python
pip install nonebot-plugin-zxui
```
```python
nb plugin install nonebot-plugin-zxui
```
## ⚙️ 配置
在`.env`中添加`localstore`配置方便数据文件修改配置：
```
LOCALSTORE_PLUGIN_DATA_DIR='{
"nonebot_plugin_zxui": "data/zxui"
}
'
```
### ZXUI
| 配置 | 类型 | 默认值 | 说明 |
| :---------------------- | :--: | :---------------------------: | ---------------------------------------------------------------- |
| zxui_data_path | str | data/zxui | 数据存储路径
|zxui_db_url| str| | 数据库地址 URL，默认为 sqlite,存储路径在`zxpm_data_path`|
| zxui_username | str | | 必填项，登录用户名
| zxui_password | str | | 必填项，登录密码
| zxui_enable_chat_history | bool | 开启消息存储 | 存储消息记录
| zxui_enable_call_history | bool | 开启调用记录存储 | 存储功能调用记录
### ZXPM
| 配置 | 类型 | 默认值 | 说明 |
| :---------------------- | :--: | :---------------------------: | ---------------------------------------------------------------- |
| zxpm_data_path | str | data/zxui/zxpm | 数据存储路径 |
| zxpm_notice_info_cd | int | 300 | 群/用户权限检测等各种检测提示信息 cd，为 0 时或永久 ban 时不提醒 |
| zxpm_ban_reply | str | 才不会给你发消息. | 用户被 ban 时回复消息，为空时不回复 |
| zxpm_ban_level | int | 5 | 使用 ban 功能的对应权限 |
| zxpm_switch_level | int | 1 | 使用开关功能的对应权限 |
| zxpm_admin_default_auth | int | 5 | 群组管理员默认权限 |
| zxpm_limit_superuser | bool | False | 是否限制超级用户
## 🎉 帮助
### 访问地址
默认地址为 `nb地址:nb端口` ，可以在nonebot配置文件.env一致。
例如 你的env中配置文件为
```
HOST=127.0.0.1
PORT=8080
```
那么访问地址为`http://127.0.0.1:8080`
### 菜单
菜单文件存储在`data/zxui/menu.json`，可以根据自身需求修改
格式如下：
```json
[
{
"module": "dashboard",
"name": "仪表盘",
"router": "\/dashboard",
"icon": "dashboard",
"default": true
},
]
```
### 更新UI
删除`data/zxui/web_ui`文件夹，重新运行插件即可。
## 🎁 后台示例图
<div align="center">
<!--  -->
</div>
## ❤ 感谢
- 可爱的小真寻 Bot [`zhenxun_bot`](https://github.com/HibiKier/zhenxun_bot): 我谢我自己，桀桀桀
Raw data
{
"_id": null,
"home_page": null,
"name": "nonebot-plugin-zxui",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "HibiKier",
"author_email": "775757368@qq.com",
"download_url": "https://files.pythonhosted.org/packages/cc/b0/f3053e59bef4fd803eda759022ae0a53b38968128d7f92d682ab28415399/nonebot_plugin_zxui-0.3.1.tar.gz",
"platform": null,
"description": "<div align=center>\n\n<img width=\"250\" height=\"312\" src=\"https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt.jpg\"/>\n\n</div>\n\n<div align=\"center\">\n\n<p>\n <img src=\"https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/template/plugin.svg\" alt=\"NoneBotPluginText\">\n</p>\n\n# nonebot-plugin-zxui\n\n_\u2728 \u57fa\u4e8e [NoneBot2](https://github.com/nonebot/nonebot2) \u7684 \u5c0f\u771f\u5bfbWebUi API\u5b9e\u73b0 \u2728_\n\n\n\n\n[](https://github.com/HibiKier/zhenxun_bot/blob/main/LICENSE)\n\n</div>\n\n## \ud83d\udcd6 \u4ecb\u7ecd\n\n[\u5c0f\u771f\u5bfb](https://github.com/HibiKier/zhenxun_bot)\u5177\u8c61\u5316\u4e86\u3002 \n\n\u5185\u7f6e [ZXPM\u63d2\u4ef6\u7ba1\u7406](https://github.com/HibiKier/nonebot-plugin-zxpm)\uff08\u5e2e\u52a9\u770b\u8fd9\u4e2areadme\uff09\n\n> [!NOTE]\n>\n> <div align=\"center\"><b>\u5c0f\u771f\u5bfb\u4e5f\u5f88\u53ef\u7231\u5440\uff0c\u4e5f\u4f1a\u5f88\u559c\u6b22\u4f60\uff01</b></div>\n>\n> <div align=\"center\">\n> <img width=\"235\" height=\"235\" src=\"https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt3.png\"/>\n> <img width=\"235\" height=\"235\" src=\"https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt1.png\"/>\n> <img width=\"235\" height=\"235\" src=\"https://github.com/HibiKier/nonebot-plugin-zxui/blob/main/docs_image/tt2.png\"/>\n> </div>\n\n## \ud83d\udcbf \u5b89\u88c5\n\n```python\npip install nonebot-plugin-zxui\n```\n\n```python\nnb plugin install nonebot-plugin-zxui\n```\n\n## \u2699\ufe0f \u914d\u7f6e\n\n\u5728`.env`\u4e2d\u6dfb\u52a0`localstore`\u914d\u7f6e\u65b9\u4fbf\u6570\u636e\u6587\u4ef6\u4fee\u6539\u914d\u7f6e\uff1a\n\n```\nLOCALSTORE_PLUGIN_DATA_DIR='{\n \"nonebot_plugin_zxui\": \"data/zxui\"\n}\n'\n```\n\n### ZXUI\n\n| \u914d\u7f6e | \u7c7b\u578b | \u9ed8\u8ba4\u503c | \u8bf4\u660e |\n| :---------------------- | :--: | :---------------------------: | ---------------------------------------------------------------- | \n| zxui_data_path | str | data/zxui | \u6570\u636e\u5b58\u50a8\u8def\u5f84\n|zxui_db_url| str| | \u6570\u636e\u5e93\u5730\u5740 URL\uff0c\u9ed8\u8ba4\u4e3a sqlite,\u5b58\u50a8\u8def\u5f84\u5728`zxpm_data_path`|\n| zxui_username | str | | \u5fc5\u586b\u9879\uff0c\u767b\u5f55\u7528\u6237\u540d\n| zxui_password | str | | \u5fc5\u586b\u9879\uff0c\u767b\u5f55\u5bc6\u7801\n| zxui_enable_chat_history | bool | \u5f00\u542f\u6d88\u606f\u5b58\u50a8 | \u5b58\u50a8\u6d88\u606f\u8bb0\u5f55\n| zxui_enable_call_history | bool | \u5f00\u542f\u8c03\u7528\u8bb0\u5f55\u5b58\u50a8 | \u5b58\u50a8\u529f\u80fd\u8c03\u7528\u8bb0\u5f55\n\n\n### ZXPM\n\n| \u914d\u7f6e | \u7c7b\u578b | \u9ed8\u8ba4\u503c | \u8bf4\u660e |\n| :---------------------- | :--: | :---------------------------: | ---------------------------------------------------------------- | \n| zxpm_data_path | str | data/zxui/zxpm | \u6570\u636e\u5b58\u50a8\u8def\u5f84 |\n| zxpm_notice_info_cd | int | 300 | \u7fa4/\u7528\u6237\u6743\u9650\u68c0\u6d4b\u7b49\u5404\u79cd\u68c0\u6d4b\u63d0\u793a\u4fe1\u606f cd\uff0c\u4e3a 0 \u65f6\u6216\u6c38\u4e45 ban \u65f6\u4e0d\u63d0\u9192 |\n| zxpm_ban_reply | str | \u624d\u4e0d\u4f1a\u7ed9\u4f60\u53d1\u6d88\u606f. | \u7528\u6237\u88ab ban \u65f6\u56de\u590d\u6d88\u606f\uff0c\u4e3a\u7a7a\u65f6\u4e0d\u56de\u590d |\n| zxpm_ban_level | int | 5 | \u4f7f\u7528 ban \u529f\u80fd\u7684\u5bf9\u5e94\u6743\u9650 |\n| zxpm_switch_level | int | 1 | \u4f7f\u7528\u5f00\u5173\u529f\u80fd\u7684\u5bf9\u5e94\u6743\u9650 |\n| zxpm_admin_default_auth | int | 5 | \u7fa4\u7ec4\u7ba1\u7406\u5458\u9ed8\u8ba4\u6743\u9650 |\n| zxpm_limit_superuser | bool | False | \u662f\u5426\u9650\u5236\u8d85\u7ea7\u7528\u6237 \n\n\n## \ud83c\udf89 \u5e2e\u52a9\n\n### \u8bbf\u95ee\u5730\u5740\n\n\u9ed8\u8ba4\u5730\u5740\u4e3a `nb\u5730\u5740:nb\u7aef\u53e3` \uff0c\u53ef\u4ee5\u5728nonebot\u914d\u7f6e\u6587\u4ef6.env\u4e00\u81f4\u3002 \n\u4f8b\u5982 \u4f60\u7684env\u4e2d\u914d\u7f6e\u6587\u4ef6\u4e3a\n```\nHOST=127.0.0.1\nPORT=8080\n```\n\u90a3\u4e48\u8bbf\u95ee\u5730\u5740\u4e3a`http://127.0.0.1:8080`\n\n### \u83dc\u5355\n\n\u83dc\u5355\u6587\u4ef6\u5b58\u50a8\u5728`data/zxui/menu.json`\uff0c\u53ef\u4ee5\u6839\u636e\u81ea\u8eab\u9700\u6c42\u4fee\u6539 \n\u683c\u5f0f\u5982\u4e0b\uff1a\n\n```json\n[\n {\n \"module\": \"dashboard\",\n \"name\": \"\u4eea\u8868\u76d8\",\n \"router\": \"\\/dashboard\",\n \"icon\": \"dashboard\",\n \"default\": true\n },\n]\n```\n\n### \u66f4\u65b0UI\n\n\u5220\u9664`data/zxui/web_ui`\u6587\u4ef6\u5939\uff0c\u91cd\u65b0\u8fd0\u884c\u63d2\u4ef6\u5373\u53ef\u3002\n\n## \ud83c\udf81 \u540e\u53f0\u793a\u4f8b\u56fe\n<div align=\"center\">\n\n\n\n\n\n\n<!--  -->\n\n\n\n\n</div>\n\n## \u2764 \u611f\u8c22\n\n- \u53ef\u7231\u7684\u5c0f\u771f\u5bfb Bot [`zhenxun_bot`](https://github.com/HibiKier/zhenxun_bot): \u6211\u8c22\u6211\u81ea\u5df1\uff0c\u6840\u6840\u6840\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.3.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0137496d41f34d49110efa4b65e0eec35be5cba1cc5180f21e25a5480f4c8a22",
"md5": "83f476d4c61fb3938ebdccf1086ab739",
"sha256": "d1fc528aa4f16d47c97037f43850e34d03388f591c3ce88d2979b5b1b72cc9b5"
},
"downloads": -1,
"filename": "nonebot_plugin_zxui-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83f476d4c61fb3938ebdccf1086ab739",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 114035,
"upload_time": "2024-12-27T02:14:41",
"upload_time_iso_8601": "2024-12-27T02:14:41.767535Z",
"url": "https://files.pythonhosted.org/packages/01/37/496d41f34d49110efa4b65e0eec35be5cba1cc5180f21e25a5480f4c8a22/nonebot_plugin_zxui-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ccb0f3053e59bef4fd803eda759022ae0a53b38968128d7f92d682ab28415399",
"md5": "2f516544d112923ba011b3b2f8eecd0d",
"sha256": "e875bdacbd7def721a0d6c0422834901bbbeee48ea05538bb3102842ff5ffac4"
},
"downloads": -1,
"filename": "nonebot_plugin_zxui-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "2f516544d112923ba011b3b2f8eecd0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 76192,
"upload_time": "2024-12-27T02:14:44",
"upload_time_iso_8601": "2024-12-27T02:14:44.469930Z",
"url": "https://files.pythonhosted.org/packages/cc/b0/f3053e59bef4fd803eda759022ae0a53b38968128d7f92d682ab28415399/nonebot_plugin_zxui-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-27 02:14:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nonebot-plugin-zxui"
}
