nonebot-plugin-status-zmd 0.1.0

✨ NoneBot-Plugin-Status-Zmd ✨

以《明日方舟：终末地》协议核心面板风格展示服务器运行状态的 NoneBot2 插件

📖 介绍

发一条 status，得到一张协议核心面板风格的设备状态图：圆形电量环 + 设备性能走势 + 应用概况 + 终端链路 + 设备信息表。

📷 效果图

💿 安装

nb plugin install nonebot-plugin-status-zmd

pip install nonebot-plugin-status-zmd

[tool.nonebot]
plugins = ["nonebot_plugin_status_zmd"]

⚠️ 渲染后端

插件通过 nonebot-plugin-htmlrender 渲染页面，0.6 / 0.7 / 0.8+ 都支持， 但从 0.8 起它不再内置浏览器后端，需要额外两步：

# htmlrender >= 0.8：装 Playwright 后端（0.6 / 0.7 自带，跳过这步）
pip install "nonebot-plugin-htmlrender[playwright]>=0.8"
# 或装本插件提供的配套 extra（等价）
pip install "/path/to/nonebot-plugin-status-zmd[htmlrender8]"

# 任一版本都需要浏览器内核
playwright install chromium
# Debian/Ubuntu、容器、CI 建议带上系统依赖
playwright install --with-deps chromium

# htmlrender >= 0.8 还需要在 .env 里选 Provider（0.6 / 0.7 不用）
RENDER={"provider":"playwright","startup":"warmup"}

另外 htmlrender 0.7 起把浏览器目录搬到了 localstore 数据目录（首次启动的日志里会打印具体路径）。如果出图报 Executable doesn't exist，把PLAYWRIGHT_BROWSERS_PATH 指到那个目录再装一次即可，例如：

set "PLAYWRIGHT_BROWSERS_PATH=%LOCALAPPDATA%\nonebot2\nonebot_plugin_htmlrender"
playwright install chromium

后端不可用时插件不会启动失败，而是打印一条带修复步骤的告警，并在指令触发时把同样的提示发给使用者。

🎉 使用

status
系统状态

指令名可用 STZMD_COMMAND 修改。默认仅 SUPERUSER可用。

NoneBot 默认只把 / 开头的消息当命令，想直接发 status 触发，需要把空字符串加进 COMMAND_START：

COMMAND_START=["", "/"]

⚙️ 配置

在 .env 或 .env.prod 中添加；全部为可选项，可以开箱即用：

# --- 触发与权限 ---
STZMD_COMMAND=["status", "系统状态"]        # 触发指令，第一个为主指令，其余为别名
STZMD_ONLY_SUPERUSER=true                  # 是否仅 SUPERUSER 可用（状态图含主机名/IP/进程/磁盘，不建议公开）
STZMD_NEED_AT=false                        # 是否需要 @ 机器人才能触发
STZMD_REPLY_TARGET=true                    # 是否回复触发者那条消息

# --- 版式 ---
STZMD_LAYOUT=full                            # full=综合长图 / gauge=只出电量环 / perf=只出设备性能
STZMD_BLOCKS=["header", "gauge", "apps", "bots", "perf", "specs", "footer"]  # 板块开关，可选 header / gauge / apps / bots / perf / specs / footer
STZMD_DEVICES=["cpu", "mem", "disk", "net"]  # 设备性能区逐设备开关，可选 cpu / mem / disk / net，列表顺序即图上顺序
# STZMD_HOST_NAME=ENDFIELD-01                # 顶栏显示的主机名，默认用系统主机名

# --- 电量环 ---
STZMD_GAUGE_VALUE_MAX=325799               # 环中间大数字的分母（终末地游戏口径）
STZMD_GAUGE_CPU_WEIGHT=0.4                 # 综合占用里 CPU 的权重
STZMD_GAUGE_MEM_WEIGHT=0.6                 # 综合占用里内存的权重（综合占用 = CPU×权重 + 内存×权重）

# --- 渲染 ---
STZMD_PIC_FORMAT=jpeg                      # 出图格式：jpeg / png
STZMD_PIC_QUALITY=90                       # 出图质量（jpeg 有效）
STZMD_DEVICE_SCALE_FACTOR=2                # 出图缩放倍率，2 表示按 2 倍分辨率渲染（更清晰、体积更大）
STZMD_RENDER_TIMEOUT=30                    # 单张图渲染超时（秒）
# STZMD_FONT_FAMILY="Noto Sans CJK SC"     # CSS 字体栈覆盖，默认用系统字体
# STZMD_FONT_PATH=/xxx/xxx.ttc             # 指定字体文件并内联进图片（≤ 8MB），字形一致性最稳
# STZMD_EXTRA_CSS=/path/to/custom.css      # 追加自定义 CSS

# --- 采样 ---
STZMD_COLLECT_INTERVAL=5                   # 后台常驻采样间隔（秒）
STZMD_HISTORY_SIZE=180                     # 走势图保留的采样点数（窗口 = 间隔 × 点数，默认约 15 分钟）
STZMD_COLLECT_TIMEOUT=15                   # 单次采集的等待上限（秒），超时先继续、不拖住启动
STZMD_PROC_LEN=8                           # 应用概况里列出的进程数
STZMD_PROC_SORT_BY=cpu                     # 进程排序依据：cpu / mem
STZMD_IGNORE_PARTS=[]                      # 忽略的分区（正则），如 ["^/boot"]
STZMD_IGNORE_NETS=["^lo(op)?\\d*$|^(Loopback|本地连接)"]   # 忽略的网卡（正则）
STZMD_IGNORE_PROCS=["^System Idle Process$"]              # 忽略的进程（正则）
STZMD_PROC_CPU_MAX_100P=false              # 进程 CPU 是否按单核算（false = 折算成整机占比，与任务管理器口径一致）

# --- Bot 状态 ---
STZMD_COUNT_MESSAGE_SENT=true              # 是否统计发送消息数（按各适配器的发消息 API 名计数）
STZMD_SHOW_BOT_AVATAR=true                 # 是否拉取 Bot 头像
STZMD_DISCONNECT_RESET_COUNTER=true        # Bot 断开时是否清零收发计数
STZMD_REQ_TIMEOUT=10                       # 拉取头像 / Bot 信息的超时（秒）

# --- 全局 ---
# PROXY=http://127.0.0.1:7890              # 拉取 Bot 头像走的代理（NoneBot 全局配置，非本插件专属）

版式与板块的关系

STZMD_LAYOUT 决定整体容器结构，STZMD_BLOCKS 决定渲染哪些板块，只有两者都允许的 板块才会出现：

各板块对应图上哪一块：

设备性能区出哪几行

STZMD_DEVICES 控制设备性能区里出哪几行（可只留 ["cpu", "mem"] 做轻量监控，或 ["net"] 只看网络）：

不含 GPU：显卡指标跨平台差异太大，本插件不采集。

启动期采集超时

宿主机的挂载点失联时（比如掉线的网络盘），采集可能阻塞很久。启动期（静态信息 + 基准 + 首采）共用一份 STZMD_COLLECT_TIMEOUT 总预算：超时不会中断采集，只是先放行——机器人照常启动，数据由下个采样周期补上；若出图时仍没有数据，会直接回一句「状态数据还没准备好」而不是卡住。

💡 鸣谢

QinAnze/zmd-manager

• UI视觉规范参考：电量环、配色、点阵底纹、走势柱、切角图标块

lgc-NB2Dev/nonebot-plugin-picstatus

• 采集器组织方式、渲染管线与「指令带图」的整体思路

kexue-z/nonebot-plugin-htmlrender

• HTML 渲染后端

nonebot/plugin-alconna

• 多平台指令解析与发送

📄 许可

MIT