Skip to main content

Show time-synced lyric with BTT!

Project description

Synced Lyric on TouchBar

Codacy Badge Build Status Codacy Badge

Show synced lyric in the touch-bar with BetterTouchTool and NetEase APIs. Based on the idea of Kashi.

Preview

Minimal --minimal

Preview Preview

Full (default)

Preview Preview

Features

  1. Netease music web apis for synced lyrics;
  2. cachier to cache function calls and reduce the need to call webapis;
  3. Apple script for Spotify & iTunes/Music background track information;
  4. Support for English/Chinese(Simplified/Traditional);
  5. Support background color, font color, and font size.

Instruction

1. Denpendencies

First check your python version, which should be 3.6+. All commands should be executed in your terminal.

python3 --version

pip

curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py

You might want to restart your terminal.

pip3 install touchbar_lyric --upgrade

Python Path

Take a note for the python3 path. We will refer it as ${PYTHONPATH}

which python3

2. Configuration in BetterTouchTool

Same as Kashi:

  1. Copy&paste the content in lyric.json in Meun Bar > Touch Bar;
  2. Change the python path /Users/chenghaomou/Anaconda/bin/python to your own python path in the script area;
  3. Change any parameters as you like: fc(font color in RGB), bg(background color in RGB), and fs(font size)
${PYTHONPATH} -m touchbar_lyric --app Music

or use Spotify(default)

${PYTHONPATH} -m touchbar_lyric --app Spotify

Show Traditional Chinese lyrics

${PYTHONPATH} -m touchbar_lyric --app Spotify --traditional

You can also add --minimal flag at the end of the command to remove title and artists information.

中文指南

背景知识

  • 脚本运行需要 BTT + Python3.6+。
  • 仅支持系统自带的 Music 和 Spotify,推荐使用 Spotify。

Python 设置

  • 检查 macOS 系统自带的 Python3 ,在系统自带的 Terminal 应用中输入以下命令
which python3

*返回输出的路径信息后面会使用

  • 安装 pip
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py
  • 安装 touchbar-lyric
pip3 install touchbar_lyric --upgrade

BTT设置

  • 复制 lyric.json 里面的内容,在BTT的Touch Bar 配置界面直接粘贴
  • 在右侧脚本区域, 把 /Users/chenghaomou/Anaconda/bin/python 换成第一步中的路径
  • 可以在命令最后添加 --minimal 只显示歌词信息
  • 可以在命令最后添加 --traditional 显示繁体歌词信息
  • 在 Spotify/Music 运行时,应该出现歌词挂件
  • 可以更改参数 fc(RGB 字体颜色), bg(RGB 背景颜色), 和 fs(字体大小)

预览

歌词信息按照 [歌曲名/演唱者] 歌词 格式,具体效果如图所示:

极简模式 --minimal

Preview Preview

详细模式(默认)

Preview Preview

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

touchbar-lyric-0.3.8.tar.gz (10.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page