Skip to content
A fancy TUI client for Google Play Music
Branch: master
Clone or download

README.md

TUIJam

A fancy TUI client for Google Play Music.

TUIJam seeks to make a simple, attractive, terminal-based interface to listening to music for Google Play Music All-Access subscribers.

asciicast

Dependencies

Installation

To install from source

git clone git@github.com:cfangmeier/tuijam.git
cd tuijam
python setup.py install --user

or from pypi

pip install --user tuijam

or from the AUR

yay -S tuijam  # mainline
yay -S tuijam-git # dev build

Configuration

When you first launch TUIJam, it checks for a config file in $HOME/.config/tuijam/config.yaml with the following content:

email: you@your-email.com
password: your-password
device_id: yourdeviceid

If this file doesn't exist, TUIJam will guide you through a first-time setup where you will need to supply your google music email, password, and (optionally) a separate password to encrypt your google credentials locally.

Note that if you have 2-factor setup on your Google account, you need to make an app-password for TUIJam.

Additional Configuration

  • persist_queue: (Default: True) Saves the current queue and reloads it when the app resumes
  • reverse_scrolling: (Default: False) Switches the direction of mouse scrolling

MPRIS Support

TUIJam supports a subset of the MPRIS spec to allow for external control via clients such as playerctl. Currently, the following behavior is supported:

  • Get current song metadata (Title/Album/Artist)
  • Get player status (Playing/Paused/Stopped)
  • Play/Pause current song
  • Next Song
  • Stop

If this causes problems for you, please feel free to create an issue, but this feature can also be disabled by placing the following line in your config file:

mpris_enabled: false

Youtube

From version 0.3.0, Youtube videos are included in search results. By default, no video is shown during playback, but this can be changed by adding the following line to the config file:

video: true

Last.fm Support

The player supports Last.fm scrobbling. To enable it, you need to run:

tuijam get_lastfm_token

API Key Management

Youtube and Last.fm integration uses api keys that are supplied by me. TUIJam queries them at runtime from a server that I maintain. If the server goes down, of if you would just prefer not to rely on it, you can specify your own keys in the config file. Keys are only queried if they are not present in the config file.

GOOGLE_DEVELOPER_KEY: "yourdeveloperkeyhere"
LASTFM_API_KEY: "yourapikeyhere"
LASTFM_API_SECRET: "yoursecrethere"

You can also run your own server using or adapting key_server_example.py and setting your config file to point to your server.

key_server: "https://my-tuijam-key-server.io"

Controls

  • ctrl-c quit
  • ctrl-p toggle play/pause
  • ctrl-k stop
  • ctrl-q add all songs in search result to queue
  • ctrl-n move to next song
  • ctrl-r view recently played songs
  • ctrl-w Clear the current queue
  • ctrl-s shuffle queued songs (Note: If this hangs, try running stty -ixon in your terminal and restarting tuijam)
  • ctrl-u Thumbs up the currently playing song
  • ctrl-d Thumbs down the currently playing song
  • > seek forward 10 seconds
  • < seek backwards 10 seconds
  • + volume up
  • - volume down
  • tab/shift-tab cycle focus through search/queue/input windows
  • \/ctrl-f move to search bar
  • In search window,
    • q Add selected song/album to queue
    • shift-q Add selected song/album to the top of queue (play next)
    • r Create radio station around selected song/album/artist and add 50 songs from it to queue
    • e view information about selected song/album/artist
    • backspace go back in search/expand history
  • In queue window,
    • u/shift-up move selected song up in queue
    • d/shift-down move selected song down in queue
    • shift-u/v/ctrl-up move selected song to the top in queue
    • shift-d/ctrl-down move selected song to the bottom in queue
    • delete/x remove selected song from queue
  • In input window,
    • Type search query and press enter. Results are shown in search window.
    • Enter an empty query to view the suggested "Listen Now" stations and albums.

Thanks

TUIJam was heavily inspired by the gpymusic project, and, of course, could not exists without the great gmusicapi.

This project is neither affiliated with nor endorsed by Google.

You can’t perform that action at this time.