saopig1 bbdd4cbc78 fix(autopause): decouple auto-pause toggle from idle-timeout save [#81 review]
The checkbox @change was wired to saveIdleTimeout, which POSTed BOTH idleTimeoutMinutes
and autoPauseOnEmpty: toggling silently committed an unsaved idle edit, and an empty/
non-numeric idle field made the combined POST 400 (errors swallowed), leaving the
checkbox flipped but not persisted. Give the toggle its own saveAutoPause() sending only
the boolean; 保存 now sends only idleTimeoutMinutes.
2026-06-16 14:45:01 +08:00

TSMusicBot

TSMusicBot

TeamSpeak 音乐机器人 — 网易云音乐 + QQ 音乐 + 哔哩哔哩 + YouTube(可选),YesPlayMusic 风格 WebUI 控制面板

功能特性

  • WebUI 鉴权(必选) — 用户名 + 密码登录,多用户、两种角色(管理员 / 成员),bcrypt 加密、HttpOnly 会话 Cookie,CSRF 防护,WebSocket 同样鉴权。首次访问引导创建管理员。从无鉴权旧版本升级时请参阅 更新升级 章节
  • 多平台音源 — 网易云音乐 + QQ 音乐 + 哔哩哔哩(默认内置),YouTube 可选启用(通过 yt-dlp),统一搜索,结果标注来源
  • 真实客户端协议 (TS3/TS6 双协议) — 机器人在 TeamSpeak 中可见(非 ServerQuery 隐身模式),自动检测并适配 TS3 和 TS6 服务器,支持 TS6 HTTP Query API
  • YesPlayMusic 风格 WebUI — 精美界面,支持深色/浅色主题切换
  • 完整播放控制 — 播放/暂停/上一首/下一首/进度跳转/音量调节
  • 四种播放模式 — 顺序播放/循环播放/随机播放/随机循环
  • 实时歌词同步 — 歌词滚动显示,支持翻译歌词,服务端帧计数精确同步
  • 歌单管理 — 推荐歌单/我的歌单/每日推荐/私人FM,点击播放全部
  • 音质选择 — 标准(128k) / 较高(192k) / 极高(320k) / 无损(FLAC) / Hi-Res / 超清母带
  • B站视频音频提取 — 搜索B站视频,自动提取DASH最高码率音频流播放
  • B站热门推荐 — 首页展示B站热门视频和个性化推荐(登录后更准确)
  • QR码登录 — 扫码登录网易云/QQ音乐/哔哩哔哩账号,Cookie 自动持久化
  • 机器人形象自动更新 — 播放时自动更新头像(专辑封面)、昵称(当前歌曲)、描述、Away 状态、频道描述,停止时恢复默认值。每项功能独立可配置,权限不足时自动降级
  • 多机器人独立播放 — 多个机器人同时在不同服务器或频道播放不同音乐,每个机器人独立的播放队列、进度和音量,WebUI 一键切换控制
  • 播放历史 — 自动记录所有播放过的歌曲
  • 懒加载机制 — 歌单只存储元数据,播放时才获取链接(避免链接过期)
  • 一键部署 — FFmpeg 内置,Windows 双击运行 / Linux systemd / Docker

截图

musicbot1 musicbot2

快速开始

方式一:Windows 一键部署(最简单)

只需电脑有网络连接,其他一切自动安装。

1. 下载或 clone 本项目
2. 双击 scripts\setup.bat      (首次安装,自动安装 Node.js 和所有依赖)
3. 双击 scripts\start.bat      (启动机器人)
4. 浏览器打开 http://localhost:3000

setup.bat 会自动通过 winget 安装 Node.js(如果未安装),运行 npm install 安装所有依赖(包括内置 FFmpeg),最后构建项目。之后每次只需双击 start.bat 启动。

方式二:手动安装(所有系统)

前置条件: Node.js 20+ 和一个 TeamSpeak 服务器(TS3/TS5/TS6 均可)。 FFmpeg 已自动内置,无需手动安装。

# 下载项目
git clone https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
cd teamspeak-music-bot

# 安装依赖
npm install
cd web && npm install && cd ..

# 构建
npm run build

# 启动
npm start

打开浏览器访问 http://localhost:3000,按照设置向导完成配置。

方式三:Docker 一键部署

所有依赖已内置(Node.js、FFmpeg、Opus 编码器),无需安装任何额外软件。

git clone https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
cd teamspeak-music-bot/scripts/docker
docker-compose up -d

打开浏览器访问 http://localhost:3000

Docker 详细说明
  • 首次构建需要几分钟(编译原生模块)
  • 默认使用 host 网络模式,机器人可直接连接局域网 TS3 服务器
  • 数据持久化在 Docker 命名卷 tsmusicbot-data 中(数据库、Cookie、日志)
  • 内置健康检查(/api/health),支持 Docker 自动重启
docker logs -f tsmusicbot          # 查看日志
docker-compose down                # 停止
docker-compose up -d --build       # 代码更新后重新构建

如果 TS3 服务器在其他机器上,编辑 docker-compose.yml:

# 将 network_mode: host 替换为:
ports:
  - "3000:3000"

方式四:Linux 一键安装

chmod +x scripts/install.sh
sudo ./scripts/install.sh

自动安装 Node.js 和依赖,配置 systemd 服务,支持开机自启。

更新升级

⚠️ 从使用 @honeybbq/teamspeak-client 0.1.x 的旧版本升级时的重要变更

本项目已将底层 TeamSpeak 协议库升级到 0.2.x 并移除了内置的 TS6 兼容层,改用库自带的通用 clientinit 协议。这涉及一次数据库迁移:

旧的身份(identity)不兼容新的加密握手路径。 0.1.0 版本的库在生成 TS 客户端身份时存在 P-256 公钥 DER 编码错误,该 bug 在 0.1.1 中由本项目维护者 ZHANGTIANYAO1 修复并合并到上游。0.1.0 生成的身份与 0.2.x 修复后的握手路径不兼容:升级后用旧身份连接会卡在 received initivexpand2 直到 15 秒超时。

解决办法:升级后清空受影响机器人的 identity 字段,下次启动时程序会自动生成新身份并持久化。

# 对每个需要迁移的机器人执行(替换 <bot-id> 为实际 UUID):
python -c "import sqlite3; db=sqlite3.connect('data/tsmusicbot.db'); \
  db.execute(\"UPDATE bot_instances SET identity=NULL WHERE id='<bot-id>'\"); \
  db.commit()"

# 或者清空所有机器人的身份:
python -c "import sqlite3; db=sqlite3.connect('data/tsmusicbot.db'); \
  db.execute('UPDATE bot_instances SET identity=NULL'); db.commit()"

影响范围:

  • ✅ TS3 服务器 + 旧身份:在多数情况下仍可正常工作(TS3 对 legacy 编码更宽容),可选择不清空
  • ❌ TS6 服务器 + 旧身份:必须清空身份才能连接
  • ⚠️ 清空身份后,TS 服务器会把机器人识别为全新的客户端。之前手动赋予机器人的服务器组需要用新 UID 重新授予一次,之后每次重启都会自动保留

如何判断是否需要迁移:如果你是全新安装,或者你的机器人数据库中 identity 字段已经是空的,则无需任何操作。完成上述步骤后,按下面对应的系统升级步骤执行即可。

从 WebUI 无鉴权版本升级(重要)

本次更新引入了强制 WebUI 鉴权。从无鉴权旧版本升级后,WebUI 必须先创建管理员账号才能使用。所有 /api/* 端点(除少量公共白名单)和 /ws 现在都需要登录。

升级行为:

  • 启动时数据库自动迁移:新增 users、sessions、user_audit 三张表;旧的 bot_instances、play_history 数据完全保留。
  • 第一次打开 WebUI 自动跳转到 /first-run 引导创建首位管理员(角色固定为 admin)。
  • 之后访问任何页面都会校验登录态,未登录跳转 /login。

会话与 Cookie:

  • 登录态保存 7 天,每次请求滚动续期(活跃用户不会被踢出)。
  • 同一账号最多保持 10 个并发会话(超过自动剔除最旧的)。
  • Cookie 设置为 HttpOnly; SameSite=Lax,HTTPS 部署需配合 trustProxy: true(详见 反向代理部署注意事项)。

多用户与角色:

  • 角色 admin:完整权限(用户管理、审计、机器人、音乐平台、播放控制)。
  • 角色 member:除"用户管理"和"操作审计"外的所有功能(适合给团队成员开通播放权)。
  • 在 设置 → 用户管理(仅管理员)中添加 / 删除 / 重置密码 / 切换角色。
  • 至少保留一个管理员:系统会阻止删除或降级最后一位管理员。

如何重置忘记的管理员密码:

如果你忘记了管理员密码,可以直接编辑 SQLite 数据库 data/tsmusicbot.db:

# 方案 1:清空所有用户,重新进入 first-run 流程
sqlite3 data/tsmusicbot.db "DELETE FROM users; DELETE FROM sessions;"
# 然后重启机器人,浏览器再次访问会自动进入 /first-run

# 方案 2:把指定用户重置为已知密码(密码 'changeme-now' 的 bcrypt 哈希示例如下)
# 先用 node 生成哈希:
node -e "console.log(require('bcryptjs').hashSync('changeme-now', 12))"
# 把输出贴到 SQL 里:
sqlite3 data/tsmusicbot.db "UPDATE users SET passwordHash='<paste-hash-here>' WHERE username='你的用户名';"

反向代理用户特别注意:如果通过 nginx / Caddy / Cloudflare 暴露 WebUI,必须在 config.json 中设置 "trustProxy": true,否则 Cookie 不会带 Secure 标志,且登录限流会把所有用户合并到同一个桶。详见下方 反向代理部署注意事项。

旧版 config.adminPassword / adminGroups:这两个配置项在旧版本中预留但从未实际启用(TS-side admin 命令权限的占位字段)。保留以避免破坏旧 config.json,但不再影响任何行为。可以放心忽略。

Windows 用户

1. 双击 scripts\stop.bat 停止运行中的机器人(或手动关闭窗口)
2. 在项目目录打开命令行,执行 git pull
3. 双击 scripts\setup.bat 重新安装依赖并构建
4. 双击 scripts\start.bat 启动

手动安装用户(所有系统)

# 停止当前运行的机器人(Ctrl+C 或 kill 进程)

# 拉取最新代码
git pull

# 重新安装依赖(如有新增依赖)
npm install
cd web && npm install && cd ..

# 重新构建
npm run build

# 启动
npm start

Docker 用户

cd scripts/docker

# 拉取最新代码
git pull

# 重新构建并启动(数据自动保留)
docker-compose up -d --build

数据(数据库、Cookie、日志)保存在 Docker 命名卷 tsmusicbot-data 中,更新不会丢失。

Linux systemd 用户

# 停止服务
sudo systemctl stop tsmusicbot

# 拉取最新代码
git pull

# 重新安装依赖并构建
npm install
cd web && npm install && cd ..
npm run build

# 重新启动服务
sudo systemctl start tsmusicbot

提示: 更新不会影响你的 config.json 配置文件、数据库和登录 Cookie,所有数据会自动保留。但请注意本节开头关于 身份迁移 的警告——从 0.1.x 版本升级时需要手动清空旧身份。

使用说明

首次配置

  1. 启动机器人后打开 http://localhost:3000/
    • 全新部署:自动跳转 /first-run,填写用户名(3-32 字符)和密码(≥8 位)创建首位管理员账号
    • 之后所有 WebUI 操作都需要登录,登录态保持 7 天(活动会滚动续期)
  2. 在 设置 → 机器人管理 中点击"创建新实例",填写:
    • TeamSpeak 服务器地址(无端口,仅主机名,例如 ts.example.com)
    • 端口(默认 9987,自托管或非标准端口请填写实际值)
    • 机器人昵称
    • 可选:服务器密码、默认频道
  3. 在 设置 → 音乐账号 扫码登录网易云 / QQ 音乐 / B 站账号(可选,登录后可播放 VIP 歌曲)
  4. 在 设置 → 用户管理(仅管理员可见)按需添加成员,成员账号可以控制播放但无法管理其他用户

WebUI 页面说明

页面 功能
首页 推荐歌单、每日推荐、私人FM、我的歌单
搜索 三平台统一搜索,结果标注网易云/QQ/B站来源
歌单 查看歌单详情,播放全部(根据当前播放模式选择首歌)
歌词 全屏歌词页,实时同步滚动,模糊专辑封面背景
历史 播放历史记录
设置 账户(修改自己密码) / 主题切换 / 机器人管理 / 三平台账号登录 / 音质选择 / 命令前缀 / 用户管理(仅管理员)/ 操作审计(仅管理员)

TeamSpeak 文字命令

在 TeamSpeak 频道中发送文字消息控制机器人:

命令 说明
!play <歌名> 搜索并播放
!play -q <歌名> 从 QQ 音乐搜索
!play -b <关键词> 从哔哩哔哩搜索视频并播放音频
!play -y <关键词> 从 YouTube 搜索并播放(需要安装 yt-dlp)
!add <歌名> 添加到播放队列
!pause / !resume 暂停 / 恢复播放
!next / !prev 下一首 / 上一首
!stop 停止播放并清空队列
!vol <0-100> 设置音量
!queue 查看播放队列
!remove <位置> 从队列中删除指定位置的歌曲(位置从 1 开始,见 !queue)
!mode <seq|loop|random|rloop> 切换播放模式
!playlist <歌单名或ID> 加载歌单(支持名称模糊搜索和 ID)
!playlist -q <歌单名> 从 QQ 音乐搜索并加载歌单
!album <ID> 加载专辑
!artist <歌手名> 按歌手循环播放(支持 -q/-b/-y)
!fm 私人 FM(网易云,自动续播)
!lyrics 显示当前歌词
!now 当前播放信息
!vote 投票跳过当前歌曲
!move <频道名> 移动到指定频道
!help 显示帮助信息

命令前缀默认为 !,可在设置页面修改。支持别名:!p = !play,!s = !skip,!n = !next

音质等级

等级 码率 格式 说明
标准 128kbps MP3 免费可用
较高 192kbps MP3 免费可用
极高 320kbps MP3 默认选择
无损 ~900kbps FLAC 需要 VIP
Hi-Res ~1500kbps FLAC 需要 VIP
超清母带 ~4000kbps FLAC 需要黑胶 VIP

在设置页面选择音质,立即生效(影响后续播放的歌曲)。

项目架构

teamspeak-music-bot/
├── src/                        # 后端源码 (TypeScript)
│   ├── audio/                  # 音频管线:FFmpeg → PCM → Opus → 20ms 帧
│   │   ├── encoder.ts          # Opus 编码器 (@discordjs/opus)
│   │   ├── player.ts           # FFmpeg 播放器(内置 ffmpeg-static,帧计数进度追踪)
│   │   └── queue.ts            # 播放队列(4种模式,懒加载URL)
│   ├── bot/                    # 机器人核心
│   │   ├── commands.ts         # 文字命令解析器(前缀、别名、权限)
│   │   ├── instance.ts         # Bot 实例(绑定 TS3 + 播放器 + 音源)
│   │   ├── manager.ts          # 多实例生命周期管理
│   │   └── profile.ts          # 机器人形象管理(头像/昵称/描述/Away/频道描述)
│   ├── data/                   # 数据层
│   │   ├── config.ts           # JSON 配置文件
│   │   └── database.ts         # SQLite 数据库(播放历史、实例持久化)
│   ├── music/                  # 音源服务
│   │   ├── provider.ts         # 统一 MusicProvider 接口
│   │   ├── netease.ts          # 网易云音乐适配器
│   │   ├── qq.ts               # QQ 音乐适配器
│   │   ├── bilibili.ts         # 哔哩哔哩适配器(视频音频提取)
│   │   ├── youtube.ts          # YouTube 适配器(可选,依赖 yt-dlp)
│   │   ├── auth.ts             # Cookie 持久化存储
│   │   └── api-server.ts       # 嵌入式 API 服务(自动启动)
│   ├── ts-protocol/            # TeamSpeak 客户端协议(TS3/TS6 双协议)
│   │   ├── client.ts           # 完整客户端(ECDH + AES-EAX 加密协议)
│   │   ├── protocol-detect.ts  # 服务器协议自动检测(TS3 vs TS6)
│   │   ├── http-query.ts       # TS6 HTTP Query 客户端(替代 TS3 ServerQuery)
│   │   └── ts6-compat.ts       # TS6 兼容中间件(版本升级 + 签名)
│   ├── web/                    # Web 后端
│   │   ├── server.ts           # Express + WebSocket 服务
│   │   ├── websocket.ts        # 实时状态广播
│   │   └── api/                # REST API 路由
│   │       ├── bot.ts          # 机器人管理 CRUD
│   │       ├── music.ts        # 搜索/歌单/歌词/音质
│   │       ├── player.ts       # 播放控制/队列/历史/跳转
│   │       └── auth.ts         # QR登录/Cookie/SMS
│   └── index.ts                # 入口(启动所有服务)
├── web/src/                    # 前端源码 (Vue 3)
│   ├── components/             # Player, Navbar, Queue, CoverArt, SongCard
│   ├── views/                  # Home, Search, Playlist, Lyrics, History, Settings, Setup
│   ├── stores/                 # Pinia 状态管理(含服务端时间同步)
│   ├── composables/            # WebSocket 自动重连
│   └── styles/                 # SCSS 主题变量(深色/浅色)
├── scripts/                    # 部署脚本
│   ├── setup.bat               # Windows 首次安装
│   ├── start.bat               # Windows 启动脚本
│   ├── install.sh              # Linux 一键安装 + systemd 服务
│   └── docker/                 # Docker 部署文件
│       ├── Dockerfile
│       └── docker-compose.yml
├── data/                       # 运行时数据(自动创建,不上传)
│   ├── tsmusicbot.db           # SQLite 数据库
│   ├── cookies/                # 登录 Cookie
│   └── logs/                   # 日志文件
└── config.json                 # 配置文件(首次运行自动生成,不上传)

技术栈

层级 技术
运行时 Node.js 20+, TypeScript 5
后端框架 Express 4, WebSocket (ws)
数据库 better-sqlite3 (SQLite)
音频处理 FFmpeg (ffmpeg-static 内置), @discordjs/opus
TS 协议 @honeybbq/teamspeak-client(完整客户端协议)+ 自研 TS6 协议适配层
网易云 API NeteaseCloudMusicApi
QQ 音乐 API @sansenjian/qq-music-api
哔哩哔哩 BiliBili Web API(搜索、DASH 音频流、QR 登录)
前端框架 Vue 3, Vite 5, Pinia, Vue Router 4
界面样式 SCSS(YesPlayMusic 设计风格)
图标 @iconify/vue
日志 pino

可选:YouTube 音源

YouTube 是可选的音源,默认未启用,需要安装 yt-dlp 才能使用。启用后可通过聊天命令 !play -y <关键词> 或 WebUI 的 YouTube 平台选项搜索/播放 YouTube 视频的音频流。

启用方式(任选其一)

方式一:项目本地 bin/ 目录(推荐)

将 yt-dlp 可执行文件放到项目根目录下的 bin/ 文件夹,程序会优先使用此路径。该目录已被 .gitignore 忽略,不会影响代码更新。

# Windows(PowerShell 或 Git Bash)
mkdir bin
curl -L -o bin/yt-dlp.exe https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe

# Linux / macOS
mkdir -p bin
curl -L -o bin/yt-dlp https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp
chmod +x bin/yt-dlp

方式二:系统级安装(让 yt-dlp 在 PATH 中可用)

# Windows
winget install yt-dlp

# macOS
brew install yt-dlp

# Debian/Ubuntu
sudo apt install yt-dlp

# 通用(Python 环境下)
pip install -U yt-dlp

验证是否可用

重启机器人程序,在 WebUI 或 !play -y lofi 测试搜索。若 bin/ 和 PATH 中都找不到 yt-dlp,YouTube 搜索会静默返回空结果(不会影响其他音源),其余功能正常。

注意事项

  • YouTube 音源通过 yt-dlp 本地调用实现,不依赖 API Key,也无需登录
  • 播放的是视频的最佳音频流(bestaudio[ext=webm]/bestaudio[ext=m4a]/bestaudio),由 FFmpeg 解码
  • 音质由源视频决定,不受音质设置影响
  • 受 YouTube 风控/地域限制,部分视频可能无法播放
  • yt-dlp 更新较频繁,如果播放失败,先尝试升级 yt-dlp 到最新版本

配置文件

config.json 在首次运行时自动生成,可手动编辑:

{
  "webPort": 3000,
  "locale": "zh",
  "theme": "dark",
  "commandPrefix": "!",
  "commandAliases": { "p": "play", "s": "skip", "n": "next" },
  "neteaseApiPort": 3001,
  "qqMusicApiPort": 3200,
  "adminPassword": "",
  "adminGroups": [],
  "autoReturnDelay": 300,
  "autoPauseOnEmpty": true
}

关于 adminPassword 和 adminGroups:这两个字段保留是为了兼容旧 config.json,但当前版本未使用。WebUI 鉴权改为基于数据库的用户账号系统(见 首次配置),无需在 config.json 中设置密码。

反向代理部署注意事项

当 WebUI 部署在反向代理(nginx / Caddy / Cloudflare 等)之后时,请务必在 config.json 中设置 "trustProxy": true:

  • Cookie Secure 标志:未启用 trustProxy 时,Express 无法从 X-Forwarded-Proto 正确判断请求实际是否为 HTTPS,会话 cookie 不会被标记为 Secure。
  • 登录限流:登录限流以 req.ip 为键,未启用 trustProxy 时所有请求都会被识别为代理本身的 IP,单个攻击者会拖累所有合法用户共用同一个限流桶。
  • 审计日志的客户端 IP(如果未来添加该字段)也需要 trustProxy 才能正确记录。

直接暴露端口(无代理)时无需启用该选项。

常见问题

Q:支持 TeamSpeak 6 Server 吗? A:支持。本项目内置 TS3/TS6 双协议支持,连接时会自动检测服务器类型。如果自动检测失败(例如 Query 端口被防火墙屏蔽),可以在创建机器人时手动指定 serverProtocol: "ts6"。TS6 Server 的 HTTP Query API(端口 10080)也已适配,需要时可配置 ts6ApiKey。

Q:机器人连接了但 TeamSpeak 中听不到音乐? A:确保机器人和你在同一个频道。检查音量(!vol 75)。部分 VIP 歌曲需要先登录账号。

Q:提示"无法获取播放链接"? A:在设置页面扫码登录音乐账号。许多歌曲需要登录后才能播放。

Q:如何更换机器人所在频道? A:使用 !move <频道名> 命令,或在设置页面创建机器人时指定默认频道。

Q:可以同时运行多个机器人吗? A:可以。在设置页面创建多个实例,分别连接不同的 TS 服务器或频道。

Q:端口 3200 被占用? A:QQ 音乐 API 启动时自动监听 3200 端口。如果之前的进程还在运行,程序会自动复用。如需重启可手动结束 node 进程。

Q:播放歌曲时报 FFmpeg EACCES 错误? A:ffmpeg-static 内置的 FFmpeg 二进制文件缺少执行权限。程序已自动尝试修复,如果仍然失败,请手动执行:

chmod +x node_modules/ffmpeg-static/ffmpeg

或者确保系统已安装 FFmpeg(apt install ffmpeg / brew install ffmpeg),程序会自动回退使用系统版本。

Q:Docker 构建失败? A:原生模块(opus、sqlite3)需要编译工具,Dockerfile 已包含。确保 Docker 有足够内存(建议 2GB+)。

Q:B站视频搜索不到结果? A:B站搜索需要 buvid3 匿名 Cookie(程序启动时自动获取)。如果失败,重启程序即可。登录B站账号后搜索效果更好。

Q:YouTube 平台搜索返回空结果? A:YouTube 是可选音源,需要手动安装 yt-dlp。详见 可选:YouTube 音源 章节。快速验证:在项目根目录执行 bin/yt-dlp --version(或系统 yt-dlp --version),能打印版本号即可。若 yt-dlp 已安装但仍搜索失败,通常是网络/地域问题或 yt-dlp 版本过旧(执行 yt-dlp -U 升级)。

Q:如何更新到新版本? A:git pull 拉取最新代码,然后 npm install && npm run build && npm start 重新构建启动。Docker 用户执行 docker-compose up -d --build。

Q:忘记管理员密码怎么办? A:直接操作 SQLite 数据库。最简单的办法是清空 users 表然后重新进入 first-run 流程:sqlite3 data/tsmusicbot.db "DELETE FROM users; DELETE FROM sessions;",重启后浏览器会自动跳转 /first-run 让你重新创建管理员。详细方法见 从 WebUI 无鉴权版本升级。

Q:成员(member)能做什么?不能做什么? A:成员可以:管理机器人(启动/停止/创建/编辑)、控制播放(搜索/播放/队列)、登录音乐平台账号、修改自己的密码。成员不能:管理其他用户、查看操作审计日志、降级或删除管理员。

Q:如何把某个用户从成员升级为管理员? A:管理员登录后进入 设置 → 用户管理,点击对应用户的"提升管理员"按钮即可。降级同理("降为成员"按钮)。系统会阻止降级最后一位管理员。

Q:登录之后多久会自动退出? A:登录态有效期 7 天,活跃使用会滚动续期(每次受保护请求都会刷新过期时间)。同一账号最多保持 10 个并发会话(多设备登录时超过的会自动剔除最旧的会话)。

Q:部署到公网后如何防止暴力登录? A:本项目内置 /login 限流(每 IP 每分钟 5 次),但生产部署建议同时在反向代理(nginx limit_req / Caddy 等)层加一层限流,并启用 HTTPS。反向代理部署务必设置 "trustProxy": true(详见 反向代理部署注意事项)。

参与贡献

  1. Fork 本仓库
  2. 创建功能分支 (git checkout -b feature/新功能)
  3. 提交更改 (git commit -m 'feat: 添加新功能')
  4. 推送分支 (git push origin feature/新功能)
  5. 提交 Pull Request

更新日志

完整历史请查看 git log 或 Releases。这里只列出重要变更和面向用户的破坏性改动。

最新版本

WebUI 鉴权与权限系统

  • 首次运行强制创建管理员账号:浏览器打开 WebUI 自动跳转 /first-run;之后所有 /api/*(除少量公共白名单:/api/health、/api/config/public-url、/api/session/*)和 /ws 都需要登录。详见 更新升级 → 从 WebUI 无鉴权版本升级。
  • 两种角色:admin / member。member 可以管理机器人、控制播放、登录音乐平台账号、修改自己密码,但不能管理其他用户或查看审计日志。admin 拥有全部权限。
  • 用户管理 UI:管理员在 设置 → 用户管理 可以增删用户、切换角色、重置密码。系统强制保留至少一位管理员。
  • 操作审计日志:管理员在 设置 → 操作审计 可以查看用户管理相关事件(创建、删除、密码重置、角色变更、首位管理员创建、自助修改密码)。
  • 自助修改密码:所有用户都可在 设置 → 账户 修改自己密码。
  • 会话存储:服务端 SQLite 表 sessions,存储 sha256(token);浏览器只持有原始 token cookie。7 天 TTL,每小时滚动续期。同账号最多 10 个并发会话(超出剔除最旧)。
  • 登录限流:每 IP 每分钟 5 次 /login + 3 次 /setup,命中返回 429 + Retry-After。
  • CSRF & 安全头:所有 mutating 请求强制 Origin/Referer 同源;响应携带 X-Frame-Options: DENY 和 Content-Security-Policy: frame-ancestors 'none'(防点击劫持)。
  • 配置变更:反向代理部署务必 "trustProxy": true(详见 反向代理部署注意事项)。config.adminPassword / adminGroups 字段保留以兼容旧 config.json,但不再影响任何行为。

v0.x — Bot Profile 自动更新与协议层升级

机器人形象自动更新(Bot Profile)

  • 播放时自动更新 TS 形象:头像(专辑封面缩略图)、昵称(♪ 歌名 - 歌手 - 原昵称)、描述(歌曲信息)、Away 状态、频道描述、"正在播放"频道消息,全部随歌曲切换自动更新。
  • 停止播放时恢复默认:头像清除、昵称恢复、Away 显示"等待播放"、描述和频道描述清空。
  • 权限安全:每项功能独立检测权限,权限不足时自动禁用该功能(不影响其他功能和播放),重连后重试。
  • 独立可配置:6 项功能可通过 REST API(GET/PUT /api/player/:botId/profile)独立开关,配置持久化到数据库。
  • 竞争条件防护:generation 计数器防止快速切歌时旧头像覆盖新头像;UTF-8 字节长度截断中文昵称;文件传输操作带超时保护。
  • TS3 适配:描述通过 clientedit(非 clientupdate)设置,需要 b_client_modify_description 权限;昵称和 Away 通过合并的单条 clientupdate 避免命令队列超时。

新命令 & FM 修复

  • 新增 !artist <歌手名> 命令:搜索指定歌手的歌曲并循环播放,支持 -q(QQ 音乐)/ -b(B站)/ -y(YouTube)平台切换。一次加载最多 50 首,自动按歌手名过滤并设为 Loop 模式。
  • 歌单模糊搜索:!playlist 现在支持歌单名称模糊搜索(如 !playlist 华语经典),自动匹配公开歌单 + 个人歌单(网易云 + QQ)。纯数字 ID 和 URL 解析保持兼容。
  • 修复 !fm 播放中断:私人 FM 几首歌后静音的 bug 已修复。新增自动续播机制(队列低位自动拉取新歌),播放器健康帧追踪防止临时 URL 失败导致永久静音。
  • QQ 音乐个人歌单:QQ Music provider 新增 getUserPlaylists 支持,登录后可通过 !playlist -q <名称> 模糊搜索个人歌单。

协议层 & 稳定性

  • 升级 @honeybbq/teamspeak-client 到 0.2.1,移除内置 TS6 兼容层(ts6-compat.ts),改用库自带的通用 clientinit 协议(3.?.? [Build: 5680278000]),TS3/TS6 单一代码路径。
    • ⚠️ 破坏性:0.1.0 生成的旧身份与新握手路径不兼容,升级时需要迁移。详见 更新升级 章节顶部的警告。
  • 修复 startBot 与 stopBot 之间的竞态:mid-handshake 被替换的 BotInstance 不再泄漏 TS 会话,disconnect() 被 connect() 的 await 插队时不再错误地把 connected 翻回 true。
  • 修复播放条自动刷新 bug:BotManager 现在在创建新 BotInstance 时 emit botInstance 事件,WebSocket 监听器会立即重新挂接到新实例,播放状态变化无需手动刷新页面。
  • connect() 增加 15 秒超时:握手卡住时会清理掉挂起的实例并返回 500,不再无限阻塞 HTTP 请求和 UI。
  • 识别持久化修复:startBot 现在会从数据库读取 identity 传给新 BotInstance,服务器组在机器人重启后能保留。

HTTP API 加固

  • 新增输入校验,拒绝无效值并返回 400(之前会返回 200 包装 usage-text 字符串):
    • /volume:非数字、NaN/Infinity、超出 [0,100]
    • /mode:不在 {seq, loop, random, rloop} 中的值
    • /seek:NaN/Infinity、负数、字符串
    • /play-at:索引越界(先校验再停止当前播放,避免误杀正在播的歌)
  • 修复 YouTube 平台路由:/play、/add、/playlist、/play-by-id、/add-by-id、/play-playlist 现在都正确处理 platform=youtube(之前会静默回退到网易云)。
  • 修复 /auth/status?platform=youtube 数据泄漏:之前会回退到网易云并返回网易云用户的昵称 + 头像 URL,现在正确路由到 YouTube provider 并报告 yt-dlp 的实际可用状态。
  • /auth/cookie 拒绝 platform=youtube,防止意外覆盖网易云 cookie。

连接状态一致性

  • 断开连接时,音频命令(play/add/next/prev/playlist/album/fm)返回 400 "Bot is not connected to TeamSpeak";配置类命令(volume/mode/clear/stop/queue/now/lyrics)仍可正常工作,保持 UI 可用。
  • resolveAndPlay 在网络请求(URL 解析)前后都会检查 this.connected,防止在解析期间被 stop() 中断后仍然启动 ffmpeg。
  • tsClient 的 disconnected 事件处理器现在总是清理播放器状态,不再因为 connect() 从未完成而遗留 playing=true 的僵尸状态。

功能改进

  • YouTube 音源(可选):新增基于 yt-dlp 的 YouTube provider,通过 !play -y <关键词> 或 WebUI 平台选项使用。未安装 yt-dlp 时静默降级、返回空结果,不影响其他音源。详见 可选:YouTube 音源。
  • Bot Selector UI:
    • 始终可见(不再只有 ≥2 个机器人时才显示)
    • 尺寸放大(更大的按钮、字体、状态图标)
    • 每行增加 电源按键(一键启动/停止对应机器人,带禁用态与播放状态高亮)
    • 每行增加 链接按钮(复制机器人专属 URL)
    • 新路由 /bot/:id,打开后自动切换到对应机器人
  • 服务器密码登录:serverPassword 字段已加入数据库与 Settings UI,支持加入需要密码的 TS 服务器。
  • !add 一键开播:在连接状态下向空队列 !add 歌曲时自动开始播放(之前只会入队,需要再 !play 或 !next)。
  • WebSocket 新增 botRemoved 事件:删除机器人后 UI 会立即从列表中移除(之前需要手动刷新页面)。

内部修复

  • PlayQueue.remove() 当前歌曲移除 bug:移除正在播放的歌曲时,next() 不再跳过紧跟其后的那首歌。
  • 投票跳过:需要的票数现在至少为 1(避免 needed=0 时单人"全票通过"的边界情况);投票计数会在每首新歌开始时自动清零,不再跨歌曲泄漏。
  • 多处输入边界修复:seek 防止 NaN 毒化 seekOffset 导致 getElapsed() 永久返回 NaN;play-at 越界时不再误杀当前播放。

历史重要变更

更早的变更请查阅 git log。主要里程碑:

  • 初始 TS3/TS6 双协议支持:自动协议检测(TS3 port 10011 vs TS6 port 10080)、TS6 HTTP Query 客户端、数据库持久化 serverProtocol / ts6ApiKey。
  • 多机器人架构:支持同一进程中运行多个机器人实例,独立队列、进度、音量;WebUI 一键切换。
  • 网易云 / QQ 音乐 / 哔哩哔哩:三平台原生音源,QR 码登录,Cookie 持久化。
  • Docker & systemd 部署:一键部署脚本,数据卷持久化,自动重启支持。

致谢

感谢以下项目和开发者:

项目 说明
yichen11818/NeteaseTSBot TS6 协议兼容参考(vendored tsproto 补丁)
Splamy/TS3AudioBot 优秀的 TeamSpeak 音频机器人框架
TS3AudioBot-BiliBiliPlugin 提供插件开发参考
TS3AudioBot-NetEaseCloudmusic-plugin 提供插件开发参考和懒加载设计参考
TS3AudioBot-CloudMusic-plugin 提供插件开发参考
TS3AudioBot-Plugin-Netease-QQ 提供插件开发参考
YesPlayMusic UI 设计灵感
NeteaseCloudMusicApi 网易云音乐 API 项目
QQMusicApi QQ 音乐 API 项目
@sansenjian/qq-music-api QQ 音乐 API 活跃维护版本
@honeybbq/teamspeak-client TS3 完整客户端协议实现
bilibili-API-collect 哔哩哔哩 API 文档

开源许可

MIT

S
Description
No description provided
Readme MIT
2.2 MiB
0 Stars 1 Watchers 0 Forks
Languages
TypeScript 74.9%
Vue 15.2%
Python 3.9%
JavaScript 2.8%
SCSS 1.3%
Other 1.9%