koishi-plugin-server-status-image
v1.1.3
Published
Koishi 服务器状态图插件
Maintainers
Readme
koishi-plugin-server-status-image
项目介绍 (Project Introduction)
中文
这是一个为 Koishi 机器人框架开发的 服务器状态图片生成插件,可将系统运行信息实时渲染为毛玻璃风格的状态卡片,所有显示模块均可独立开关。核心特性:
- 🖥️ 真实系统数据:使用 Node.js 原生 API 与系统命令采集 CPU、内存、磁盘、网络信息,支持 Linux / macOS / Windows
- ⚙️ 模块化显示:CPU、RAM、磁盘、运行时间、网络实时速度、网络接口等全部可在配置页面勾选
- 📊 智能隐藏:若硬件数据获取失败,对应行自动消失
- 🔧 完整汉化配置:每一项设置均附中文说明,无需阅读源码即可调整
English
A server status image generator for the Koishi bot, rendering real-time system info into frosted-glass style cards with per-module visibility toggles. Key features:
- 🖥️ Real system data: CPU, RAM, disk, network via Node.js APIs and system commands, supporting Linux / macOS / Windows
- ⚙️ Modular display: each component can be toggled in the config panel
- 📊 Auto-hide: if hardware data is unavailable, the corresponding line disappears automatically
- 🔧 Fully localized config: every setting has a Chinese description
项目仓库 (Repository)
- GitHub:
https://github.com/Minecraft-1314/koishi-plugin-server-status-image - Issues:
https://github.com/Minecraft-1314/koishi-plugin-server-status-image/issues
核心指令 (Core Commands)
| 指令 | 说明 | 示例 |
|------|------|------|
| status | 生成并发送当前服务器的状态图片 | status |
配置项说明 (Configuration)
| 配置项 | 类型 | 默认值 | 说明 |
|--------|------|--------|------|
| enableCPU | boolean | true | 显示 CPU 使用率环形进度条及型号、核心/线程数、最高/当前频率 |
| enableRAM | boolean | true | 显示内存使用率环形进度条 |
| enableDisk | boolean | true | 显示磁盘使用率环形进度条(跨平台支持,无数据时自动隐藏) |
| enableUptime | boolean | true | 显示“已运行 X 天 X 小时 X 分钟” |
| enableNetworkUpSpeed | boolean | true | 显示网络上行速度(5秒平均,B/s) |
| enableNetworkDownSpeed | boolean | true | 显示网络下行速度(5秒平均,B/s) |
| enableNetworkStatus | boolean | false | 显示活跃网络接口名称与 IP 地址 |
| screenshotQuality | number (1-100) | 80 | Puppeteer 截图质量,数字越高文件越大 |
依赖 (Dependencies)
- koishi-plugin-puppeteer(必须):用于渲染 HTML 页面生成图片。
项目贡献者 (Contributors)
| 贡献者 | 贡献内容 | |--------|----------| | Minecraft-1314 | 插件完整开发 | | koishi-shangxue-apps | UI 背景图灵感与卡片排版风格参考 |
(欢迎通过 Issues 或 PR 成为贡献者)
许可协议 (License)
本项目采用 MIT 许可证,详情参见 LICENSE 文件。
This project is licensed under the MIT License, see the LICENSE file for details.
支持我们 (Support Us)
如果这个项目对您有帮助,欢迎点亮右上角的 Star ⭐ 支持我们,这将是对所有贡献者最大的鼓励!
If this project is helpful to you, please feel free to star it in the upper right corner ⭐ to support us, which will be the greatest encouragement to all contributors!
