✨ feat: 新增 Discord RPC

Author: imsyy

docs/.vitepress/config.ts

@@ -38,6 +38,10 @@ export default defineConfig({
           { text: "WebSocket API", link: "/socket" },
         ],
       },
+      {
+        text: "开发指南",
+        items: [{ text: "原生插件", link: "/native" }],
+      },
     ],
 
     outline: {

docs/native.md

@@ -0,0 +1,105 @@
+# 原生插件集成指南
+
+SPlayer 使用 Rust 编写的原生插件 (`smtc-for-splayer`) 来实现更深度的系统集成，目前主要包括：
+
+- **SMTC (System Media Transport Controls)**: Windows 系统原生的媒体控制支持（系统音量浮窗、锁屏控制、任务栏缩略图控制）。
+- **Discord RPC**: 支持在 Discord 状态中展示“正在播放”的歌曲信息。
+
+## 环境准备
+
+在开始开发或构建原生插件之前，您需要确保本地环境满足以下要求。
+
+### 1. 安装 Rust 工具链
+
+项目使用 Rust 编写，需要安装 Rust 编译器和 Cargo 包管理器。
+
+- 访问 [Rust 官网](https://www.rust-lang.org/tools/install) 下载 `rustup-init.exe` 并安装。
+- 安装完成后，在终端运行以下命令验证安装：
+  ```bash
+  rustc --version
+  cargo --version
+  ```
+
+### 2. 安装 C++ 构建工具 (Windows)
+
+Rust 在 Windows 上通常依赖 MSVC 工具链进行链接。
+
+- 安装 **Visual Studio Build Tools** (或者 Visual Studio Community)。
+- 在安装选项中，勾选 **"使用 C++ 的桌面开发" (Desktop development with C++)**。
+- 确保勾选了 **MSVC v14x ... C++ x64/x86 build tools** 和 **Windows 10/11 SDK**。
+
+### 3. 安装 Node.js 依赖
+
+项目使用 `@napi-rs/cli` 来构建 Node.js 扩展。通常在运行 `pnpm install` 时会自动安装所需的构建工具。
+
+---
+
+## 构建与安装
+
+项目内置了方便的脚本来处理原生插件的编译和集成。
+
+### 自动构建
+
+在项目根目录下运行以下命令，会自动编译 Rust 代码并将生成的 `.node` 文件移动到正确的位置：
+
+```bash
+pnpm build:native
+```
+
+此命令会执行以下操作：
+
+1.  调用 `script/build-native.mjs` 脚本。
+2.  进入 `native/smtc-for-splayer` 目录。
+3.  运行 `napi build --release` 进行优化的发布版编译。
+4.  生成的二进制文件会被放置在项目所需的位置，供 Electron 加载。
+
+### 手动构建 (调试用)
+
+如果您需要调试 Rust 代码，可以进入插件目录手动构建：
+
+```bash
+cd native/smtc-for-splayer
+pnpm build         # 构建 release 版本
+pnpm build:debug   # 构建 debug 版本
+```
+
+---
+
+## 常见问题排查
+
+### 1. `Error: The specified module could not be found`
+
+如果在启动 Electron 时遇到此错误，通常是因为：
+
+- **未编译插件**：请先运行 `pnpm build:native`。
+- **架构不匹配**：确保您的 Node.js/Electron 架构（通常是 x64）与 Rust 编译目标一致。
+
+### 2. `LINK : fatal error LNK1181: cannot open input file ...`
+
+这是缺少 Windows SDK 或 C++ 构建工具的典型错误。
+
+- 请检查 Visual Studio Build Tools 是否正确安装了 C++ 桌面开发组件。
+
+### 3. 插件功能未生效
+
+- **SMTC**: 仅在 Windows 10/11 上可用。请检查系统设置中的“系统 > 声音”或锁屏界面是否出现了媒体控件。
+- **Discord RPC**: 需要 Discord 客户端在后台运行。可以在设置中检查“显示 Discord 状态”开关是否开启。
+
+### 4. 日志查看
+
+原生插件的日志默认记录在应用数据目录下的 `logs/smtc/` 文件夹中。
+
+- 开发环境日志路径参考: `native/smtc-for-splayer/smtc-for-splayer.log` (取决于具体配置)
+- 生产环境：`%APPDATA%/SPlayer/logs/smtc/`
+
+---
+
+## 开发指南
+
+如果您希望贡献或修改原生插件代码，请参考以下结构：
+
+- **入口**: `native/smtc-for-splayer/src/lib.rs` (定义了导出给 JS 的函数)
+- **核心逻辑**:
+  - `smtc_core.rs`: SMTC 的核心实现，处理 Windows API 调用。
+  - `discord.rs`: Discord RPC 的连接与状态更新逻辑，包含重连机制和防抖处理。
+- **类型定义**: `native/smtc-for-splayer/index.d.ts` (自动生成，供 TypeScript 使用)

electron/main/ipc/ipc-smtc.ts

@@ -75,6 +75,33 @@ export default function initSmtcIpc() {
   registerSmtcHandler("smtc-update-play-mode", (mod, payload) => {
     mod.updatePlayMode(payload);
   });
+
+  // Discord - 开启
+  ipcMain.on("smtc-enable-discord", () => {
+    if (nativeSmtc) {
+      try {
+        nativeSmtc.enableDiscordRpc();
+      } catch (e) {
+        processLog.error("[SMTC] 启用 Discord RPC 失败", e);
+      }
+    }
+  });
+
+  // Discord - 关闭
+  ipcMain.on("smtc-disable-discord", () => {
+    if (nativeSmtc) {
+      try {
+        nativeSmtc.disableDiscordRpc();
+      } catch (e) {
+        processLog.error("[SMTC] 禁用 Discord RPC 失败", e);
+      }
+    }
+  });
+
+  // Discord - 更新配置
+  registerSmtcHandler("smtc-update-discord-config", (mod, payload) => {
+    mod.updateDiscordConfig(payload);
+  });
 }
 
 export function shutdownSmtc() {

native/smtc-for-splayer/src/discord.rs

@@ -14,8 +14,8 @@ use crate::model::{
     TimelinePayload,
 };
 
-const APP_ID: &str = "1427186361827594375";
-const NCM_ICON_ASSET_KEY: &str = "ncm_icon";
+const APP_ID: &str = "1454403710162698293";
+const NCM_ICON_ASSET_KEY: &str = "logo-icon";
 
 // 主要用来应对跳转进度的更新
 const TIMESTAMP_UPDATE_THRESHOLD_MS: i64 = 100;

public/icons/logo-icon-1024x1024.png

@@ -16,12 +16,16 @@
             <n-text class="name">API Key</n-text>
             <n-text class="tip" :depth="3">
               在
-              <n-a href="https://www.last.fm/zh/api/account/create" target="_blank">Last.fm 创建应用</n-a>
+              <n-a href="https://www.last.fm/zh/api/account/create" target="_blank">
+                Last.fm 创建应用
+              </n-a>
               获取，只有「程序名称」是必要的
             </n-text>
             <n-text class="tip" :depth="3">
               如果已经创建过，则可以在
-              <n-a href="https://www.last.fm/zh/api/accounts" target="_blank">Last.fm API 应用程序</n-a>
+              <n-a href="https://www.last.fm/zh/api/accounts" target="_blank">
+                Last.fm API 应用程序
+              </n-a>
               处查看
             </n-text>
           </div>
@@ -92,7 +96,51 @@
         </n-card>
       </n-collapse-transition>
     </div>
-
+    <div v-if="isElectron && isWin" class="set-list">
+      <n-h3 prefix="bar"> Discord RPC </n-h3>
+      <n-card class="set-item">
+        <div class="label">
+          <n-text class="name">启用 Discord RPC</n-text>
+          <n-text class="tip" :depth="3"> 在 Discord 状态中显示正在播放的歌曲 </n-text>
+        </div>
+        <n-switch
+          class="set"
+          v-model:value="settingStore.discordRpc.enabled"
+          :round="false"
+          @update:value="handleDiscordEnabledUpdate"
+        />
+      </n-card>
+      <n-collapse-transition :show="settingStore.discordRpc.enabled">
+        <n-card class="set-item">
+          <div class="label">
+            <n-text class="name">暂停时显示</n-text>
+            <n-text class="tip" :depth="3">暂停播放时是否保留 Discord 状态</n-text>
+          </div>
+          <n-switch
+            class="set"
+            v-model:value="settingStore.discordRpc.showWhenPaused"
+            :round="false"
+            @update:value="handleDiscordConfigUpdate"
+          />
+        </n-card>
+        <n-card class="set-item">
+          <div class="label">
+            <n-text class="name">显示模式</n-text>
+            <n-text class="tip" :depth="3">选择在 Discord 状态中展示的内容层级</n-text>
+          </div>
+          <n-select
+            class="set"
+            v-model:value="settingStore.discordRpc.displayMode"
+            :options="[
+              { label: '完整信息 (歌曲名/歌手)', value: 'details' },
+              { label: '仅歌曲名', value: 'name' },
+              { label: '仅播放状态', value: 'state' },
+            ]"
+            @update:value="handleDiscordConfigUpdate"
+          />
+        </n-card>
+      </n-collapse-transition>
+    </div>
     <div v-if="isElectron" class="set-list">
       <n-h3 prefix="bar"> WebSocket 配置 </n-h3>
       <n-card class="set-item">
@@ -143,7 +191,8 @@
 <script setup lang="ts">
 import { useSettingStore } from "@/stores";
 import { getAuthToken, getAuthUrl, getSession } from "@/api/lastfm";
-import { isElectron } from "@/utils/env";
+import { isElectron, isWin } from "@/utils/env";
+import { enableDiscordRpc, disableDiscordRpc, updateDiscordConfig } from "@/core/player/PlayerIpc";
 
 const settingStore = useSettingStore();
 
@@ -238,6 +287,25 @@ const disconnectLastfm = () => {
   });
 };
 
+// Discord RPC
+const handleDiscordEnabledUpdate = (val: boolean) => {
+  if (val) {
+    enableDiscordRpc();
+    // 启用时同步一次配置
+    handleDiscordConfigUpdate();
+  } else {
+    disableDiscordRpc();
+  }
+};
+
+const handleDiscordConfigUpdate = () => {
+  if (!settingStore.discordRpc.enabled) return;
+  updateDiscordConfig({
+    showWhenPaused: settingStore.discordRpc.showWhenPaused,
+    displayMode: settingStore.discordRpc.displayMode,
+  });
+};
+
 // 初始化 socket 配置
 const initSocketConfig = async () => {
   if (!isElectron) return;

src/components/Setting/ThirdSetting.vue

@@ -6,7 +6,13 @@ import { msToS } from "@/utils/time";
 import { type SmtcEvent } from "@native";
 import { usePlayerController } from "./PlayerController";
 import { SmtcEventType, PlaybackStatus } from "@/types/smtc";
-import { sendSmtcMetadata, sendSmtcTimeline, sendSmtcPlayState } from "./PlayerIpc";
+import {
+  sendSmtcMetadata,
+  sendSmtcTimeline,
+  sendSmtcPlayState,
+  enableDiscordRpc,
+  updateDiscordConfig,
+} from "./PlayerIpc";
 
 /**
  * 媒体会话管理器，负责控制媒体控件相关功能
@@ -65,6 +71,15 @@ class MediaSessionManager {
       });
 
       player.syncSmtcPlayMode();
+
+      // 初始化 Discord RPC
+      if (settingStore.discordRpc.enabled) {
+        enableDiscordRpc();
+        updateDiscordConfig({
+          showWhenPaused: settingStore.discordRpc.showWhenPaused,
+          displayMode: settingStore.discordRpc.displayMode,
+        });
+      }
       return;
     }
 

src/core/player/MediaSessionManager.ts

@@ -2,7 +2,7 @@ import { throttle } from "lodash-es";
 import { isElectron, isWin } from "@/utils/env";
 import { getPlaySongData } from "@/utils/format";
 import { type MetadataParam } from "@native";
-import { RepeatMode, PlaybackStatus } from "@/types/smtc";
+import { RepeatMode, PlaybackStatus, DiscordDisplayMode } from "@/types/smtc";
 
 /**
  * 发送播放状态
@@ -131,3 +131,39 @@ export const sendSmtcPlayMode = (isShuffling: boolean, repeatMode: RepeatMode) =
   if (isElectron && isWin)
     window.electron.ipcRenderer.send("smtc-update-play-mode", { isShuffling, repeatMode });
 };
+
+/**
+ * @description 启用 Discord RPC
+ */
+export const enableDiscordRpc = () => {
+  if (isElectron && isWin) window.electron.ipcRenderer.send("smtc-enable-discord");
+};
+
+/**
+ * @description 禁用 Discord RPC
+ */
+export const disableDiscordRpc = () => {
+  if (isElectron && isWin) window.electron.ipcRenderer.send("smtc-disable-discord");
+};
+
+/**
+ * @description 更新 Discord RPC 配置
+ * @param payload 配置信息
+ */
+export const updateDiscordConfig = (payload: {
+  showWhenPaused: boolean;
+  displayMode: "name" | "state" | "details";
+}) => {
+  if (isElectron && isWin) {
+    const modeMap: Record<string, DiscordDisplayMode> = {
+      name: DiscordDisplayMode.Name,
+      state: DiscordDisplayMode.State,
+      details: DiscordDisplayMode.Details,
+    };
+
+    window.electron.ipcRenderer.send("smtc-update-discord-config", {
+      showWhenPaused: payload.showWhenPaused,
+      displayMode: modeMap[payload.displayMode] ?? DiscordDisplayMode.Name,
+    });
+  }
+};

src/core/player/PlayerIpc.ts

@@ -274,6 +274,15 @@ export interface SettingState {
   progressLyricShow: boolean;
   /** 是否使用自定义字体输入 */
   useCustomFont: boolean;
+  /** Discord RPC 配置 */
+  discordRpc: {
+    /** 是否启用 Discord RPC */
+    enabled: boolean;
+    /** 暂停时显示 */
+    showWhenPaused: boolean;
+    /** 显示模式 */
+    displayMode: "name" | "state" | "details";
+  };
 }
 
 export const useSettingStore = defineStore("setting", {
@@ -417,6 +426,11 @@ export const useSettingStore = defineStore("setting", {
     playerFollowCoverColor: true,
     progressLyricShow: true,
     useCustomFont: false,
+    discordRpc: {
+      enabled: false,
+      showWhenPaused: true,
+      displayMode: "name",
+    },
   }),
   getters: {
     /**

src/stores/setting.ts

@@ -6,13 +6,17 @@ import type {
   TimelinePayload,
   PlayModePayload,
   SmtcEvent,
+  DiscordConfigPayload,
 } from "@native";
 
 export interface IpcChannelMap {
   "smtc-update-metadata": MetadataParam;
   "smtc-update-play-state": PlayStatePayload;
   "smtc-update-timeline": TimelinePayload;
   "smtc-update-play-mode": PlayModePayload;
+  "smtc-enable-discord": void;
+  "smtc-disable-discord": void;
+  "smtc-update-discord-config": DiscordConfigPayload;
 }
 
 declare global {