karin-plugin-teamspeak 1.2.2 → 1.3.1

package/config/config/config.d.ts

@@ -0,0 +1,16 @@
+// 定义 config.json 的类型
+export interface Config {
+  BOT_SELF_ID: number //当前机器人的QQ号
+  //ts的连接信息
+  HOST: string //ts3服务器地址
+  PROTOCOL: "RAW" | "SSH" //ts3服务器协议 RAW 或是 SSH 一般默认RAW不用改
+  QUERY_PORT: number //ts3服务器查询端口
+  SERVER_PORT: number //ts3服务器语音端口
+  USERNAME: string //ts3服务器admin账号 创建时出现的那个
+  PASSWORD: string //ts3服务器admin密码  创建时出现的那个
+  NICKNAME: string //连接到ts3服务器使用的用户名 -- 不会显式出现在ts3服务器中可通过查询api查看到
+  NOTICE_GROUP_NO: number[] //通知用户进出ts3的群号 可多个
+  RECONNECT_TIMER: number //断线重连次数 -1表示将不断尝试
+  DIS_NOTIFY_NAME_LIST: string[] //不提醒的昵称列表 可多个 默认不提醒当前加入ts的机器人
+  SERVER_NAME: string //展示的服务器名
+}

package/config/config/config.json

@@ -0,0 +1,18 @@
+{
+  "BOT_SELF_ID": 1111111,
+  "HOST": "127.0.0.1",
+  "PROTOCOL": "RAW",
+  "QUERY_PORT": 10011,
+  "SERVER_PORT": 9987,
+  "USERNAME": "serveradmin",
+  "PASSWORD": "abc",
+  "NICKNAME": "TESTBOT",
+  "NOTICE_GROUP_NO": [
+    233333
+  ],
+  "RECONNECT_TIMER": 5,
+  "DIS_NOTIFY_NAME_LIST": [
+    "TESTBOT"
+  ],
+  "SERVER_NAME": "xxxxxxx"
+}

package/lib/apps/command.js

@@ -1,4 +1,4 @@
-import { config, dirPath } from "../utils/index.js";
+import { dirPath } from "../utils/index.js";
 import { karin, render, common, segment, logger } from "node-karin";
 import teamspeak3 from "./ts3.js";
 /**
@@ -7,9 +7,9 @@ import teamspeak3 from "./ts3.js";
  */
 export const image = karin.command(/^#?人数$/, async (e) => {
     try {
-        let usePuppeteer = config().USE_PUPPETEER || false;
+        //默认尝试使用渲染器，调用失败则表示未连接将使用文字形式发送服务器人数
+        let usePuppeteer = true;
         try {
-            //尝试调用渲染器，调用失败则表示未连接
             render.App();
         }
         catch (error) {
@@ -61,7 +61,7 @@ export const image = karin.command(/^#?人数$/, async (e) => {
     /** 插件触发是否打印触发日志 */
     log: true,
     /** 插件名称 */
-    name: "显示ts3内人数",
+    name: "显示ts服务器内人数",
     /** 谁可以触发这个插件 'all' | 'master' | 'admin' | 'group.owner' | 'group.admin' */
     permission: "all",
 });

package/lib/apps/ts3.d.ts

@@ -4,6 +4,8 @@ declare class ts3 {
     connectTimer: number;
     init: () => Promise<void>;
     getAllChannelList: () => Promise<string | undefined>;
+    quitTs: () => Promise<void>;
+    reconnectTs: () => Promise<void>;
 }
 declare const teamspeak3: ts3;
 export default teamspeak3;

package/lib/apps/ts3.js

@@ -85,9 +85,9 @@ class ts3 {
         if (!this.teamspeak) {
             return;
         }
-        let usePuppeteer = config().USE_PUPPETEER || false;
+        //默认尝试使用渲染器，调用失败则表示未连接渲染器
+        let usePuppeteer = true;
         try {
-            //尝试调用渲染器，调用失败则表示未连接渲染器
             render.App();
         }
         catch (error) {
@@ -136,6 +136,18 @@ class ts3 {
             : `当前频道内共有${count}人`);
         return usePuppeteer ? renderList.join("") : renderList.join("\n");
     };
+    //关闭连接
+    quitTs = async () => {
+        if (this.teamspeak) {
+            this.teamspeak.quit();
+        }
+    };
+    //重新连接
+    reconnectTs = async () => {
+        if (this.teamspeak) {
+            this.teamspeak.reconnect(config().RECONNECT_TIMER, 1000);
+        }
+    };
 }
 const teamspeak3 = new ts3();
 teamspeak3.init();

package/lib/utils/config.d.ts

@@ -1,4 +1,6 @@
 import { Config } from "../../config/config/config.d";
+export declare const dir: string;
+export declare const dirConfig: string;
 /**
  * @description 配置文件
  */

package/lib/utils/config.js

@@ -1,7 +1,8 @@
 import { dirPath, basename } from "../utils/index.js";
 import { watch, logger, basePath, filesByExt, copyConfigSync, requireFileSync, } from "node-karin";
-const dir = `${basePath}/${basename}`;
-const dirConfig = `${dir}/config`;
+import teamspeak3 from "../apps/ts3.js";
+export const dir = `${basePath}/${basename}`;
+export const dirConfig = `${dir}/config`;
 const defDir = `${dirPath}/config`;
 const defConfig = `${defDir}/config`;
 /**
@@ -28,5 +29,6 @@ setTimeout(() => {
     list.forEach((file) => watch(file, (old, now) => {
         logger.info("旧数据:", old);
         logger.info("新数据:", now);
+        teamspeak3.init();
     }));
 }, 2000);

package/lib/web.config.d.ts

@@ -0,0 +1,12 @@
+import { Config } from "config/config/config";
+declare const _default: {
+    info: {};
+    /** 动态渲染的组件 */
+    components: () => (import("node-karin").InputProps | import("node-karin").InputGroupProps | import("node-karin").RadioGroupProps)[];
+    /** 前端点击保存之后调用的方法 */
+    save: (config: Config) => {
+        success: boolean;
+        message: string;
+    };
+};
+export default _default;

package/lib/web.config.js

@@ -0,0 +1,124 @@
+import { components, logger, writeJsonSync } from "node-karin";
+import { config, dirConfig } from "./utils/index.js";
+const defConfig = config();
+export default {
+    info: {
+    // 插件信息配置
+    },
+    /** 动态渲染的组件 */
+    components: () => [
+        components.input.string("HOST", {
+            label: "teamspeak 服务器地址(不带端口)",
+            defaultValue: defConfig.HOST,
+            variant: "underlined",
+            placeholder: "请输入服务器地址",
+            rules: [
+                {
+                    regex: /^((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.){3}(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])$/,
+                    error: "请输入正确的IP地址",
+                },
+            ],
+        }),
+        components.input.string("SERVER_NAME", {
+            label: "展示的服务器名(不填写则显示服务器地址)",
+            placeholder: "请输入展示的服务器名",
+            defaultValue: defConfig.SERVER_NAME,
+            variant: "underlined",
+            isRequired: false,
+        }),
+        components.radio.group("PROTOCOL", {
+            defaultValue: defConfig.PROTOCOL,
+            label: "teamspeak 服务器查询 (一般使用默认的RAW即可)",
+            size: "sm",
+            orientation: "horizontal",
+            radio: [
+                {
+                    componentType: "radio",
+                    key: "PROTOCOL_RAW",
+                    value: "RAW",
+                    label: "RAW",
+                },
+                {
+                    componentType: "radio",
+                    key: "PROTOCOL_SSH",
+                    value: "SSH",
+                    label: "SSH",
+                },
+            ],
+        }),
+        components.input.number("QUERY_PORT", {
+            label: "teamspeak 服务器查询端口 (一般使用默认 10011 即可)",
+            type: "number",
+            placeholder: "请输入服务器查询端口",
+            variant: "underlined",
+            defaultValue: defConfig.QUERY_PORT + "",
+            rules: [{ min: 1, max: 65535 }],
+        }),
+        components.input.number("SERVER_PORT", {
+            label: "teamspeak 服务器语音端口 (一般使用默认 9987 即可)",
+            defaultValue: defConfig.SERVER_PORT + "",
+            placeholder: "请输入服务器语音端口",
+            variant: "underlined",
+            rules: [{ min: 1, max: 65535 }],
+        }),
+        components.input.number("RECONNECT_TIMER", {
+            label: "teamspeak 连接断开后重连次数 (-1表示将不断尝试)",
+            defaultValue: defConfig.RECONNECT_TIMER + "",
+            placeholder: "请输入重连次数",
+            variant: "underlined",
+            rules: [{ min: -1 }],
+        }),
+        components.input.string("USERNAME", {
+            label: "teamspeak 管理员用户名 (建服时出现的,没修改时默认是 serveradmin )",
+            defaultValue: defConfig.USERNAME,
+            placeholder: "请输入管理员用户名",
+            variant: "underlined",
+        }),
+        components.input.string("PASSWORD", {
+            label: "teamspeak 管理员密码 (建服时出现的,每个服务器都不一样)",
+            defaultValue: defConfig.PASSWORD,
+            type: "password",
+            placeholder: "请输入管理员密码",
+            variant: "underlined",
+        }),
+        components.input.string("NICKNAME", {
+            label: "插件连接进服务器时使用的昵称 (默认为TSBOT,···客户端看不到该用户···) ",
+            placeholder: "请输入连接昵称",
+            defaultValue: defConfig.NICKNAME,
+            variant: "underlined",
+        }),
+        components.input.group("NOTICE_GROUP_NO", {
+            label: "通知用户进出ts3的群号 可多个",
+            template: {
+                componentType: "input",
+                key: "NOTICE_GROUP_NO",
+                type: "number",
+                variant: "faded",
+                placeholder: "请输入群号",
+            },
+            data: [...defConfig.NOTICE_GROUP_NO.map((i) => i + "")],
+        }),
+        components.input.group("DIS_NOTIFY_NAME_LIST", {
+            label: "不提醒的昵称列表 可多个 (不会提醒当前机器人，无需添加当前机器人昵称)",
+            template: {
+                componentType: "input",
+                key: "DIS_NOTIFY_NAME",
+                type: "text",
+                variant: "faded",
+                placeholder: "请输入昵称",
+            },
+            data: [...defConfig.DIS_NOTIFY_NAME_LIST],
+        }),
+    ],
+    /** 前端点击保存之后调用的方法 */
+    save: (config) => {
+        Object.assign(defConfig, config);
+        writeJsonSync(`${dirConfig}/config.json`, config);
+        logger.info("保存的配置:", config);
+        // 在这里处理保存逻辑
+        return {
+            success: true,
+            message: "保存成功",
+        };
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "karin-plugin-teamspeak",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "description": "karin 的 teamspeak3 插件",
   "homepage": "https://github.com/jacksixth/karin-plugin-teamspeak3",
   "bugs": {
@@ -29,6 +29,8 @@
     "static": [
       "resources"
     ],
+    "web": "./lib/web.config.js",
+    "ts-web": "./src/web.config.ts",
     "files": [
       "config",
       "data",
@@ -45,8 +47,8 @@
   "files": [
     "/lib/**/*.js",
     "/lib/**/*.d.ts",
-    "/config/*.json",
-    "/config/*.d.ts",
+    "/config/config/*.json",
+    "/config/config/*.d.ts",
     "resources",
     "LICENSE",
     "package.json",