跳过主要内容
P

dsh-jukebox

puffdog-git/dsh-jukebox

音乐播放器与点歌来源。可直接播放本地音乐文件夹、YT Music 与 bilibili;可搜索 Spotify、KKBOX、Apple Music 并读取它们的链接,然后改播本地音乐库或 YouTube 上的同一首,或让同一台电脑上的官方播放器播放并实时转送声音。会登记成 dsh-discord-cyberfriend 插件的点歌来源。控制与转送官方播放器仅限 Windows,默认关闭。

安装

dsh plugin --profile web add github:puffdog-git/dsh-jukebox

README

dsh-jukebox(點唱機)

DSH 插件:一個音樂播放器,也可以當「Discord 賽博群友」的點歌來源。

各來源能做什麼

來源搜尋歌單/專輯在 DSH 播放、送進 Discord 語音房在官方播放器打開
本地音樂庫可以—直接播檔案—
YT Music可以公開歌單連結用 yt-dlp 直接播可以
bilibili可以(找影片)音頻區歌單、合集、系列、收藏夾連結用 yt-dlp 直接播影片的音訊與音頻區的單曲可以(開網頁)
Spotify可以(不用登入:桌面版開著時讀它自己的搜尋;登入後用官方接口)歌曲/專輯/歌單連結(不用登入);你自己的歌單要登入官方播放器即時轉送,或對應播放可以,可依歌名播放(桌面版開著就行,免費版也可以)
KKBOX可以(不填金鑰也行,一次一首)公開的分享歌單、專輯連結(需要金鑰)官方播放器即時轉送,或對應播放可以,可依歌名播放
Apple Music可以(不需要金鑰)專輯連結;歌單連結需要開發者權杖官方播放器即時轉送,或對應播放可以,可依歌名播放(需要訂閱)

對應播放:Spotify、KKBOX、Apple Music 的音訊有 DRM 保護,這個插件不取得、不解密它們的音訊。 它只用這些服務的歌曲資料(歌名、歌手、長度),再到你的本地音樂庫或 YouTube 找同一首來播。 介面會顯示實際播的是哪個版本與相似度;找不到夠像的版本時會直接說找不到,不會隨便播一首。

在官方播放器打開/遙控:請你電腦上的官方 App 播放。聲音只在這台電腦,不會進 Discord 語音房。 只有你在設定頁按按鈕才會動作,AI 與 Discord 都不能觸發。

控制官方播放器(只有 Windows):「官方播放器」分頁可以看各播放器的狀態,暫停、繼續、上下首;Spotify 與 KKBOX 可以直接依歌名播放。各播放器能做到的程度不同:

播放器依歌名播放暫停/繼續/上下首
Spotify這台電腦的 Spotify 開著:讀它自己的搜尋結果找歌、用它自己的播放連結播(實測免費版、不登入都可用,全程在背景)。沒開:官方接口遙控別的裝置(需要登入與 Premium)系統媒體控制;沒開時用官方接口
KKBOX用它自己的播放連結系統媒體控制;還沒播過時用媒體鍵
Apple Music自動操作它的視窗(搜尋 → 那一首 → 選單的「播放」),約 5~8 秒;需要有訂閱(實測可用)系統媒體控制

媒體鍵和鍵盤上的一樣,由系統決定哪個播放器收到;同時開著好幾個播放器時可能控制到別的。 叫播放器播歌時它的視窗可能會跳到最前面;點唱機會記下你原本在用的視窗,做完把焦點還回去(中間可能閃一下)。 開啟「讓 DSH 對話裡的 AI 可以控制官方播放器」後,AI 會多三個工具與一個教它怎麼用的技能。

播放方式的優先順序:有人指定某個平台的歌時,點唱機照你排的順序找能用的方式:用官方播放器播放並即時轉送(Spotify、KKBOX、Apple Music)→ 平台自己可下載的音訊 → 到 YouTube 找同一首 → 在本地音樂庫找同一首。可以調整先後或停用其中幾種。

擷取官方播放器的聲音(即時轉送):只有 Windows,預設關閉。開啟後,點唱機會把 Spotify、KKBOX、Apple Music 官方播放器正在播的聲音即時轉送到 Discord 語音房。

  • 只擷取這幾個播放器程式(用 Windows 內建的單一程式音訊擷取),不擷取整台電腦的聲音,也不擷取麥克風。這不是解密,擷取的是播放器已經播出來的聲音。
  • 可以讓播放器在轉送期間於本機幾乎聽不到:不需要虛擬音效裝置,做法是暫時把它在音量混音器的音量調到千分之一,結束時還原。
  • 是即時的:歌多長就播多久,同時只能轉送到一個語音房;你的電腦要開著播放器。
  • 擷取工具是一個小的 C# 程式(原始碼在 lib/capture/ProcessLoopback.cs),第一次使用時用 Windows 內建的編譯器編譯到資料夾的 bin/。
  • 這些服務的使用條款都不允許把串流內容轉播給其他人。 風險由帳號擁有人承擔,建議只在自己的私人小群使用。

安裝

dsh plugin --profile web add dsh-jukebox

也可以直接從 GitHub 安裝:

dsh plugin --profile web add github:puffdog-git/dsh-jukebox

需要:

  • yt-dlp(YT Music、bilibili 與對應播放都靠它)。插件不附送,會依序找:設定裡填的路徑 → ~/.dsh/bin/yt-dlp → 系統路徑。 有裝「Discord 賽博群友」的話,它下載的 yt-dlp 會被自動找到。
  • FFmpeg(選用)。只有本地音樂檔超過 64 MiB、又要送進 Discord 時才用來轉檔。

設定

「設定 → 點唱機」有四個分頁:

  • 播放:選來源找歌、貼連結、播放佇列。
  • 音樂庫:加入音樂資料夾(完整路徑)→ 儲存 → 掃描。只讀取,不改動你的檔案。
  • 來源帳號:
    • Spotify:到 developer.spotify.com 建立 App,把頁面上顯示的 Redirect URI 加進去,貼上 Client ID 後按「登入 Spotify」。不需要 Client Secret。
    • KKBOX:到 developer.kkbox.com 建立應用程式,填 Client ID 與 Client Secret。
    • Apple Music:搜尋不需要任何設定。讀歌單連結才需要 Team ID、Key ID 與 .p8 私鑰。
  • Discord 與設定:是否登記到 Discord、對應播放的順序、地區、快取大小等。

金鑰與登入權杖在 Windows 上用 DPAPI 加密保存;其他系統只留在記憶體。任何接口都不會回傳金鑰內容。

接上 Discord 賽博群友

兩個插件都啟用時,點唱機會自動把啟用中的來源登記成 Discord 的音樂來源:

plugin:jukebox-local、plugin:jukebox-ytmusic、plugin:jukebox-bilibili、plugin:jukebox-spotify、plugin:jukebox-kkbox、plugin:jukebox-apple

誰可以點歌、能進哪些語音房,仍然由 Discord 插件自己的設定決定。Discord 那邊的限制是每首歌 120 秒內載入完成、最多 64 MiB。

給 AI 的工具

兩個唯讀工具:jukebox_search(找歌)、jukebox_read_link(讀連結裡的歌曲清單)。使用者開啟播放器控制後另有 jukebox_player_status、jukebox_player_play、jukebox_player_control。AI 不能登入、改設定或讀金鑰。

資料位置

<DSH_HOME 或 ~/.dsh>/data/dsh-jukebox:設定、音樂庫索引、對應結果、YouTube 音訊快取(有大小上限,超過會刪最久沒播的)。

已知限制

  • 對應播放可能對到不同版本(例如重新錄音版)。
  • YouTube 與 bilibili 上超過 30 分鐘的影片與直播不播。
  • bilibili:需要登入或大會員的內容播不了;多分 P 的影片只播第一段;音頻區沒有可用的搜尋(官方接口固定回空結果),搜尋找的是影片。清單一次最多讀 30 支。查詢太頻繁時 bilibili 會暫時擋下請求,這時點唱機會停五分鐘不再送出查詢。對應播放只會找本地音樂庫與 YouTube,不會找 bilibili。
  • Spotify 的開發者 App 目前要求擁有者是 Premium 帳號;用官方接口遙控別的裝置也需要 Premium(叫這台電腦的 Spotify 播放不需要)。
  • KKBOX 的開放接口讀不到個人收藏。

授權

MIT

相关插件