Black cat

🗒️ 功能

• 播放 Youtube 上的音樂
• 音量控制
• 可使用按鈕控制音樂
• 擁有 Nightcore 音效
• 全面使用斜線指令

💽 技術

• 使用 Node.js Addon API (NAPI)嵌入 C, C++程式碼來處理音訊
• 只有播放直播影片時才會啟用 FFmpeg 解碼器

📥 安裝

• 部屬到 Heroku

  1. 點擊上方的部屬到 Heroku 按鈕

  2. 就是這麼簡單！請繼續照著螢幕的指示操作！

• 在 Linux 上安裝

  1. 複製程式碼

  git clone https://github.com/blackcatbot/blackcat

  或是使用gh

  gh repo clone blackcatbot/blackcat

  2. 安裝所需套件

  npm install yarn -g #如果還沒有安裝Yarn
  yarn install
  
  sudo apt-get install cmake # Nightcore 引擎編譯時需要

  3. 填寫config.example.js並重新命名成config.js
  4. 啟動機器人

  yarn start

• 在 Windows 上安裝

  1. 複製程式碼

  git clone

  2. 安裝所需套件

  npm install yarn -g
  yarn install

  3. 安裝 MSVC 編譯器

  前往Visual Studio 官網下載頁面下載 Visual Studio 並安裝 "Desktop development with C++"

  4. 安裝 Cmake

  前往Cmake 官網下載頁面下載 Cmake

  5. 填寫config.example.js並重新命名成config.js

  6. 啟動機器人

  yarn start

• 使用已建立好的 Docker 映像檔

  1. 拉取 Docker 映像檔

  docker pull wolfyuan/blackcat

  2. 啟動機器人

  docker run -d -e TOKEN="機器人Token" \
    -e COOKIE="YouTube Cookie"
    -e DEV_GUILD="測試伺服器ID" \
    -e ENABLE_DEV="是否啟用開發者模式(true/false)" \
    -e ENABLE_API="是否啟用API(true/false)" \
    -e API_PORT="API埠號" \
    --name blackcat wolfyuan/blackcat

• 🐋 自行建立 Docker 映像檔

  1. 建立 Docker image

  docker build -t blackcat:latest .

  2. 啟動機器人

  docker run -d -e TOKEN="機器人Token" \
    -e COOKIE="YouTube Cookie"
    -e DEV_GUILD="測試伺服器ID" \
    -e ENABLE_DEV="是否啟用開發者模式(true/false)" \
    -e ENABLE_API="是否啟用API(true/false)" \
    -e API_PORT="API埠號" \
    --name blackcat blackcat:latest

⚙️ 設定檔

設定檔名稱	環境變數名稱	說明	屬性
token	TOKEN	Discord 機器人登入 Token	string
cookie	COOKIE	播放器在發送請求至 YouTube 時使用的 Cookie	string?
devGuild	DEV_GUILD	開發時使用的斜線指令伺服器	string?
enableDev	ENABLE_DEV	是否啟用開發模式	boolean
optimizeQuality	OPTIMIZE_QUALITY	是否啟用音樂優化模式(如果為true，將會停用音量及 nightcore 音效)	boolean
enableApi	ENABLE_API	是否啟用 API 伺服器	boolean
apiPort	PORT	API 伺服器監聽端口	number

🙏 貢獻者

名稱	內容
wolf-yuan-6115	創辦人/開發者/網頁設計
ItzMiracleOwO	聯合創辦人/貢獻者
KayXue	開發者

Black cat source code is licensed under Apache 2.0