Categorygithub.com/treyson-grange/JukeTUI
repositorypackage
0.0.0-20250206204628-b321f7bebdcb
Repository: https://github.com/treyson-grange/juketui.git
Documentation: pkg.go.dev
Overview
Dependencies
24
Dependents
0

# README

JukeTUI

JukeTUI is a tangible user interface (TUI) that allows users to control Spotify, manage playback, monitor the queue, and view pixelated versions of their album covers through an intuitive jukebox system.

JukeTUI App Preview

Features:

  • Library: Browse your Spotify music library, including albums and playlists, and play your favorite tracks directly from the app.
  • Playback Bar: Effortlessly manage your music with controls to play, pause, skip tracks, and view what’s currently playing.
  • Visual Queue: Displays the next 5 tracks in your queue, so you always know what’s coming up.
  • Pixelated album covers: Your favorite album covers are displayed while music is playing, adding a retro touch to your listening experience.

Setup

JukeTUI requires the use of Spotify's API, and you will have to create your own "spotify app" on the Spotify dashboard for developers. This process isn't that bad. Details are discussed below

JukeTUI uses the Spotify Web API, which doesn't handle playback on its own. Therefore you will have to start your playback on a official spotify app, or a lightweight spotify app such as spotifyd. Once playback has started, you can change playback state, and change playlists/albums from JukeTUI.

Connecting to Spotify's API

JukeTUI is specifically a spotify app. Therefore you will need to follow the steps to create your own spotify application. Don't worry, it's easy! As long as you are subscribed to spotify premium that is.

  1. Go to the Spotify dashboard for developers
  2. You will need to "Create app" and follow the instructions there.
  3. In the settings of the new app, you will find a client ID and client secret
  4. Copy .env.example into .env and paste your client ID and client secret into the corresponding variables.
  5. You will then have to setup a Redirect URI. This is done in the app dashboard. click settings, Edit, and change the Redirect URIs and set it to http://localhost:8080/callback
  6. On run, you will be asked to grant spotify permissions.
  7. On return, you will be in the app, ready to go.

Setup your environment

.env

  • To set up your .env, copy .env.example into .env.
SPOTIFY_ID="{ From the developer dashboard }"
SPOTIFY_SECRET="{ From the developer dashboard }"
SPOTIFY_PREFERENCE="{ Either 'album' or 'playlist' }"
  • Spotify ID and Secret are for Spotify API auth
  • Spotify Preference will alter what is displayed in the library. Your saved albums or your saved playlists.

Use

To run JukeTUI, simply run go run ..

Keybinds

General

  • Quit: q

Library

  • Navigate Library: Up/Down arrows
  • Change Library page: Left/Right arrows
  • Play selected library item: Enter

Playback

  • Play/Pause: p
  • Skip: n
  • Toggle shuffle: s

Library Tabs

  • Albums: 1
  • Playlists: 1

Custom Keybinds

Custom keybinds for most major functionality is available through changes in your environment file.

For available keybinds, see .env.example