Skip to content

Latest commit

 

History

History
56 lines (47 loc) · 2.45 KB

README.md

File metadata and controls

56 lines (47 loc) · 2.45 KB
Raw

cmus-auto-lyrics

Curses based lyrics display and fetcher for cmus music player with auto scroll and tag support.

Features

  • Runs as daemon and connects to cmus-remote
  • Reads lyrics from tags if available
  • Tries to guess song artist and title from file name and path
  • Downloads lyrics from Genius (API token required)
  • Downloads lyrics from azlyrics if Genius API token is not provided
  • Automatically scrolls lyrics based on current position in song
  • Saves lyrics, artist and title to tags (optional)
  • Removes section headers from Genius lyrics (optional)
  • Manual scroll deactivates auto scroll for current song
  • Offline mode - forces only reading from tags

Usage

usage: cmus-auto-lyrics [-h] [-c] [-s] [-a] [-o] [-v] [token]

Curses based lyrics display and fetcher for cmus music player

arguments:
  token                Genius API token - if not provided, will use azlyrics

options:
  -h, --help           show this help message and exit
  -c, --clear-headers  clear section headers in lyrics
  -s, --save-tags      save lyrics, artist, and title tags, if lyrics tag is missing
  -a, --auto-scroll    automatically scroll lyrics based on current position in song
  -o, --offline        runs in offline mode, only reads lyrics from tags
  -v, --version        show program's version number and exit

Building

  1. Clone this repository: git clone https://github.com/mzivic7/cmus-auto-lyrics
  2. Install pipenv
  3. cd cmus-auto-lyrics
  4. Install requirements: pipenv install
  5. build: pipenv run python -m PyInstaller --noconfirm --onefile --windowed --clean --name "cmus-auto-lyrics" "main.py"

Installing

Copy built executable to system:
sudo cp dist/cmus-auto-lyrics /usr/local/sbin/

Launcher

Example launcher for cmus with cmus-auto-lyrics in single terminal with tmux, with enabled auto-scroll.
Launching in open terminal:

bash -c "tmux new-session -s cmus -d -x '$(tput cols)' -y '$(tput lines)' $'cmus'; tmux split -h -l40 $'cmus-auto-lyrics -a'; tmux select-pane -t 0; tmux attach -t cmus"

Launching with maximized gnome terminal (can be added as launcher):

gnome-terminal --window --maximize -- /bin/sh -c "tmux new-session -s cmus -d -x '$(tput cols)' -y '$(tput lines)' $'cmus'; tmux split -h -l40 $'cmus-auto-lyrics -a'; tmux select-pane -t 0; tmux attach -t cmus"

Note: change -l40 to number of columns that should be used by lyrics pane.