koishi-plugin-mgtown-update 1.0.0

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+import { Context, Schema } from 'koishi';
+export declare const name = "mgtown-update";
+export interface Config {
+    /** API 基础地址，例如 http://192.168.1.100:8080，末尾不要带斜杠 */
+    apiUrl: string;
+    /** 管理令牌，用于 Authorization 头 */
+    adminToken: string;
+    /** 获取信息时是否需要令牌（默认 false） */
+    getRequiresToken?: boolean;
+}
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,251 @@
+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
+});
+module.exports = __toCommonJS(src_exports);
+var import_koishi = require("koishi");
+var name = "mgtown-update";
+var Config = import_koishi.Schema.object({
+  apiUrl: import_koishi.Schema.string().description("API 的基础 URL，例如 http://192.168.1.100:8080（末尾不要加 /）").required(),
+  adminToken: import_koishi.Schema.string().description("管理令牌 (Bearer Token)").required(),
+  getRequiresToken: import_koishi.Schema.boolean().description("GET /api/info 请求是否需要携带令牌").default(false)
+});
+function apply(ctx, config) {
+  const logger = ctx.logger("mgtown-update");
+  async function sendLongText(session, text, maxLength = 2e3) {
+    for (let i = 0; i < text.length; i += maxLength) {
+      await session.send(text.substring(i, i + maxLength));
+    }
+  }
+  __name(sendLongText, "sendLongText");
+  function buildTreeLines(obj, prefix = "", isLast = true) {
+    const lines = [];
+    const keys = Object.keys(obj);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const value = obj[key];
+      const isLastItem = i === keys.length - 1;
+      const connector = isLastItem ? "└─ " : "├─ ";
+      const newPrefix = prefix + (isLast ? "    " : "│   ");
+      let valueDesc = "";
+      if (value === null) {
+        valueDesc = "null";
+      } else if (Array.isArray(value)) {
+        valueDesc = `array[${value.length}]`;
+      } else if (typeof value === "object") {
+        valueDesc = "object";
+      } else if (typeof value === "string") {
+        const short = value.length > 30 ? value.substring(0, 30) + "…" : value;
+        valueDesc = `"${short}" (string, 长度 ${value.length})`;
+      } else {
+        valueDesc = String(value) + ` (${typeof value})`;
+      }
+      lines.push(prefix + connector + key + (valueDesc ? ": " + valueDesc : ""));
+      if (value && typeof value === "object") {
+        if (Array.isArray(value)) {
+          for (let j = 0; j < value.length; j++) {
+            const elem = value[j];
+            const elemIsLast = j === value.length - 1;
+            const elemConnector = elemIsLast ? "└─ " : "├─ ";
+            lines.push(newPrefix + (isLastItem ? "    " : "│   ") + elemConnector + `[${j}]`);
+            if (elem && typeof elem === "object") {
+              const subLines = buildTreeLines(elem, newPrefix + (isLastItem ? "    " : "│   ") + (elemIsLast ? "    " : "│   "), elemIsLast);
+              lines.push(...subLines);
+            }
+          }
+        } else {
+          const subLines = buildTreeLines(value, newPrefix, isLastItem);
+          lines.push(...subLines);
+        }
+      }
+    }
+    return lines;
+  }
+  __name(buildTreeLines, "buildTreeLines");
+  ctx.command("town", "管理小镇 API 信息", { authority: 3 });
+  ctx.command("town.get", "获取当前小镇信息", { authority: 3 }).action(async ({ session }) => {
+    await session.send("正在获取小镇信息，请稍候……");
+    const url = `${config.apiUrl}/api/info`;
+    const headers = { "Content-Type": "application/json" };
+    if (config.getRequiresToken) {
+      headers.Authorization = `Bearer ${config.adminToken}`;
+    }
+    logger.info("正在请求小镇信息");
+    logger.info("请求 URL: %s", url);
+    logger.info("请求 Headers: %o", headers);
+    try {
+      const response = await ctx.http.get(url, { headers });
+      logger.info("成功获取小镇信息");
+      const { success, data, message, timestamp } = response;
+      if (!success) {
+        return `获取失败：${message || "未知错误"}`;
+      }
+      const { basic, downloads, news, media } = data;
+      if (basic.description) {
+        const safeName = (basic.name || "小镇").replace(/[\\/:*?"<>|]/g, "_");
+        const filename = `${safeName}_简介.md`;
+        try {
+          const base64 = Buffer.from(basic.description, "utf-8").toString("base64");
+          const dataUrl = `data:text/markdown;charset=utf-8;base64,${base64}`;
+          await session.send((0, import_koishi.h)("file", { src: dataUrl, title: filename }));
+          logger.info("简介文件发送成功");
+        } catch (fileError) {
+          logger.error("发送简介文件失败: %s", fileError.message);
+          await session.send("简介文件发送失败，现以文本形式发送完整简介：");
+          await sendLongText(session, basic.description);
+        }
+      } else {
+        await session.send("该小镇暂无简介");
+      }
+      let info = (0, import_koishi.h)("img", { src: basic.logo }) + `
+🏡 小镇基本信息
+名称：${basic.name}
+地图下载：${downloads.map}
+`;
+      await session.send(info);
+      if (news.activities?.length) {
+        await session.send(`📅 活动列表（共 ${news.activities.length} 条）：`);
+        for (const act of news.activities) {
+          const date = new Date(act.date * 1e3).toLocaleDateString("zh-CN");
+          await session.send(`日期：${date}
+内容：${act.content}`);
+        }
+      }
+      if (news.updates?.length) {
+        await session.send(`🆕 更新列表（共 ${news.updates.length} 条）：`);
+        for (const up of news.updates) {
+          const date = new Date(up.date * 1e3).toLocaleDateString("zh-CN");
+          await session.send(`日期：${date}
+内容：${up.content}`);
+        }
+      }
+      if (media) {
+        let mediaText = `🎬 媒体视频
+`;
+        if (media.birthday?.length) mediaText += `生日视频：${media.birthday.join("\n")}
+`;
+        if (media.newYear?.length) mediaText += `新年视频：${media.newYear.join("\n")}
+`;
+        if (media.related?.length) mediaText += `相关视频：${media.related.join("\n")}
+`;
+        await session.send(mediaText);
+      }
+      await session.send(`⏱️ 信息更新时间：${new Date(timestamp * 1e3).toLocaleString("zh-CN")}`);
+    } catch (e) {
+      logger.error("获取小镇信息失败: %s", e.message);
+      await session.send(`获取失败：${e.message}`);
+    }
+  });
+  ctx.command("town.tree", "以树形图展示小镇信息数据结构", { authority: 3 }).action(async ({ session }) => {
+    await session.send("正在生成数据结构树，请稍候……");
+    const url = `${config.apiUrl}/api/info`;
+    const headers = { "Content-Type": "application/json" };
+    if (config.getRequiresToken) {
+      headers.Authorization = `Bearer ${config.adminToken}`;
+    }
+    try {
+      const response = await ctx.http.get(url, { headers });
+      const { success, data } = response;
+      if (!success) {
+        return "获取数据失败，无法生成树。";
+      }
+      const treeLines = buildTreeLines(data);
+      const treeText = "🏷️ 小镇信息结构树：\n" + treeLines.join("\n");
+      await sendLongText(session, treeText);
+    } catch (e) {
+      logger.error("生成树失败: %s", e.message);
+      await session.send(`生成失败：${e.message}`);
+    }
+  });
+  ctx.command("town.update <key> <value:text>", "更新指定字段（支持点分隔路径）", { authority: 3 }).action(async ({ session }, key, value) => {
+    if (!key || !value) {
+      return "请指定要更新的键和值。";
+    }
+    await session.send("正在更新小镇信息，请稍候……");
+    let parsedValue;
+    const trimmed = value.trim();
+    if (trimmed.startsWith("{") && trimmed.endsWith("}") || trimmed.startsWith("[") && trimmed.endsWith("]")) {
+      try {
+        parsedValue = JSON.parse(trimmed);
+      } catch {
+        parsedValue = value;
+      }
+    } else {
+      parsedValue = value;
+    }
+    const keys = key.split(".");
+    const payload = {};
+    let current = payload;
+    for (let i = 0; i < keys.length; i++) {
+      const k = keys[i];
+      if (i === keys.length - 1) {
+        current[k] = parsedValue;
+      } else {
+        current[k] = {};
+        current = current[k];
+      }
+    }
+    const url = `${config.apiUrl}/api/admin/info`;
+    const headers = {
+      "Content-Type": "application/json",
+      "Authorization": `Bearer ${config.adminToken}`
+    };
+    logger.info("正在更新小镇信息，键路径: %s", key);
+    logger.debug("请求 URL: %s", url);
+    logger.debug("请求 Payload: %o", payload);
+    try {
+      const res = await ctx.http.post(url, payload, { headers });
+      logger.info("更新小镇信息成功");
+      let prettyMsg = "";
+      if (res.success) {
+        prettyMsg += "✅ 更新成功！\n";
+        if (res.message) prettyMsg += `📢 消息：${res.message}
+`;
+        if (res.data !== void 0 && res.data !== null) {
+          const dataStr = typeof res.data === "object" ? JSON.stringify(res.data, null, 2) : String(res.data);
+          prettyMsg += `📦 数据：${dataStr}
+`;
+        }
+        if (res.timestamp) {
+          const date = new Date(res.timestamp * 1e3).toLocaleString("zh-CN");
+          prettyMsg += `⏱️ 时间：${date}`;
+        }
+      } else {
+        prettyMsg += `❌ 更新失败：${res.message || "未知错误"}`;
+      }
+      await session.send(prettyMsg);
+    } catch (e) {
+      logger.error("更新小镇信息失败: %s", e.message);
+      await session.send(`更新失败：${e.message}`);
+    }
+  });
+}
+__name(apply, "apply");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Config,
+  apply,
+  name
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "koishi-plugin-mgtown-update",
+  "description": "",
+  "version": "1.0.0",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MGTown/koishi-plugin-mgtown-update.git"
+  },
+  "koishi": {
+    "description": {
+      "zh": "毛怪小镇MC服务器数据更新插件"
+    },
+    "hidden": true
+  },
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.18.7"
+  }
+}

package/readme.md

@@ -0,0 +1,97 @@
+# koishi-plugin-mgtown-update
+
+用于管理小镇 API 信息的 Koishi 插件，支持获取、更新和查看数据结构。基于 [TownAPI 远程更新指南](UPDATE_API.md) 实现。
+
+---
+
+## 安装
+
+在 Koishi 项目中安装本插件：
+
+```bash
+yarn add koishi-plugin-mgtown-update
+# 或
+npm install koishi-plugin-mgtown-update
+```
+
+然后将插件添加到配置文件（`koishi.config.ts` 或 `koishi.yml`）：
+
+```yaml
+plugins:
+  mgtown-update:
+    apiUrl: 'http://你的IP:8080'
+    adminToken: '你的管理令牌'
+    getRequiresToken: false   # 可选，默认为 false
+```
+
+---
+
+## 配置项
+
+### apiUrl
+- **类型**：`string`
+- **必填**：是
+- **描述**：TownAPI 的基础地址，例如 `http://192.168.1.100:8080`，末尾不要带斜杠。
+
+### adminToken
+- **类型**：`string`
+- **必填**：是
+- **描述**：用于 API 认证的管理员令牌，对应 `Authorization: Bearer <token>`。
+
+### getRequiresToken
+- **类型**：`boolean`
+- **默认值**：`false`
+- **描述**：获取信息（`GET /api/info`）时是否需要携带令牌。如果 API 要求认证，请设置为 `true`。
+
+---
+
+## 指令说明
+
+所有指令需要用户权限等级 **≥ 3**（管理员）。
+
+### town.get
+获取当前小镇信息，并分块显示：
+- 将 `basic.description` 作为 Markdown 文件发送。
+- 显示 Logo 图片（`<img>` 元素）。
+- 显示基本信息、活动列表、更新列表、媒体视频和时间戳。
+
+### town.tree
+以树形图展示小镇信息的完整数据结构，方便查看所有字段路径。树形图会分段发送以避免消息过长。
+
+### town.update <key> <value:text>
+局部更新小镇信息。
+
+- **`<key>`**：点分隔的字段路径，例如 `basic.name`、`news.activities`。
+- **`<value>`**：要设置的新值。如果值是 JSON 对象/数组，请提供合法的 JSON 字符串（如 `'{"key":"value"}'`），否则作为普通字符串处理。
+
+更新成功后会返回美化后的响应信息。
+
+#### 示例
+```bash
+# 修改小镇名称
+town.update basic.name 新小镇名称
+
+# 修改 Logo URL
+town.update basic.logo https://example.com/logo.png
+
+# 替换活动列表（需提供 JSON 数组）
+town.update news.activities '[{"date": 1771113600, "content": "今天天气不错"}]'
+
+# 更新简介（多行文本）
+town.update basic.description "这是新的简介内容。"
+```
+
+---
+
+## 注意事项
+
+- 插件依赖 **koishi 4.18.7** 或更高版本。
+- 文件发送功能要求聊天平台支持普通文件传输（如 QQ、Discord 等）。
+- 树形图显示时，字符串超过 30 字符会被截断并显示长度。
+- 如果 `town.get` 发送文件失败，会自动降级为发送文本简介。
+
+---
+
+## 协议
+
+MIT