karin-plugin-teamspeak 1.10.2 → 1.11.4

package/README.md

@@ -1,54 +1,59 @@
-# karin-plugin-teamspeak3
-
-karin 下的 [teamspeak](https://www.teamspeak.com/zh-CN/) 插件，使用 ts 开发。
-需要搭配 [karin](https://karin.fun/) 使用。
-在用户进入离开 ts 服务器时在群里发送用户进出提示
-也会响应 QQ 群或私聊的 `人数` 命令发送当前服务器内有人在的频道的人数和进入时长
-
-# 使用方法
-
-1. 安装该插件
-   - `包管理器` 可以通过 `pnpm add karin-plugin-teamspeak@latest -w` 安装
-   - `使用编译产物` 可以 clone 该仓库的 build 分支 `git clone --depth=1 -b build https://github.com/jacksixth/karin-plugin-teamspeak3.git ./plugins/karin-plugin-teamspeak/`，然后通过运行 `pnpm install --filter=karin-plugin-teamspeak` 安装
-2. 运行 `npx karin .`
-3. 在 karin web 界面的插件页签中配置该插件
-4. 保存配置后查看命令行是否成功连接服务器
-
-# 功能
-
-1. 监听 ts 服务器用户进入离开事件，在配置的群聊里发送用户进出提示 如:`xxx进入ts`、`xxx离开ts`
-2. 在群聊或私聊发送`人数`时，发送当前服务器内有人在的频道的人数和进入时长 如：
-   ```
-   ====服务器名====
-   仅展示有人的频道
-   当前频道内共有4人
-   ======
-    聊天听歌等待区
-   - BOT (29005287:9)
-   - xxx (0:4)
-   ======
-    fps2
-   - xxx (0:31)
-   ======
-    fps3
-   - xxx (96:31)
-   ======
-   ```
-3. 可以通过调用接口 `/api/teamspeak/getAllUserList` 来获取当前服务器内所有频道内人数和进入时长包括没人在的频道，返回的数据格式为：
-
-```
-{
-  name: "配置内的服务器名或host",
-  res: {
-   频道1:[{
-      nickName:"xxx", //昵称
-      lastconnected: "YYYY-MM-DD HH:mm:ss", //上次连接进来的时间
-      connectTime:"", //已经连接的时间 - 单位分:秒
-   },{},...],
-   频道2:[{}],
-   频道3:[{}],
-   ...
-   },
-  count: "频道内总人数"
-}
-```
+# karin-plugin-teamspeak3
+
+karin 下的 [teamspeak](https://www.teamspeak.com/zh-CN/) 插件，使用 ts 开发。
+需要搭配 [karin](https://karin.fun/) 使用。
+在用户进入离开 ts 服务器时在群里发送用户进出提示
+也会响应 QQ 群或私聊的 `人数` 命令发送当前服务器内有人在的频道的人数和进入时长
+
+# 使用方法
+
+1. 安装该插件
+   - `包管理器` 可以通过 `pnpm add karin-plugin-teamspeak@latest -w` 安装
+   - `使用编译产物` 可以 clone 该仓库的 build 分支 `git clone --depth=1 -b build https://github.com/jacksixth/karin-plugin-teamspeak3.git ./plugins/karin-plugin-teamspeak/`，然后通过运行 `pnpm install --filter=karin-plugin-teamspeak` 安装
+2. 运行 `npx karin .`
+3. 在 karin web 界面的插件页签中配置该插件
+4. 保存配置后查看命令行是否成功连接服务器
+
+# 官BOT获取QQ群群号
+ - 官BOT无法使用正常的群号，需要使用获取到的群号，获取方法如下：
+   - 在需要主动发送消息的群聊中发送 `人数`，触发插件后，在命令行中会打印出该群的群号，复制即可
+   ![1782722127619](image/README/1782722127619.png)
+
+# 功能
+
+1. 监听 ts 服务器用户进入离开事件，在配置的群聊里发送用户进出提示 如:`xxx进入ts`、`xxx离开ts`
+2. 在群聊或私聊发送`人数`时，发送当前服务器内有人在的频道的人数和进入时长 如：
+   ```
+   ====服务器名====
+   仅展示有人的频道
+   当前频道内共有4人
+   ======
+    聊天听歌等待区
+   - BOT (29005287:9)
+   - xxx (0:4)
+   ======
+    fps2
+   - xxx (0:31)
+   ======
+    fps3
+   - xxx (96:31)
+   ======
+   ```
+3. 可以通过调用接口 `/api/teamspeak/getAllUserList` 来获取当前服务器内所有频道内人数和进入时长包括没人在的频道，返回的数据格式为：
+
+```
+{
+  name: "配置内的服务器名或host",
+  res: {
+   频道1:[{
+      nickName:"xxx", //昵称
+      lastconnected: "YYYY-MM-DD HH:mm:ss", //上次连接进来的时间
+      connectTime:"", //已经连接的时间 - 单位分:秒
+   },{},...],
+   频道2:[{}],
+   频道3:[{}],
+   ...
+   },
+  count: "频道内总人数"
+}
+```

package/config/config/config.d.ts

@@ -1,17 +1,17 @@
-// 定义 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 //展示的服务器名
-  ENABLE_CHANNEL_MOVE_NOTIFY: string //是否开启移动频道播报功能 ("true" | "false")
-}
+// 定义 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 //展示的服务器名
+  ENABLE_CHANNEL_MOVE_NOTIFY: string //是否开启移动频道播报功能 ("true" | "false")
+}

package/config/config/config.json

@@ -1,19 +1,19 @@
-{
-  "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",
-  "ENABLE_CHANNEL_MOVE_NOTIFY": "true"
+{
+  "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",
+  "ENABLE_CHANNEL_MOVE_NOTIFY": "true"
 }

package/package.json

@@ -1,67 +1,76 @@
-{
-  "name": "karin-plugin-teamspeak",
-  "version": "1.10.2",
-  "description": "karin 的 teamspeak 插件",
-  "homepage": "https://github.com/jacksixth/karin-plugin-teamspeak3",
-  "bugs": {
-    "url": "https://github.com/jacksixth/karin-plugin-teamspeak3/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/jacksixth/karin-plugin-teamspeak3.git"
-  },
-  "keywords": [
-    "karin-plugin",
-    "teamspeak",
-    "karin"
-  ],
-  "license": "GPL-3.0-only",
-  "author": "jack",
-  "type": "module",
-  "main": "lib/index.js",
-  "scripts": {
-    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
-    "pub": "npm publish --access public",
-    "clean": "npm lib/cli/pr.js clean",
-    "pr": "node lib/cli/pr.js"
-  },
-  "dependencies": {
-    "teamspeak.js": "^1.11.2"
-  },
-  "karin": {
-    "apps": [
-      "lib/apps"
-    ],
-    "static": [
-      "resources"
-    ],
-    "web": "./lib/web.config.js",
-    "ts-web": "./src/web.config.ts",
-    "files": [
-      "config",
-      "data",
-      "resources"
-    ],
-    "include": [
-      "src/**/*"
-    ],
-    "exclude": [
-      "lib/**/*",
-      "@karinjs/**/*"
-    ]
-  },
-  "files": [
-    "/lib/**/*.js",
-    "/lib/**/*.d.ts",
-    "/config/config/*.json",
-    "/config/config/*.d.ts",
-    "resources",
-    "LICENSE",
-    "package.json",
-    "README.md"
-  ],
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  }
+{
+  "name": "karin-plugin-teamspeak",
+  "version": "1.11.4",
+  "description": "karin 的 teamspeak 插件",
+  "homepage": "https://github.com/jacksixth/karin-plugin-teamspeak3",
+  "bugs": {
+    "url": "https://github.com/jacksixth/karin-plugin-teamspeak3/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jacksixth/karin-plugin-teamspeak3.git"
+  },
+  "keywords": [
+    "karin-plugin",
+    "teamspeak",
+    "karin"
+  ],
+  "license": "GPL-3.0-only",
+  "author": "jack",
+  "type": "module",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "pub": "npm publish --access public",
+    "clean": "npm lib/cli/pr.js clean",
+    "pr": "node lib/cli/pr.js"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.43",
+    "eslint": "^9.39.4",
+    "neostandard": "^0.11.9",
+    "node-karin": "latest",
+    "tsc-alias": "^1.8.17",
+    "tsx": "^3.14.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "ts3-nodejs-library": "^3.5.3"
+  },
+  "karin": {
+    "apps": [
+      "lib/apps"
+    ],
+    "static": [
+      "resources"
+    ],
+    "web": "./lib/web.config.js",
+    "ts-web": "./src/web.config.ts",
+    "files": [
+      "config",
+      "data",
+      "resources"
+    ],
+    "include": [
+      "src/**/*"
+    ],
+    "exclude": [
+      "lib/**/*",
+      "@karinjs/**/*"
+    ]
+  },
+  "files": [
+    "/lib/**/*.js",
+    "/lib/**/*.d.ts",
+    "/config/config/*.json",
+    "/config/config/*.d.ts",
+    "resources",
+    "LICENSE",
+    "package.json",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
 }

package/resources/template/ts3.html

@@ -1,64 +1,64 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-  <style>
-    body {
-      overflow: hidden;
-      width: 720px;
-      height: 720px;
-      background-size: cover;
-      background-repeat: no-repeat;
-    }
-
-    .main {
-      background: #ffffff;
-      min-width: 40%;
-      width: max-content;
-      max-width: 600px;
-      margin: auto;
-      border-radius: 5%;
-      padding: 12px;
-      padding-top: 0;
-      max-height: 720px;
-      transform: translate(0, 50%);
-    }
-
-    h1 {
-      text-align: center;
-      color: #673AB7;
-      margin-bottom: 6px;
-    }
-
-    .tips {
-      color: #9E9E9E;
-      font-size: 14px;
-      text-align: center;
-    }
-
-    .count {
-      text-align: center;
-    }
-
-    .main>ul {
-      padding: 0;
-      width: 40%;
-      margin: auto;
-      color: #FF9800;
-    }
-
-    li {
-      list-style-type: circle;
-      color: #3F51B5;
-      white-space: nowrap;
-    }
-  </style>
-</head>
-
-<body style="background-image: url('{{@bg}}');">
-  <div class="main">
-    {{@render}}
-  </div>
-</body>
-
+<!DOCTYPE html>
+<html>
+
+<head>
+  <style>
+    body {
+      overflow: hidden;
+      width: 720px;
+      height: 720px;
+      background-size: cover;
+      background-repeat: no-repeat;
+    }
+
+    .main {
+      background: #ffffff;
+      min-width: 40%;
+      width: max-content;
+      max-width: 600px;
+      margin: auto;
+      border-radius: 5%;
+      padding: 12px;
+      padding-top: 0;
+      max-height: 720px;
+      transform: translate(0, 50%);
+    }
+
+    h1 {
+      text-align: center;
+      color: #673AB7;
+      margin-bottom: 6px;
+    }
+
+    .tips {
+      color: #9E9E9E;
+      font-size: 14px;
+      text-align: center;
+    }
+
+    .count {
+      text-align: center;
+    }
+
+    .main>ul {
+      padding: 0;
+      width: 40%;
+      margin: auto;
+      color: #FF9800;
+    }
+
+    li {
+      list-style-type: circle;
+      color: #3F51B5;
+      white-space: nowrap;
+    }
+  </style>
+</head>
+
+<body style="background-image: url('{{@bg}}');">
+  <div class="main">
+    {{@render}}
+  </div>
+</body>
+
 </html>

package/lib/apps/command.d.ts

@@ -1,5 +0,0 @@
-/**
- * 渲染ts3服务器内存在用户的列表
- * 触发指令: 人数
- */
-export declare const image: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;

package/lib/apps/command.js

@@ -1,67 +0,0 @@
-import { dirPath } from "../utils/index.js";
-import { karin, render, common, segment, logger } from "node-karin";
-import teamspeak3 from "./ts3.js";
-const loggerPluginName = logger.chalk.hex("#90CAF9")(" ===== ts3 ===== ");
-/**
- * 渲染ts3服务器内存在用户的列表
- * 触发指令: 人数
- */
-export const image = karin.command(/^#?人数$/, async (e) => {
-    try {
-        //默认尝试使用渲染器，调用失败则表示未连接将使用文字形式发送服务器人数
-        let usePuppeteer = false;
-        // try {
-        //   render.App()
-        // } catch (error) {
-        //   usePuppeteer = false
-        // }
-        if (usePuppeteer) {
-            const filePath = common.absPath(dirPath + "/resources");
-            const bg = filePath + "/image/bg.png";
-            const html = filePath + "/template/ts3.html";
-            const list = await teamspeak3.getAllChannelList();
-            if (list) {
-                const img = await render.render({
-                    name: "ts3",
-                    file: html,
-                    data: {
-                        render: list,
-                        bg: bg,
-                    },
-                    pageGotoParams: {
-                        waitUntil: "networkidle2",
-                    },
-                });
-                await e.reply(segment.image("base64://" + img));
-            }
-            else {
-                await e.reply(segment.text("获取频道列表失败,可能是连接ts3服务器失败"));
-            }
-            return true;
-        }
-        else {
-            const list = await teamspeak3.getAllChannelList();
-            if (list) {
-                await e.reply(segment.text(list));
-            }
-            else {
-                await e.reply(segment.text("获取频道列表失败,可能是连接ts3服务器失败"));
-            }
-            return true;
-        }
-    }
-    catch (error) {
-        logger.error(loggerPluginName, error);
-        await e.reply(JSON.stringify(error));
-        return true;
-    }
-}, {
-    /** 插件优先级 */
-    priority: 9999,
-    /** 插件触发是否打印触发日志 */
-    log: true,
-    /** 插件名称 */
-    name: "显示ts服务器内人数",
-    /** 谁可以触发这个插件 'all' | 'master' | 'admin' | 'group.owner' | 'group.admin' */
-    permission: "all",
-});

package/lib/apps/ts3.d.ts

@@ -1,23 +0,0 @@
-import { Query } from "teamspeak.js";
-declare class ts3 {
-    teamspeak: undefined | Query;
-    connectTimer: number;
-    private isReConnecting;
-    init: () => Promise<void>;
-    getAllChannelList: () => Promise<string | undefined>;
-    quitTs: () => Promise<void>;
-    private handelReconnect;
-}
-declare const teamspeak3: ts3;
-export declare const getAllUserList: () => Promise<{
-    name: string;
-    res: {
-        [name: string]: {
-            nickName: string;
-            lastconnected: string;
-            connectTime: string;
-        }[];
-    };
-    count: number;
-} | null>;
-export default teamspeak3;