nonebot-plugin-zxui 0.3.3

No project description provided

nonebot-plugin-zxui

✨ 基于 NoneBot2 的 小真寻WebUi API实现 ✨

📖 介绍

小真寻具象化了。

内置 ZXPM插件管理（帮助看这个readme）

[!NOTE]

小真寻也很可爱呀，也会很喜欢你！

💿 安装

pip install nonebot-plugin-zxui

nb plugin install nonebot-plugin-zxui

⚙️ 配置

在.env中添加localstore配置方便数据文件修改配置：

LOCALSTORE_PLUGIN_DATA_DIR='{
  "nonebot_plugin_zxui": "data/zxui"
}
'

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_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，可以根据自身需求修改
格式如下：

[
    {
        "module": "dashboard",
        "name": "仪表盘",
        "router": "\/dashboard",
        "icon": "dashboard",
        "default": true
    },
]

更新UI

删除data/zxui/web_ui文件夹，重新运行插件即可。

🎁 后台示例图

❤ 感谢

• 可爱的小真寻 Bot zhenxun_bot: 我谢我自己，桀桀桀