orchid

command module
v0.0.0-...-deee9ad Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 3, 2018 License: MIT Imports: 16 Imported by: 0

README

orchid

“What does an orchid have to do with playing music? You sort of get tons of orchids in the jungle and they require very little water to live. You should name it after some musical instrument, but that's probably already taken.”

Very tiny MP3 player for my needs. Mostly an excuse for me to learn how to use termbox (after being inspired by Brandon Rhode's talk on terminal animations), as well as how to write my own UI loop. Start it up in a directory where there are MP3 files, and orchid will do the rest:

$ git clone https://github.com/eugene-eeo/orchid
$ cd orchid
$ make install
$ cd totally-legit-music
$ orchid -h

Ideally ran in a terminal with size 50x8; you could run it on something larger, but it doesn't respond to larger/smaller sizes. You'll need a terminal with true-colour support (see iTerm on OSX) for the album art to display properly.

prerequisites

Requires golang/dep and hajemoshi/oto so make sure you can follow the instructions (especially on Linux/FreeBSD).

screenshots

Screenshots are taken in iTerm with vertical and horizontal margin 15 and title-less windows. Font used is 14px Iosevka Term with the Twilight colour profile.

controls

  • r toggle repeat song/playlist
  • <left> / <right> to adjust volume
  • <space> pause/play
  • f find mode
    • <enter> confirm selection
    • <esc> cancel
  • s toggle shuffle mode
  • n next track
  • p prev track
  • q quit

future plans

  • Split it in to a client-server architecture (like mpd).
  • More customizable UI.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL