/dizzay

dizzay (/ˈdɪːdʒeɪ/) is a command-line program that plays media from a plug.dj room in VLC or in Mplayer.

Primary LanguageJavaScriptMIT LicenseMIT

dizzay

dizzay (/ˈdɪːdʒeɪ/) is a command-line program that plays media from a plug.dj room in VLC or in Mplayer.

Installation - Usage - Dependencies - License

VLC

Installation

npm install --global dizzay

Usage

dizzay [options]

play music from a plug.dj room in VLC

Options:

  -h, --help                 output usage information
  -u, --user [email]         email address of your plug.dj account. (optional, for login)
  -p, --password [password]  password of your plug.dj account. (optional, for login)
  -r, --room <room>          room url or slug to join.
  -q, --quality [quality]    video quality for YouTube videos. (low|medium|high) [medium]
  -a, --audio-only           do not show videos.
  --vlc                      play songs in vlc.
  --mplayer                  play songs in mplayer.
  --now-playing              log the current playing song to standard output.
  --mplayer-args <args>      string of space-separated command-line arguments to pass to mplayer.
  --vlc-args <args>          string of space-separated command-line arguments to pass to vlc.

The --vlc and --mplayer flags determine which media player to use. If neither flags are given, VLC is used.

Examples:

  • dizzay --mplayer --now-playing tastycat
  • dizzay --vlc mrsuicidesheep-chillout
  • dizzay --now-playing --vlc loves-kpop

Dependencies

You need a supported media player in your $PATH to run Dizzay. On Linuxes, they can be installed through a command prompt using something like:

# apt-get on Debians/Ubuntus,
# but it should be similar for other distributions
apt-get install vlc     # for vlc
apt-get install mplayer # for mplayer

Building

The source code is written in ES6 and can be compiled using:

npm run build

License

MIT