Skip to content

Commit

Permalink
bump
Browse files Browse the repository at this point in the history
  • Loading branch information
lgc2333 committed Nov 19, 2022
1 parent 721f597 commit 3852bfb
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 23 deletions.
61 changes: 61 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -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
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,13 @@ _✨ 运行状态图片版 for NoneBot2 ✨_

### 效果图

<details>
<summary>点击展开</summary>

![example](https://raw.githubusercontent.com/lgc2333/nonebot-plugin-picstatus/master/readme/example.png)

</details>

## 💿 安装

<details open>
Expand Down Expand Up @@ -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]`|| `[]` | 分区列表里忽略的盘符(挂载点)<br/>使用正则表达式匹配 |
| `PS_IGNORE_BAD_PARTS` | 布尔值(`bool`|| `False` | 忽略获取容量状态失败的磁盘分区 |
| `PS_IGNORE_DISK_IOS` | 文本列表(`List[str]`|| `[]` | 磁盘 IO 统计列表中忽略的磁盘名<br/>使用正则表达式匹配 |
| `PS_IGNORE_NETS` | 文本列表(`List[str]`|| `["^lo$", "^Loopback"]` | 网速列表中忽略的网络名称<br/>使用正则表达式匹配 |
| `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 列表<br/>本地图请使用`file:///文件路径` |
| `PS_FOOTER_SIZE` | 整数(`int`|| `22` | 底部脚注文字大小 |
[.env.example](https://github.com/lgc2333/nonebot-plugin-picstatus/blob/master/.env.example)

## 🎉 使用

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion nonebot_plugin_picstatus/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.2.5"
__version__ = "0.3.0"
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <lgc2333@126.com>"]
license = "MIT"
Expand Down
Binary file modified readme/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3852bfb

Please sign in to comment.