koishi-plugin-steam-info-check 1.0.9 → 1.1.0

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export interface Config {
     steamRequestInterval: number;
     steamBroadcastType: 'all' | 'part' | 'none';
     steamDisableBroadcastOnStartup: boolean;
+    logForwardTarget?: string;
     fonts: {
         regular: string;
         light: string;

package/dist/index.js

@@ -17,6 +17,7 @@ exports.Config = koishi_1.Schema.object({
     steamRequestInterval: koishi_1.Schema.number().default(300).description('轮询间隔（秒）'),
     steamBroadcastType: koishi_1.Schema.union(['all', 'part', 'none']).default('part').description('播报类型：all（全部图片列表）、part（仅开始游戏时图片）、none（仅文字）'),
     steamDisableBroadcastOnStartup: koishi_1.Schema.boolean().default(false).description('启动时禁用首次播报（仅预热缓存）'),
+    logForwardTarget: koishi_1.Schema.string().description('将所有日志转发到的目标用户 QQ（可选）'),
     fonts: koishi_1.Schema.object({
         regular: koishi_1.Schema.string().default('fonts/MiSans-Regular.ttf'),
         light: koishi_1.Schema.string().default('fonts/MiSans-Light.ttf'),
@@ -41,6 +42,39 @@ function apply(ctx, config) {
     // Services
     ctx.plugin(service_1.SteamService, config);
     ctx.plugin(drawer_1.DrawService, config);
+    // 日志转发（可选）
+    if (config.logForwardTarget) {
+        const target = config.logForwardTarget;
+        const sendToTarget = async (level, message) => {
+            try {
+                const bots = Object.values(ctx.bots);
+                const bot = bots[0];
+                if (!bot)
+                    return;
+                const text = `[${exports.name}][${level}] ${typeof message === 'string' ? message : JSON.stringify(message)}`;
+                await bot.sendMessage(target, text);
+            }
+            catch {
+                // 忽略转发失败，避免影响主流程
+            }
+        };
+        const ld = exports.logger;
+        const wrap = (orig, level) => (...args) => {
+            try {
+                orig(...args);
+            }
+            catch { }
+            try {
+                sendToTarget(level, args.map(a => (typeof a === 'string' ? a : JSON.stringify(a))).join(' '));
+            }
+            catch { }
+        };
+        ld.debug = wrap(ld.debug?.bind(ld) || (() => { }), 'DEBUG');
+        ld.info = wrap(ld.info?.bind(ld) || (() => { }), 'INFO');
+        ld.warn = wrap(ld.warn?.bind(ld) || (() => { }), 'WARN');
+        ld.error = wrap(ld.error?.bind(ld) || (() => { }), 'ERROR');
+        ld.fatal = wrap(ld.fatal?.bind(ld) || (() => { }), 'FATAL');
+    }
     // Database
     ctx.model.extend('steam_bind', {
         id: 'unsigned',
@@ -257,53 +291,90 @@ async function ensureChannelMeta(ctx, session) {
     }
     // OneBot 群名补充
     if (!name && session.platform?.includes('onebot') && session.bot?.internal?.getGroupInfo) {
-        // 柔性尝试多种参数传递方式，记录每次调用结果以便定位 napcat/onebot 的参数格式差异
-        const argVariants = [
-            { group_id: channelId },
-            { group_id: { group_id: channelId } },
-            { group_id: Number(channelId) },
-            { group_id: { group_id: Number(channelId) } },
-        ];
-        for (const args of argVariants) {
+        // 先尝试原始（primitive）参数，许多 adapter/napcat 期望直接的字符串或数字
+        const primitiveVariants = [channelId, Number(channelId)];
+        for (const arg of primitiveVariants) {
             try {
-                exports.logger.error(`getGroupInfo 尝试 args=${JSON.stringify(args)}`);
-                const info = await session.bot.internal.getGroupInfo(args);
+                exports.logger.error(`getGroupInfo 尝试 args=${JSON.stringify(arg)}`);
+                const info = await session.bot.internal.getGroupInfo(arg);
                 exports.logger.error(`getGroupInfo 返回: ${JSON.stringify(info)}`);
-                if (!info)
-                    continue;
-                // 支持多种返回结构：直接 group_name、data.group_name（napcat）、或嵌套情况
-                if (info.group_name) {
-                    name = info.group_name;
-                    break;
-                }
-                if (info.data && info.data.group_name) {
-                    name = info.data.group_name;
-                    break;
-                }
-                if (info.data && info.data.group && info.data.group.group_name) {
-                    name = info.data.group.group_name;
-                    break;
-                }
-                // 某些实现会把返回包在 ret.data 或直接在 ret
-                if (info.ret && info.ret.data && info.ret.data.group_name) {
-                    name = info.ret.data.group_name;
-                    break;
+                if (info) {
+                    if (info.group_name) {
+                        name = info.group_name;
+                        break;
+                    }
+                    if (info.data && info.data.group_name) {
+                        name = info.data.group_name;
+                        break;
+                    }
+                    if (info.data && info.data.group && info.data.group.group_name) {
+                        name = info.data.group.group_name;
+                        break;
+                    }
+                    if (info.ret && info.ret.data && info.ret.data.group_name) {
+                        name = info.ret.data.group_name;
+                        break;
+                    }
                 }
-                // 如果未识别结构，记录并继续尝试下一个参数形态
-                exports.logger.error('getGroupInfo 返回了未识别结构（尝试 参数：' + JSON.stringify(args) + '）: ' + JSON.stringify(info) + ' EEE');
             }
             catch (err) {
-                // 记录详细错误以便分析 retcode/args
+                exports.logger.error('getGroupInfo 原始参数调用失败，arg=' + JSON.stringify(arg) + '，错误：' + String(err) + ' EEE');
+                if (err && err.message) {
+                    exports.logger.error('getGroupInfo 原始错误信息: ' + String(err.message));
+                }
+            }
+        }
+        // 如果 primitive 未成功，再尝试对象参数包裹形式
+        if (!name) {
+            const argVariants = [
+                { group_id: channelId },
+                { group_id: { group_id: channelId } },
+                { group_id: Number(channelId) },
+                { group_id: { group_id: Number(channelId) } },
+            ];
+            for (const args of argVariants) {
                 try {
-                    exports.logger.error('getGroupInfo 调用失败，args=' + JSON.stringify(args) + '，错误：' + String(err) + ' EEE');
+                    exports.logger.error(`getGroupInfo 尝试 args=${JSON.stringify(args)}`);
+                    const info = await session.bot.internal.getGroupInfo(args);
+                    exports.logger.error(`getGroupInfo 返回: ${JSON.stringify(info)}`);
+                    if (!info)
+                        continue;
+                    if (info.group_name) {
+                        name = info.group_name;
+                        break;
+                    }
+                    if (info.data && info.data.group_name) {
+                        name = info.data.group_name;
+                        break;
+                    }
+                    if (info.data && info.data.group && info.data.group.group_name) {
+                        name = info.data.group.group_name;
+                        break;
+                    }
+                    if (info.ret && info.ret.data && info.ret.data.group_name) {
+                        name = info.ret.data.group_name;
+                        break;
+                    }
+                    exports.logger.error('getGroupInfo 返回了未识别结构（尝试 参数：' + JSON.stringify(args) + '）: ' + JSON.stringify(info) + ' EEE');
                 }
-                catch (e) {
-                    exports.logger.error('getGroupInfo 调用失败但记录 args 时出错：' + String(e) + ' EEE');
+                catch (err) {
+                    try {
+                        exports.logger.error('getGroupInfo 调用失败，args=' + JSON.stringify(args) + '，错误：' + String(err) + ' EEE');
+                        if (err && err.message) {
+                            exports.logger.error('getGroupInfo 原始错误信息: ' + String(err.message));
+                        }
+                    }
+                    catch (e) {
+                        exports.logger.error('getGroupInfo 调用失败但记录 args 时出错：' + String(e) + ' EEE');
+                    }
                 }
-                // 如果错误中包含 retcode，记录方便排查
-                // 继续尝试下一个参数变体
             }
         }
+        // 所有尝试失败，记录最终失败并使用回退值
+        if (!name) {
+            exports.logger.error('getGroupInfo 所有尝试均失败，使用回退群名: ' + channelId + ' EEE');
+            name = channelId;
+        }
     }
     let avatar = current.avatar;
     if (!avatar) {
@@ -368,13 +439,11 @@ async function broadcast(ctx, config) {
                 const oldGame = old.gameextrainfo;
                 const newGame = current.gameextrainfo;
                 const name = bind.nickname || current.personaname;
+                // 只在玩家开始游戏或从一个游戏切换到另一个游戏时推送
                 if (newGame && !oldGame) {
                     msgs.push(`${name} 开始玩 ${newGame} 了`);
                     startGamingPlayers.push({ ...current, nickname: bind.nickname });
                 }
-                else if (!newGame && oldGame) {
-                    msgs.push(`${name} 玩了 ${oldGame} 后不玩了`);
-                }
                 else if (newGame && oldGame && newGame !== oldGame) {
                     msgs.push(`${name} 停止玩 ${oldGame}，开始玩 ${newGame} 了`);
                 }

package/dist/locales/zh-CN.d.ts

@@ -1,4 +1,29 @@
 declare const _default: {
+    'steam-info': {
+        config: {
+            steamApiKey: string;
+            proxy: string;
+            steamRequestInterval: string;
+            steamBroadcastType: string;
+            steamDisableBroadcastOnStartup: string;
+            logForwardTarget: string;
+            fonts: {
+                regular: string;
+                light: string;
+                bold: string;
+            };
+            commandAuthority: {
+                bind: string;
+                unbind: string;
+                info: string;
+                check: string;
+                enable: string;
+                disable: string;
+                update: string;
+                nickname: string;
+            };
+        };
+    };
     commands: {
         steam: {
             bind: {

package/dist/locales/zh-CN.js

@@ -1,6 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
+    'steam-info': {
+        config: {
+            steamApiKey: 'Steam API Key（支持多个）',
+            proxy: '代理地址，例如 http://127.0.0.1:7890',
+            steamRequestInterval: '轮询间隔（秒）',
+            steamBroadcastType: '播报类型：all（全部图片列表）、part（仅开始游戏时图片）、none（仅文字）',
+            steamDisableBroadcastOnStartup: '启动时禁用首次播报（仅预热缓存）',
+            logForwardTarget: '日志转发目标 QQ（填写 QQ 号）',
+            fonts: {
+                regular: '常规字体路径',
+                light: '细体字体路径',
+                bold: '粗体字体路径',
+            },
+            commandAuthority: {
+                bind: '绑定命令权限',
+                unbind: '解绑命令权限',
+                info: '查看资料命令权限',
+                check: '查看状态命令权限',
+                enable: '启用播报命令权限',
+                disable: '禁用播报命令权限',
+                update: '更新群信息命令权限',
+                nickname: '设置昵称命令权限',
+            },
+        },
+    },
     commands: {
         steam: {
             bind: {

package/nonebot-plugin-steam-info-main/.github/actions/setup-python/action.yml

@@ -0,0 +1,21 @@
+name: Setup Python
+description: Setup Python
+
+inputs:
+  python-version:
+    description: Python version
+    required: false
+    default: "3.10"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: pdm-project/setup-pdm@v3
+      name: Setup PDM
+      with:
+        python-version: ${{ inputs.python-version }}
+        architecture: "x64"
+        cache: true
+
+    - run: pdm sync -G:all
+      shell: bash

package/nonebot-plugin-steam-info-main/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+
+      - name: Get Version
+        id: version
+        run: |
+          echo "VERSION=$(pdm show --version)" >> $GITHUB_OUTPUT
+          echo "TAG_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+          echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+
+      - name: Check Version
+        if: steps.version.outputs.VERSION != steps.version.outputs.TAG_VERSION
+        run: exit 1
+
+      - name: Publish Package
+        run: |
+          pdm publish
+          gh release upload --clobber ${{ steps.version.outputs.TAG_NAME }} dist/*.tar.gz dist/*.whl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/nonebot-plugin-steam-info-main/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Gitai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/nonebot-plugin-steam-info-main/README.md

@@ -0,0 +1,117 @@
+# Nonebot-Plugin-Steam-Info
+✨ Steam 好友状态播报 NoneBot 插件 ✨
+
+## 介绍
+
+这是一个基于 NoneBot2 的 Steam 好友状态播报插件，拥有绑定 Steam ID，查询群友状态，展示个人 Steam 主页等功能，支持跨平台，画图部分 100% 使用 Pillow 实现，较无头浏览器渲染更加轻量高效
+
+## 功能
+- [x] 绑定 Steam ID
+- [x] 群友状态变更播报
+- [x] 群友游戏时间播报
+- [x] 主动查询群友状态
+- [x] 展示个人 Steam 主页
+
+## 预览
+仿照了 Steam 好友列表的样式
+
+图 1. 全部播报
+![image](./preview.png)
+
+图 2. 部分播报
+![image](./preview_1.png)
+
+图 3. 个人 Steam 主页
+![image](./preview_2.png)
+
+
+## 使用
+| 命令 | 别名 |  说明 |
+| --- | --- | --- |
+| steambind [Steam ID 或 Steam好友代码] | 绑定steam | 绑定 Steam |
+| steamunbind | 解绑steam | 解绑 Steam |
+| steaminfo (可选)[@某人 或 Steam ID 或 Steam好友代码] | steam信息 | 查看个人主页 |
+| steamcheck | 查看steam, 查steam | 查询群友 Steam 状态 |
+| steamupdate [名称] [图片] | 更新群信息 | 更新群聊头像和名称 |
+| steamenable | 启用steam | 启用群友状态播报 |
+| steamdisable | 禁用steam | 禁用群友状态播报 |
+| steamnickname [昵称] | steam昵称 | 设置 Steam 玩家昵称，用于辨识 Steam 名称与群昵称不一致的群友 |
+
+> 记得加上你配置的命令头哦
+
+## 安装方法
+<details open>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-steam-info
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-steam-info
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-steam-info
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-steam-info
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-steam-info
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_steam_info"]
+
+</details>
+
+
+
+
+## 配置
+在 .env 文件中配置以下内容
+
+| 配置项 | 默认值 | 说明 |
+| --- | --- | --- |
+| STEAM_API_KEY | 无 | Steam API Key，可以是一个字符串，也可以是一列表的字符串，即支持多个API Key，在 [此处](https://partner.steamgames.com/doc/webapi_overview/auth) 获取 |
+| PROXY | 无 | 代理地址 |
+| STEAM_REQUEST_INTERVAL | 300 | Steam 请求间隔 & 播报间隔。单位为秒 |
+| STEAM_BROADCAST_TYPE | `"part"` | 播报类型。`"part"` 为部分播报(图 2)，`"all"` 为全部播报(图 1)，`"none"` 为只播报文字消息 |
+| STEAM_DISABLE_BROADCAST_ON_STARTUP | `False` | Bot 启动时是否禁用播报 |
+| STEAM_FONT_REGULAR_PATH | fonts/MiSans-Regular.ttf | Regular 字体相对目录 |
+| STEAM_FONT_LIGHT_PATH | fonts/MiSans-Light.ttf | Light 字体相对目录 |
+| STEAM_FONT_BOLD_PATH |fonts/MiSans-Bold.ttf | Bold 字体相对目录 |
+
+最后再把仓库中 `fonts` 文件夹放到 Bot 的 **运行目录** 下，配置就完毕啦
+
+在默认配置下，项目结构大致如下：
+```
+your_project/
+├── bot.py
+├── .env.*
+├── fonts/
+│   ├── MiSans-Regular.ttf
+│   ├── MiSans-Light.ttf
+│   └── MiSans-Bold.ttf
+└── ...
+```
+
+> 这里使用了 MiSans 字体，感谢 [MiSans](https://hyperos.mi.com/font/zh/)
+
+> 如果你希望使用其他字体，请参考配置版块。
+
+> 如果配置中不填写 `font/`，则会在`your_project/`下寻找字体文件。