koishi-plugin-steaminfo-xiaoheihe 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 WhiteBr1ck
+
+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/lib/index.d.ts

@@ -0,0 +1,16 @@
+import { Context, Schema } from 'koishi';
+export declare const name = "steaminfo-xiaoheihe";
+export declare const using: string[];
+export interface Config {
+    cookies: string;
+    waitTimeout: number;
+    renderDelay: number;
+    deviceScaleFactor: number;
+    imageType: 'jpeg' | 'png';
+    imageQuality: number;
+    showGameTitle: boolean;
+    showOnlineCount: boolean;
+    debug: boolean;
+}
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,197 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Config: () => Config,
+  apply: () => apply,
+  name: () => name,
+  using: () => using
+});
+module.exports = __toCommonJS(src_exports);
+var import_koishi = require("koishi");
+var name = "steaminfo-xiaoheihe";
+var using = ["puppeteer"];
+var Config = import_koishi.Schema.intersect([
+  import_koishi.Schema.object({
+    cookies: import_koishi.Schema.string().description("【选填】【建议填写】登录小黑盒后获取的Cookie。获取方式请查看readme。").role("secret")
+  }).description("身份验证"),
+  import_koishi.Schema.object({
+    waitTimeout: import_koishi.Schema.number().description("页面加载的超时时间（毫秒）。").default(6e4),
+    renderDelay: import_koishi.Schema.number().description("在内容框架出现后，额外等待渲染的时间（毫秒）。").default(5e3),
+    deviceScaleFactor: import_koishi.Schema.number().min(1).max(3).step(0.5).description("截图清晰度（设备缩放因子）。设置为 2 可让文字更加清晰。").default(2),
+    imageType: import_koishi.Schema.union(["jpeg", "png"]).description("截图的图片格式。PNG 无损但文件较大，JPEG 有损但文件较小。").default("jpeg"),
+    imageQuality: import_koishi.Schema.number().min(1).max(100).description("图片质量，仅在格式为 jpeg 时生效。").default(95)
+  }).description("高级设置"),
+  import_koishi.Schema.object({
+    showGameTitle: import_koishi.Schema.boolean().description("是否在截图前显示“游戏名”文本。").default(true),
+    showOnlineCount: import_koishi.Schema.boolean().description("是否在截图前显示“当前在线”文本。").default(true)
+  }).description("显示设置"),
+  import_koishi.Schema.object({
+    debug: import_koishi.Schema.boolean().description("启用后，将在控制台输出详细的调试日志。").default(false)
+  }).description("调试")
+]);
+function apply(ctx, config) {
+  const logger = ctx.logger("xiaoheihe");
+  const log = /* @__PURE__ */ __name((message) => {
+    if (config.debug) {
+      logger.info(message);
+    }
+  }, "log");
+  ctx.command("xiaoheihe <game:text>", "小黑盒游戏页面截图").alias("小黑盒").action(async ({ session }, game) => {
+    if (!game) return "请输入要搜索的游戏名称。";
+    let page;
+    let tempMessageId;
+    try {
+      const tempMessage = [
+        import_koishi.segment.quote(session.messageId),
+        "请求已收到，正在为您生成游戏截图，请稍候..."
+      ];
+      const sentMessageIds = await session.send(tempMessage);
+      tempMessageId = sentMessageIds[0];
+      log(`收到截图请求，游戏名称: "${game}"。临时消息ID: ${tempMessageId}`);
+      page = await ctx.puppeteer.page();
+      await page.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36");
+      if (config.cookies) {
+        const cookies = config.cookies.split(";").map((pair) => {
+          const parts = pair.trim().split("=");
+          const name2 = parts.shift();
+          const value = parts.join("=");
+          return { name: name2, value, domain: ".xiaoheihe.cn" };
+        });
+        await page.setCookie(...cookies);
+        log(`成功注入 ${cookies.length} 个 Cookie。`);
+      } else {
+        log("未配置Cookie，以游客身份访问。");
+      }
+      await page.setViewport({ width: 1280, height: 800, deviceScaleFactor: config.deviceScaleFactor });
+      log(`视口已设置为 1280x800，缩放因子为 ${config.deviceScaleFactor}。`);
+      const searchUrl = `https://www.xiaoheihe.cn/app/search?q=${encodeURIComponent(game)}`;
+      log(`准备导航到搜索页面: ${searchUrl}`);
+      await page.goto(searchUrl, { waitUntil: "load", timeout: config.waitTimeout });
+      const gameLinkSelector = 'a[href*="/app/topic/game/"]';
+      let gamePageHref;
+      try {
+        log(`将使用选择器 "${gameLinkSelector}" 寻找游戏链接...`);
+        await page.waitForSelector(gameLinkSelector, { timeout: 1e4 });
+        gamePageHref = await page.$eval(gameLinkSelector, (el) => el.getAttribute("href"));
+      } catch (e) {
+        if (config.debug) logger.warn("在搜索页未能找到游戏链接，可能是Cookie失效、游戏不存在或页面结构更新。");
+        const screenshot = await page.screenshot({ fullPage: true });
+        await session.send(["未能找到游戏专题链接。这是当前页面的截图：", import_koishi.segment.image(screenshot)]);
+        return;
+      }
+      const finalUrl = `https://www.xiaoheihe.cn${gamePageHref}`;
+      log(`已获取详情页链接，正在导航到: ${finalUrl}`);
+      await page.goto(finalUrl, { waitUntil: "load", timeout: config.waitTimeout });
+      const mainContentSelector = ".game-detail-page-detail";
+      log(`等待核心内容 "${mainContentSelector}" 出现...`);
+      await page.waitForSelector(mainContentSelector, { timeout: config.waitTimeout });
+      log("核心内容容器已出现！");
+      let extractedTitle = game;
+      let onlineInfo = "获取失败";
+      try {
+        const titleSelector = ".game-name p.name";
+        const onlineNumberSelector = ".data-list .data-item:first-child .editor p";
+        const onlineUnitSelector = ".data-list .data-item:first-child .editor p + p";
+        const onlineLabelSelector = ".data-list .data-item:first-child > .p2";
+        log("等待标题和数据项出现...");
+        await Promise.all([
+          page.waitForSelector(titleSelector, { timeout: 1e4 }),
+          page.waitForSelector(onlineNumberSelector, { timeout: 1e4 }),
+          page.waitForSelector(onlineLabelSelector, { timeout: 1e4 })
+        ]);
+        log("标题和数据项均已出现，开始提取...");
+        const title = await page.$eval(titleSelector, (el) => el.textContent.trim());
+        const number = await page.$eval(onlineNumberSelector, (el) => el.textContent.trim());
+        const label = await page.$eval(onlineLabelSelector, (el) => el.textContent.trim());
+        let unit = "";
+        try {
+          unit = await page.$eval(onlineUnitSelector, (el) => el.textContent.trim());
+        } catch {
+        }
+        extractedTitle = title;
+        onlineInfo = `${label}：${number}${unit}`;
+        log(`成功提取到标题: "${extractedTitle}"`);
+        log(`成功提取到在线信息: "${onlineInfo}"`);
+      } catch {
+        log(`无法从页面提取标题或在线人数，将使用用户输入的游戏名。`);
+      }
+      log(`额外等待 ${config.renderDelay} 毫秒以确保内容渲染完成...`);
+      await new Promise((resolve) => setTimeout(resolve, config.renderDelay));
+      const selectorsToHide = [
+        ".game-detail-section-comment",
+        ".game-detail-section-similar-games",
+        ".publish-score-wrapper"
+      ];
+      const selectorToModify = ".game-detail-section-footer";
+      log(`准备隐藏 ${selectorsToHide.length} 个元素，并修正 1 个悬浮元素的位置...`);
+      await page.evaluate((toHide, toModify) => {
+        for (const selector of toHide) {
+          const element2 = document.querySelector(selector);
+          if (element2) element2.style.display = "none";
+        }
+        const floatingElement = document.querySelector(toModify);
+        if (floatingElement) floatingElement.style.position = "static";
+      }, selectorsToHide, selectorToModify);
+      const element = await page.$(mainContentSelector);
+      if (!element) throw new Error("无法定位到已等待的核心内容元素");
+      log(`正在执行最终的精准截图... 格式: ${config.imageType}`);
+      const imageBuffer = await element.screenshot({ type: config.imageType, quality: config.imageType === "jpeg" ? config.imageQuality : void 0 });
+      log("截图成功！");
+      const message = [];
+      const textLines = [];
+      if (config.showGameTitle) textLines.push(`游戏名：${extractedTitle}`);
+      if (config.showOnlineCount && onlineInfo !== "获取失败") textLines.push(onlineInfo);
+      const textContent = textLines.join("\n");
+      if (textContent) message.push(textContent);
+      message.push(import_koishi.segment.image(imageBuffer));
+      await session.send(message);
+    } catch (error) {
+      logger.error("截图过程中发生严重错误:", error);
+      let errorMsg = `截图失败，请检查控制台错误日志。`;
+      if (error.name === "TimeoutError") {
+        errorMsg = `截图失败，页面加载超时。可能是小黑盒服务器繁忙或您的网络不稳定。`;
+      }
+      await session.send(errorMsg);
+    } finally {
+      if (page) {
+        await page.close();
+        log("浏览器页面已关闭。");
+      }
+      if (tempMessageId) {
+        try {
+          await session.bot.deleteMessage(session.channelId, tempMessageId);
+          log(`临时消息 ${tempMessageId} 已撤回。`);
+        } catch (e) {
+          logger.warn(`撤回临时消息失败: ${e.message}`);
+        }
+      }
+    }
+  });
+}
+__name(apply, "apply");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Config,
+  apply,
+  name,
+  using
+});

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "koishi-plugin-steaminfo-xiaoheihe",
+  "version": "0.1.0",
+  "description": "通过小黑盒网站搜索并生成截图获取 steam 游戏信息",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "author": "WhiteBr1ck",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WhiteBr1ck/koishi-plugin-steaminfo-xiaoheihe.git"
+  },
+  "bugs": {
+    "url": "https://github.com/WhiteBr1ck/koishi-plugin-steaminfo-xiaoheihe/issues"
+  },
+  "homepage": "https://github.com/WhiteBr1ck/koishi-plugin-steaminfo-xiaoheihe#readme",
+  "keywords": [
+    "koishi",
+    "plugin",
+    "xiaoheihe",
+    "heybox",
+    "game",
+    "screenshot",
+    "小黑盒",
+    "游戏",
+    "截图"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.18.7"
+  }
+}

package/readme.md

@@ -0,0 +1,82 @@
+# koishi-plugin-steaminfo-xiaoheihe
+
+[![npm](https://img.shields.io/npm/v/koishi-plugin-steaminfo-xiaoheihe?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-steaminfo-xiaoheihe)
+
+一个为 [Koishi](https://koishi.chat/) 设计的插件，允许用户通过指令搜索小黑盒上的内容，并返回一个包含游戏信息的截图。
+
+## ✨ 功能
+
+-   对小黑盒游戏详情页进行截图。
+-   提取游戏标题和在线人数。
+-   支持配置小黑盒 Cookie 以访问需要登录才能查看的内容。
+
+## 🚀 安装
+
+  **前往 Koishi 插件市场，搜索 `steaminfo-xiaoheihe` 并安装。**
+
+
+## 📝 使用
+
+启用插件后，向机器人发送指令即可：
+
+-   **`小黑盒 <游戏名称>`**
+-   别名: **`xiaoheihe <游戏名称>`**
+
+**示例：**
+
+```
+小黑盒 三角洲行动
+```
+
+机器人将会回复包含该游戏信息的高清截图。
+
+## ⚙️ 配置项
+
+所有配置项均可在插件的设置界面中进行修改。
+
+### 身份验证
+
+-   **cookies**: (选填，但建议填写) 登录小黑盒后获取的Cookie字符串。提供后可以正常使用搜索功能，并访问需要登录才能查看的内容。
+
+### 高级设置
+
+-   **waitTimeout**: 页面加载的超时时间（毫秒）。
+-   **renderDelay**: 在内容框架出现后，额外等待渲染的时间（毫秒），用于确保图片等动态内容加载完成。
+-   **deviceScaleFactor**: 截图清晰度。设置为 `2` 可获得更清晰的“视网膜”截图效果。
+-   **imageType**: 截图的图片格式。`jpeg` 文件较小，`png` 画质无损但文件较大。
+-   **imageQuality**: 图片质量，仅在格式为 `jpeg` 时生效。
+
+### 显示设置
+
+-   **showGameTitle**: 是否在截图前显示“游戏名”文本。
+-   **showOnlineCount**: 是否在截图前显示“当前在线”文本。
+
+### 调试
+
+-   **debug**: 启用后，将在控制台输出详细的运行日志，方便排查问题。
+
+---
+
+### 如何获取小黑盒 Cookie？
+
+1.  在你的电脑浏览器（推荐 Chrome 或 Edge）中，访问并登录 [小黑盒官网](https://www.xiaoheihe.cn/)。
+2.  登录成功后，在当前页面按 `F12` 键，打开“开发者工具”。
+3.  切换到“网络” (Network) 面板。
+4.  按 `F5` 刷新一下页面，此时面板中会显示很多网络请求。
+5.  在请求列表中，随便点击一个发往 `www.xiaoheihe.cn` 的请求。比如 [![示例](https://i.postimg.cc/Z5yQ77X5/1.png)](https://postimg.cc/Hrd3j2pq)
+6.  在右侧新出现的窗口中，找到“请求标头” (Request Headers) 部分。
+7.  找到名为 `cookie:` 的一行，右键点击它，选择“复制值” (Copy value)。
+8.  将复制的整段字符串粘贴到本插件配置项的 `cookies` 输入框中即可。
+
+## ⚠️ 免责声明
+
+-   本插件通过模拟浏览器操作访问公开的网页信息，所有数据均来自小黑盒 (xiaoheihe.cn)。
+-   本插件仅供学习和技术交流使用，用户应自觉遵守相关法律法规及网站的用户协议。
+-   因滥用本插件或因小黑盒网站结构变更导致的任何问题，开发者不承担任何责任。
+-   请勿将本插件用于任何商业或非法用途。
+
+## 📄 License
+
+本插件使用 [MIT License](https://github.com/WhiteBr1ck/koishi-plugin-steaminfo-xiaoheihe/blob/main/LICENSE) 授权。
+
+© 2025, WhiteBr1ck.