4 |
5 | # NEKO-STATUS-PLUGIN 🍙
6 |
7 | - 一个适用于 [Yunzai 系列机器人框架](https://github.com/yhArcadia/Yunzai-Bot-plugins-index) 的系统状态查询插件喵~
8 |
9 | - 有着更加精简，美观和超超超超超可爱的 UI 和的风格，并且你可以自定义头图喵~
10 |
11 | - **使用中遇到问题请加 QQ 群咨询：[707331865](https://qm.qq.com/q/TXTIS9KhO2)**
12 |
13 | > [!TIP]
14 | > 在看到 [Koishi](https://koishi.js.org/) 和 [Nonebot](https://nonebot.dev/) 类似风格的插件后，身为猫猫控我与 [CikeyQi](https://github.com/CikeyQi) 立马喜欢上了如此精美的设计，于是决定将这个插件移植到 Yunzai 上，并重新修改创作了模板加上了自定义头图，人家有的咱们也可以有喵~
15 |
16 | ## 安装插件
17 |
18 | #### 1. 克隆仓库
19 |
20 | ```
21 | git clone https://github.com/erzaozi/neko-status-plugin.git ./plugins/neko-status-plugin
22 | ```
23 |
24 | > [!NOTE]
25 | > 如果你的网络环境较差，无法连接到 Github，可以使用 [GitHub Proxy](https://mirror.ghproxy.com/) 提供的文件代理加速下载服务
26 | >
27 | > ```
28 | > git clone https://mirror.ghproxy.com/https://github.com/erzaozi/neko-status-plugin.git ./plugins/neko-status-plugin
29 | > ```
30 |
31 | #### 2. 安装依赖
32 |
33 | ```
34 | pnpm install --filter=neko-status-plugin
35 | ```
36 |
37 | ## 插件配置
38 |
39 | > [!WARNING]
40 | > 非常不建议手动修改配置文件，本插件已兼容 [Guoba-plugin](https://github.com/guoba-yunzai/guoba-plugin) ，请使用锅巴插件对配置项进行修改
41 |
42 | ## 功能列表
43 |
44 | 安装好后，请使用 `#状态` 或 `/status` 命令触发状态面板
45 |
46 | - [x] CPU 占用
47 | - [x] 内存占用
48 | - [x] 网络上下行速率
49 | - [x] 磁盘占用
50 | - [x] 系统信息
51 | - [x] GPU 型号
52 | - [x] 插件数量
53 | - [x] 适配器信息
54 | - [x] 收发消息数量
55 | - [x] 好友 & 群数量
56 | - [x] 运行时间
57 | - [x] [自定义展示](https://github.com/erzaozi/neko-status-plugin?tab=readme-ov-file#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%95%E7%A4%BA)
58 |
59 | ## 效果图
60 |
61 |
73 |
75 | 76 | 要查看服务器的 IP 地址，可以使用 `hostname` 命令，该命令将返回所有网络接口的 IP 地址，以空格分隔： 77 | 78 | ``` 79 | 144.93.144.203 5DBD:1EE5:0D88:B35F:FB27:7218:1047:8408 F5B5:7345:111D:4E03:759F:FAAD:D2C0:B95F 80 | ``` 81 | 82 | 我们希望仅提取第一个 IP 地址。可以使用以下命令： 83 | 84 | **命令：** 85 | ```bash 86 | hostname -I | awk '{print $1}' 87 | ``` 88 | 89 | **命令解析：** 90 | 1. `hostname -I`：获取所有网络接口的 IP 地址，以空格分隔 91 | 2. `awk '{print $1}'`：提取输出中的第一个 IP 地址 92 | 93 |
94 |
95 | 展示服务器公网IP
74 |75 | 76 | 要查看服务器的 IP 地址，可以使用 `hostname` 命令，该命令将返回所有网络接口的 IP 地址，以空格分隔： 77 | 78 | ``` 79 | 144.93.144.203 5DBD:1EE5:0D88:B35F:FB27:7218:1047:8408 F5B5:7345:111D:4E03:759F:FAAD:D2C0:B95F 80 | ``` 81 | 82 | 我们希望仅提取第一个 IP 地址。可以使用以下命令： 83 | 84 | **命令：** 85 | ```bash 86 | hostname -I | awk '{print $1}' 87 | ``` 88 | 89 | **命令解析：** 90 | 1. `hostname -I`：获取所有网络接口的 IP 地址，以空格分隔 91 | 2. `awk '{print $1}'`：提取输出中的第一个 IP 地址 92 | 93 |
96 |
98 | 99 | 使用 `uptime` 命令可以查看服务器的负载情况。该命令返回的内容类似于以下文本： 100 | 101 | ``` 102 | 16:31:32 up 5 days, 22:52, 4 users, load average: 0.02, 0.01, 0.00 103 | ``` 104 | 105 | 这样展示的内容较多，我们希望仅提取负载值，并将其转换为百分比形式。因此，可以使用以下命令： 106 | 107 | **命令：** 108 | ```bash 109 | uptime | awk -F'[:,]' '{printf "%.2f%% %.2f%% %.2f%%\n", ($8 * 100) / nproc, ($9 * 100) / nproc, ($10 * 100) / nproc}' nproc=$(nproc) 110 | ``` 111 | 112 | **命令解析：** 113 | 1. `uptime`：获取系统当前的负载信息 114 | 2. `awk -F'[:,]'`：使用 `:` 和 `,` 作为输入分隔符进行解析 115 | 3. `printf`：格式化输出三个负载值（$8, $9, $10），相对于 CPU 核心数（通过 `nproc` 获取），并以百分比形式显示 116 | 4. `nproc=$(nproc)`：获取当前可用的 CPU 核心数 117 | 118 |
119 |
120 |
121 | 3. 填写好 `名称` 和 `命令` 后，点击 `确定` 按钮，即可完成自定义内容的配置
122 |
123 | 4. 如果想展示的内容无法通过一条命令获取，也可以自行编辑一个脚本文件，比如 `.bat` 或者 `.sh`，并使用命令调用它
124 |
125 | > [!NOTE]
126 | > 此功能依赖于 `exec` 命令，几乎可以实现所有信息的展示，包括调用已安装的软件或请求网络 API 接口。不过，由于它直接执行终端命令，请务必避免使用高风险命令，例如 `rm -rf /` 等。
127 | >
128 | > 在调用命令之前，建议在 Shell 或 Cmd 环境中进行测试，以确保输出符合预期。许多命令的输出可能较为详细，因此请尽量对输出进行处理，以确保美观。例如，上述例子中使用了 `awk` 进行格式化。
129 |
130 | ## 常见问题
131 |
132 | 1. 显示`The Emperor's New XXX` 是什么意思？
133 | - 获取不到你的设备信息
134 |
135 | ## 支持与贡献 😽
136 |
137 | 如果你喜欢这个项目，请不妨点个 Star🌟，这是对开发者最大的动力， 当然，你可以对我 [爱发电](https://afdian.net/a/sumoqi) 赞助，呜咪~❤️
138 |
139 | 有意见或者建议也欢迎提交 [Issues](https://github.com/erzaozi/neko-status-plugin/issues) 和 [Pull requests](https://github.com/erzaozi/neko-status-plugin/pulls)。
140 |
141 | ## 相关项目 😻
142 |
143 | - [Kabuda-czh/koishi-plugin-status-pro](https://github.com/Kabuda-czh/koishi-plugin-status-pro)
144 | - [KomoriDev/nonebot-plugin-kawaii-status](https://github.com/KomoriDev/nonebot-plugin-kawaii-status)：NoneBot2 服务器状态查看插件 / View server status for NoneBot2
145 |
146 | ## 许可证
147 |
148 | 本项目使用 [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/) 作为开源许可证。
149 |
--------------------------------------------------------------------------------
/apps/Main.js:
--------------------------------------------------------------------------------
1 | import plugin from '../../../lib/plugins/plugin.js'
2 | import { pluginResources } from '../model/path.js'
3 | import getData from '../model/getData.js'
4 | import puppeteer from '../../../lib/puppeteer/puppeteer.js'
5 | import Config from '../components/Config.js'
6 |
7 | export class neko_status extends plugin {
8 | constructor() {
9 | super({
10 | /** 功能名称 */
11 | name: 'Neko状态',
12 | /** 功能描述 */
13 | dsc: '获取Neko状态',
14 | event: 'message',
15 | /** 优先级，数字越小等级越高 */
16 | priority: -1009,
17 | rule: [
18 | {
19 | /** 命令正则匹配 */
20 | reg: '^[/#]?(状态|status)$',
21 | /** 执行方法 */
22 | fnc: 'status'
23 | }
24 | ]
25 | })
26 | }
27 |
28 | async status(e) {
29 | const config = await Config.getConfig();
30 |
31 | const data = await getData.getData(e)
32 |
33 | const base64 = await puppeteer.screenshot('neko-status-plugin', {
34 | saveId: 'status',
35 | imgType: 'png',
36 | tplFile: `${pluginResources}/template/${config.use_template}/template.html`,
37 | pluginResources,
38 | data: data
39 | })
40 | await e.reply(base64)
41 | return true
42 | }
43 | }
--------------------------------------------------------------------------------
/apps/Setting.js:
--------------------------------------------------------------------------------
1 | import plugin from '../../../lib/plugins/plugin.js'
2 | import Config from '../components/Config.js'
3 | import Init from '../model/init.js'
4 |
5 | export class neko_header extends plugin {
6 | constructor() {
7 | super({
8 | /** 功能名称 */
9 | name: 'neko头图',
10 | /** 功能描述 */
11 | dsc: '设置状态头图',
12 | event: 'message',
13 | /** 优先级，数字越小等级越高 */
14 | priority: 1009,
15 | rule: [
16 | {
17 | /** 命令正则匹配 */
18 | reg: '^[/#]?更换状态头图.*$',
19 | /** 执行方法 */
20 | fnc: 'header',
21 | /** 主人权限 */
22 | permission: 'master'
23 | },
24 | {
25 | /** 命令正则匹配 */
26 | reg: '^[/#]?更换状态模板.*$',
27 | /** 执行方法 */
28 | fnc: 'template',
29 | /** 主人权限 */
30 | permission: 'master'
31 | },
32 | {
33 | /** 命令正则匹配 */
34 | reg: '^[/#]?状态模板列表.*$',
35 | /** 执行方法 */
36 | fnc: 'templateList',
37 | /** 主人权限 */
38 | permission: 'master'
39 | }
40 | ]
41 | })
42 | }
43 |
44 | async header(e) {
45 | const config = await Config.getConfig();
46 | let url = e.msg.replace(/^[/#]?更换状态头图/, '').trim();
47 | let imageUrl;
48 |
49 | if (e.img) {
50 | imageUrl = e.img[0];
51 | }
52 |
53 | if (e.source) {
54 | const history = e.isGroup
55 | ? await e.group.getChatHistory(e.source.seq, 1)
56 | : await e.friend.getChatHistory(e.source.time, 1);
57 | const replyMessage = history.pop()?.message;
58 |
59 | if (replyMessage) {
60 | const imageVal = replyMessage.find(val => val.type === "image");
61 | if (imageVal) {
62 | imageUrl = imageVal.url;
63 | }
64 | }
65 | }
66 |
67 | if (url && !await isImageUrl(url)) {
68 | e.reply('无法获取到图片，请检查链接是否正确');
69 | return false;
70 | }
71 |
72 | url = url || imageUrl;
73 |
74 | if (url) {
75 | config.headimg_url = url;
76 | await Config.setConfig(config);
77 | e.reply('设置成功');
78 | } else {
79 | e.reply('无法获取到图片');
80 | return false;
81 | }
82 | }
83 |
84 | async template(e) {
85 | const config = await Config.getConfig();
86 | let template = e.msg.replace(/^[/#]?更换状态模板/, '').trim();
87 |
88 | let templateOptions = await Config.getTemplate();
89 | let templateList = templateOptions.map(val => val.value);
90 |
91 | if (templateList.indexOf(template) === -1) {
92 | e.reply('模板不存在，请发送“#状态模板列表”查看所有模板');
93 | return false;
94 | }
95 |
96 | config.use_template = template;
97 | await Config.setConfig(config);
98 | e.reply('设置成功，当前状态模板：' + template);
99 | }
100 |
101 | async templateList(e) {
102 | let templateOptions = await Config.getTemplate();
103 | let templateList = templateOptions.map(val => val.value);
104 | e.reply('状态模板列表：\n' + templateList.join('\n'));
105 | return true;
106 | }
107 | }
108 |
109 | async function isImageUrl(imageUrl) {
110 | try {
111 | const response = await fetch(imageUrl, { method: 'HEAD' });
112 | const contentType = response.headers.get('content-type');
113 | return contentType && contentType.startsWith('image/');
114 | } catch (error) {
115 | logger.error('检查失败:', error);
116 | return false;
117 | }
118 | }
119 |
--------------------------------------------------------------------------------
/apps/Update.js:
--------------------------------------------------------------------------------
1 | import plugin from '../../../lib/plugins/plugin.js'
2 | import { createRequire } from 'module'
3 | import lodash from 'lodash'
4 | import { Restart } from '../../other/restart.js'
5 |
6 | const require = createRequire(import.meta.url)
7 | const { exec, execSync } = require('child_process')
8 |
9 | // 是否在更新中
10 | let uping = false
11 |
12 | /**
13 | * 处理插件更新
14 | */
15 | export class Update extends plugin {
16 | constructor () {
17 | super({
18 | name: '猫猫状态-更新插件',
19 | event: 'message',
20 | priority: 1009,
21 | rule: [
22 | {
23 | reg: '^#猫猫状态((插件)?(强制)?更新| update)$',
24 | fnc: 'update'
25 | }
26 | ]
27 | })
28 | }
29 |
30 | /**
31 | * rule - 更新插件
32 | * @returns
33 | */
34 | async update () {
35 | if (!this.e.isMaster) return false
36 |
37 | /** 检查是否正在更新中 */
38 | if (uping) {
39 | await this.reply('已有命令更新中..请勿重复操作')
40 | return
41 | }
42 |
43 | /** 检查git安装 */
44 | if (!(await this.checkGit())) return
45 |
46 | const isForce = this.e.msg.includes('强制')
47 |
48 | /** 执行更新 */
49 | await this.runUpdate(isForce)
50 |
51 | /** 是否需要重启 */
52 | if (this.isUp) {
53 | await this.reply('更新完毕，正在重启云崽以应用更新')
54 | setTimeout(() => this.restart(), 2000)
55 | }
56 | }
57 |
58 | restart () {
59 | new Restart(this.e).restart()
60 | }
61 |
62 | /**
63 | * 更新
64 | * @param {boolean} isForce 是否为强制更新
65 | * @returns
66 | */
67 | async runUpdate (isForce) {
68 | let command = 'git -C ./plugins/neko-status-plugin/ pull --no-rebase'
69 | if (isForce) {
70 | command = `git -C ./plugins/neko-status-plugin/ checkout . && ${command}`
71 | this.e.reply('正在执行强制更新操作，请稍等')
72 | } else {
73 | this.e.reply('正在执行更新操作，请稍等')
74 | }
75 | /** 获取上次提交的commitId，用于获取日志时判断新增的更新日志 */
76 | this.oldCommitId = await this.getcommitId('neko-status-plugin')
77 | uping = true
78 | const ret = await this.execSync(command)
79 | uping = false
80 |
81 | if (ret.error) {
82 | logger.mark(`${this.e.logFnc} 更新失败：neko-status-plugin`)
83 | this.gitErr(ret.error, ret.stdout)
84 | return false
85 | }
86 |
87 | /** 获取插件提交的最新时间 */
88 | const time = await this.getTime('neko-status-plugin')
89 |
90 | if (/(Already up[ -]to[ -]date|已经是最新的)/.test(ret.stdout)) {
91 | await this.reply(`neko-status-plugin已经是最新版本\n最后更新时间：${time}`)
92 | } else {
93 | await this.reply(`neko-status-plugin\n最后更新时间：${time}`)
94 | this.isUp = true
95 | /** 获取neko-status-plugin的更新日志 */
96 | const log = await this.getLog('neko-status-plugin')
97 | await this.reply(log)
98 | }
99 |
100 | logger.mark(`${this.e.logFnc} 最后更新时间：${time}`)
101 |
102 | return true
103 | }
104 |
105 | /**
106 | * 获取neko-status-plugin的更新日志
107 | * @param {string} plugin 插件名称
108 | * @returns
109 | */
110 | async getLog (plugin = '') {
111 | const cm = `cd ./plugins/${plugin}/ && git log -20 --oneline --pretty=format:"%h||[%cd] %s" --date=format:"%m-%d %H:%M"`
112 |
113 | let logAll
114 | try {
115 | logAll = await execSync(cm, { encoding: 'utf-8' })
116 | } catch (error) {
117 | logger.error(error.toString())
118 | this.reply(error.toString())
119 | }
120 |
121 | if (!logAll) return false
122 |
123 | logAll = logAll.split('\n')
124 |
125 | let log = []
126 | for (let str of logAll) {
127 | str = str.split('||')
128 | if (str[0] == this.oldCommitId) break
129 | if (str[1].includes('Merge branch')) continue
130 | log.push(str[1])
131 | }
132 | const line = log.length
133 | log = log.join('\n\n')
134 |
135 | if (log.length <= 0) return ''
136 |
137 | let end = ''
138 | end =
139 | '更多详细信息，请前往github查看\nhttps://github.com/erzaozi/neko-status-plugin/commits/main'
140 |
141 | log = await this.makeForwardMsg(`neko-status-plugin更新日志，共${line}条`, log, end)
142 |
143 | return log
144 | }
145 |
146 | /**
147 | * 获取上次提交的commitId
148 | * @param {string} plugin 插件名称
149 | * @returns
150 | */
151 | async getcommitId (plugin = '') {
152 | const cm = `git -C ./plugins/${plugin}/ rev-parse --short HEAD`
153 |
154 | let commitId = await execSync(cm, { encoding: 'utf-8' })
155 | commitId = lodash.trim(commitId)
156 |
157 | return commitId
158 | }
159 |
160 | /**
161 | * 获取本次更新插件的最后一次提交时间
162 | * @param {string} plugin 插件名称
163 | * @returns
164 | */
165 | async getTime (plugin = '') {
166 | const cm = `cd ./plugins/${plugin}/ && git log -1 --oneline --pretty=format:"%cd" --date=format:"%m-%d %H:%M"`
167 |
168 | let time = ''
169 | try {
170 | time = await execSync(cm, { encoding: 'utf-8' })
171 | time = lodash.trim(time)
172 | } catch (error) {
173 | logger.error(error.toString())
174 | time = '获取时间失败'
175 | }
176 | return time
177 | }
178 |
179 | /**
180 | * 制作转发消息
181 | * @param {string} title 标题 - 首条消息
182 | * @param {string} msg 日志信息
183 | * @param {string} end 最后一条信息
184 | * @returns
185 | */
186 | async makeForwardMsg (title, msg, end) {
187 | let nickname = (this.e.bot ?? Bot).nickname
188 | if (this.e.isGroup) {
189 | let info = await (this.e.bot ?? Bot).getGroupMemberInfo(this.e.group_id, (this.e.bot ?? Bot).uin)
190 | nickname = info.card || info.nickname
191 | }
192 | let userInfo = {
193 | user_id: (this.e.bot ?? Bot).uin,
194 | nickname
195 | }
196 |
197 | let forwardMsg = [
198 | {
199 | ...userInfo,
200 | message: title
201 | },
202 | {
203 | ...userInfo,
204 | message: msg
205 | }
206 | ]
207 |
208 | if (end) {
209 | forwardMsg.push({
210 | ...userInfo,
211 | message: end
212 | })
213 | }
214 |
215 | /** 制作转发内容 */
216 | if (this.e.group?.makeForwardMsg) {
217 | forwardMsg = await this.e.group.makeForwardMsg(forwardMsg)
218 | } else if (this.e?.friend?.makeForwardMsg) {
219 | forwardMsg = await this.e.friend.makeForwardMsg(forwardMsg)
220 | } else {
221 | return msg.join('\n')
222 | }
223 |
224 | let dec = 'neko-status-plugin 更新日志'
225 | /** 处理描述 */
226 | if (typeof (forwardMsg.data) === 'object') {
227 | let detail = forwardMsg.data?.meta?.detail
228 | if (detail) {
229 | detail.news = [{ text: dec }]
230 | }
231 | } else {
232 | forwardMsg.data = forwardMsg.data
233 | .replace(/\n/g, '')
234 | .replace(/展示服务器负载
97 |98 | 99 | 使用 `uptime` 命令可以查看服务器的负载情况。该命令返回的内容类似于以下文本： 100 | 101 | ``` 102 | 16:31:32 up 5 days, 22:52, 4 users, load average: 0.02, 0.01, 0.00 103 | ``` 104 | 105 | 这样展示的内容较多，我们希望仅提取负载值，并将其转换为百分比形式。因此，可以使用以下命令： 106 | 107 | **命令：** 108 | ```bash 109 | uptime | awk -F'[:,]' '{printf "%.2f%% %.2f%% %.2f%%\n", ($8 * 100) / nproc, ($9 * 100) / nproc, ($10 * 100) / nproc}' nproc=$(nproc) 110 | ``` 111 | 112 | **命令解析：** 113 | 1. `uptime`：获取系统当前的负载信息 114 | 2. `awk -F'[:,]'`：使用 `:` 和 `,` 作为输入分隔符进行解析 115 | 3. `printf`：格式化输出三个负载值（$8, $9, $10），相对于 CPU 核心数（通过 `nproc` 获取），并以百分比形式显示 116 | 4. `nproc=$(nproc)`：获取当前可用的 CPU 核心数 117 | 118 |