diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..3448552 --- /dev/null +++ b/.env.example @@ -0,0 +1,61 @@ +# 用来测试访问网址时的代理(默认为空) +PROXY="http://127.0.0.1:7890" + +# 是否只能由SuperUsers触发指令(可空) +PS_ONLY_SU=False + +# 触发指令是否需要@Bot(可空) +PS_NEED_AT=False + +# 使用.env.*中配置的NICKNAME作为图片上的 Bot 昵称(可空) +PS_USE_ENV_NICK=False + +# 分区列表里忽略的盘符(挂载点)(可空) +# 使用正则表达式匹配 +PS_IGNORE_PARTS=[] + +# 忽略获取容量状态失败的磁盘分区(可空) +PS_IGNORE_BAD_PARTS=False + +# 磁盘 IO 统计列表中忽略的磁盘名(可空) +# 使用正则表达式匹配 +PS_IGNORE_DISK_IOS=[] + +# 网速列表中忽略的网络名称(可空) +# 使用正则表达式匹配 +PS_IGNORE_NETS=["^lo$", "^Loopback"] + +# 是否忽略 IO 都为 0B/s 的磁盘(可空) +PS_IGNORE_NO_IO_DISK=False + +# 是否忽略上下行都为 0B/s 的网卡(可空) +PS_IGNORE_0B_NET=False + +# 背景图遮罩颜色(可空) +PS_MASK_COLOR=[255, 255, 255, 125] + +# 各状态矩形背景底色(可空) +PS_BG_COLOR=[255, 255, 255, 150] + +# 背景图高斯模糊半径(可空) +PS_BLUR_RADIUS=4 + +# 自定义字体路径(可空) +# 默认为插件内自带思源黑体,这里填的是 Windows 自带的微软雅黑粗体 +PS_FONT="C:/Windows/Fonts/msjhbd.ttc" + +# 自定义背景图 URL 列表(可空) +# 本地图请使用 file:///文件路径 +PS_CUSTOM_BG=[] + +# 底部脚注文字大小(可空) +PS_FOOTER_SIZE=22 + +# 网卡列表下的测试访问的网址列表(可空) +# name: 显示名称 +# url: 要访问的网址 +# proxy: 是否使用 .env 配置文件中设置的代理来访问 +PS_TEST_SITES=[{"name": "百度", "url": "https://baidu.com"}, {"name": "Google", "url": "https://google.com", "use_proxy": true}] + +# 网址测试访问时的超时时间(秒)(可空) +PS_TEST_TIMEOUT=5 \ No newline at end of file diff --git a/README.md b/README.md index aead909..cc911ac 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,13 @@ _✨ 运行状态图片版 for NoneBot2 ✨_ ### 效果图 +
+ 点击展开 + ![example](https://raw.githubusercontent.com/lgc2333/nonebot-plugin-picstatus/master/readme/example.png) +
+ ## 💿 安装
@@ -99,25 +104,7 @@ _✨ 运行状态图片版 for NoneBot2 ✨_ ## ⚙️ 配置 -在 nonebot2 项目的`.env`文件中添加下表中的必填配置 - -| 配置项 | 类型 | 必填 | 默认值 | 说明 | -| :--------------------: | :---------------------------------------: | :--: | :---------------------: | :------------------------------------------------------: | -| `PS_ONLY_SU` | 布尔值(`bool`) | 否 | `False` | 是否只能由`SuperUsers`触发指令 | -| `PS_NEED_AT` | 布尔值(`bool`) | 否 | `False` | 触发指令是否需要@Bot | -| `PS_USE_ENV_NICK` | 布尔值(`bool`) | 否 | `False` | 使用`.env.*`中配置的`NICKNAME`作为图片上的 Bot 昵称 | -| `PS_IGNORE_PARTS` | 文本列表(`List[str]`) | 否 | `[]` | 分区列表里忽略的盘符(挂载点)
使用正则表达式匹配 | -| `PS_IGNORE_BAD_PARTS` | 布尔值(`bool`) | 否 | `False` | 忽略获取容量状态失败的磁盘分区 | -| `PS_IGNORE_DISK_IOS` | 文本列表(`List[str]`) | 否 | `[]` | 磁盘 IO 统计列表中忽略的磁盘名
使用正则表达式匹配 | -| `PS_IGNORE_NETS` | 文本列表(`List[str]`) | 否 | `["^lo$", "^Loopback"]` | 网速列表中忽略的网络名称
使用正则表达式匹配 | -| `PS_IGNORE_NO_IO_DISK` | 布尔值(`bool`) | 否 | `False` | 是否忽略 IO 都为 0B/s 的磁盘 | -| `PS_IGNORE_0B_NET` | 布尔值(`bool`) | 否 | `False` | 是否忽略上下行都为 0B/s 的网卡 | -| `PS_MASK_COLOR` | 4 整数元组(`Tuple[int, int, int, int]`) | 否 | `[255, 255, 255, 125]` | 背景图遮罩颜色 | -| `PS_BG_COLOR` | 4 整数元组(`Tuple[int, int, int, int]`) | 否 | `[255, 255, 255, 150]` | 各状态矩形背景底色 | -| `PS_BLUR_RADIUS` | 整数(`int`) | 否 | `4` | 背景图高斯模糊半径 | -| `PS_FONT` | 文本(`str`) | 否 | 无 | 自定义字体路径 | -| `PS_CUSTOM_BG` | 文本列表(`List[str]`) | 否 | `[]` | 自定义背景图 URL 列表
本地图请使用`file:///文件路径` | -| `PS_FOOTER_SIZE` | 整数(`int`) | 否 | `22` | 底部脚注文字大小 | +见[.env.example](https://github.com/lgc2333/nonebot-plugin-picstatus/blob/master/.env.example) ## 🎉 使用 @@ -152,12 +139,17 @@ Telegram:[@lgc2333](https://t.me/lgc2333) ## 📝 更新日志 -### 0.2.5 +### 0.3.0 配置项更新详见 [配置](#️-配置) -- 更新配置项 `PS_FOOTER_SIZE` +- 更新配置项 `PS_TEST_SITES` `PS_TEST_TIMEOUT` +- 修复`PS_NEED_AT`配置无效的 bug +- 现在只有命令完全匹配时才会触发 + +### 0.2.5 +- 更新配置项 `PS_FOOTER_SIZE` ### 0.2.4 diff --git a/nonebot_plugin_picstatus/version.py b/nonebot_plugin_picstatus/version.py index fe404ae..493f741 100644 --- a/nonebot_plugin_picstatus/version.py +++ b/nonebot_plugin_picstatus/version.py @@ -1 +1 @@ -__version__ = "0.2.5" +__version__ = "0.3.0" diff --git a/pyproject.toml b/pyproject.toml index e0a80f7..6d17a01 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "nonebot-plugin-picstatus" -version = "0.2.5" +version = "0.3.0" description = "A NoneBot2 plugin generates a picture which shows the status of current device" authors = ["student_2333 "] license = "MIT" diff --git a/readme/example.png b/readme/example.png index 3e541b5..47d8920 100644 Binary files a/readme/example.png and b/readme/example.png differ