Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 2.96 KB

README.md

File metadata and controls

109 lines (81 loc) · 2.96 KB
Raw

Ektoplayer

Ektoplayer is a commandline client for ektoplazm.com, a website where you can listen and download freely licensed psytrance, techno and downtempo music.

It allows you to

  • Search for tracks by tags (artist, album, style, ...)
  • Play tracks located at ektoplazm.com
  • Display information about albums
  • Download whole albums as mp3

Features

  • Mouse support
  • Vi-like keybindings (hjkl, ^d, ^u, /, ?, n, N, ...)
  • Up to 256 colors are supported
  • Local sound file cache
  • Song prefetching

Screenshots

Screenshot 2017-03-20 Screenshot 2017-03-20 Screenshot 2017-03-20 Screenshot 2017-03-20

Requirements

  • Ruby (1.9)
  • Mpg123 (1.14)
  • Sqlite3
  • One of the following ncurses gems: curses, ffi-ncurses, ncurses, ncuresw

Optional Requirements

  • For extracting album archives either unzip, 7z or the Gem RubyZip is needed

Installation

Note: Running ruby gems requires to change the $PATH variable. See output of gem env gempath.

Arch Linux

  • Using yaourt:

    yaourt -S ektoplayer

  • Using makepkg:

    git clone https://github.com/braph/ektoplayer
cd ektoplayer
makepkg
sudo pacman -U ektoplayer-*.pkg.tar.xz

  • Using gem:

    pacman -S --needed ruby mpg123 sqlite3 ncurses
gem install ektoplayer

Debian (*)

  • Using gem: 
    apt-get install ruby ruby-dev libz libz-dev ruby-ncurses ruby-nokogiri ruby-sqlite3 \
                mpg123 sqlite3 libncurses5
gem install ektoplayer

OpenSuse (*)

  • Using gem: 
    zypper in ruby ruby-devel gcc sqlite3 sqlite3-devel ncurses ncurses-devel zlib zlib-devel \
          mpg123 
gem install ektoplayer ffi-curses

Ubuntu (*)

  • Using gem: 
    apt-get install ruby ruby-dev sqlite3 ruby-sqlite3 ruby-nokogiri ruby-ncurses mpg123
gem install ektoplayer

(*) Not tested yet

Configuration

Ektoplayer keeps it's default configuration file under ~/.config/ektoplayer/ektoplayer.rc.

Available configuration commands:

  • set <option> <value>
  • bind <window> <key> <command>
  • undbind <window> <key>
  • unbind_all
  • color <name> <fg> [<bg> [<attribute> ...]]
  • color_mono <name> <fg> [<bg> [<attribute> ...]]
  • color_256 <name> <fg> [<bg> [<attribute> ...]]

See ektoplayer.rc for a configuration file with the default values.

Authors

See also