tuner

command module
Version: v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Jan 7, 2021 License: GPL-2.0 Imports: 17 Imported by: 0

README

TUNER

Tuner search for YouTube videos to play in MPV.

Screenshot

Table of Contents

Features

  • Playlists
  • Lyrics
  • No "search rate limits" (Tuner doesn't use the youtube API)
  • Show album art (experimental)
  • SoundCloud search support
  • "I'm Feeling Lucky" (play the first result when ! is used as a prefix for the search query)

Compile

Tuner is a written in Go, so you will need to install the GoLang compiler. On Arch Linux, you should install the go package.

Dependencies

Before running Tuner you need to install MPV and youtube-dl.

On Arch Linux, the dependencies packages are mpv youtube-dl

Font Awesome 5 is also required to display the icons. You can also customize the icons in the icons/icons.go file.

Build

Clone the repository:

$ git clone https://github.com/Pauloo27/tuner.git && cd tuner

Install:

$ make install

Screenshots

Screenshot with MOTD Screenshot search Screenshot playing with CAVA

Album Art (experimental)

The option to show the song Album Art is disabled by default, here's how to enable it:

First install Überzug (on Arch Linux, install the ueberzug package)...

Then open Tuner and type /a in the search bar and restart your Terminal and Tuner.

MPRIS

In version v0.0.1, Tuner used mpris to comunicate with MPV. In newer version Tuner uses libmpv instead. You can enable mpris by running the command /mpris. The script file should be placed at ~/.config/mpv/scripts/mpris.so.

If you installed the package mpv-mpris-git from the AUR, you need to copy the file /usr/share/mpv/scripts/mpris.so to ~/.config/mpv/scripts/mpris.so.

Keybinds

TIP: You can see the keybinds inside Tuner by pressing ?.

  • Arrow Left: Seek 5 seconds back.
  • Arrow Right: Seek 5 seconds.
  • Ctrl C: Stop the player.
  • Space: Play/Pause song.
  • Arrow Down: Decrease the volume.
  • Arrow Up: Increase the volume.
  • ?: Toggle keybind list.
  • L: Toggle loop.
  • P: Toggle lyric.
  • W: Scroll lyric up.
  • S: Scroll lyric down.
  • U: Show video URL.
  • B: Save song to playlist and edit current playlist.
  • R: Shuffle playlist.
  • >: Next song in playlist.
  • <: Previous song in playlist.

Commands

There are a few commands you can type in the search bar:

  • /cache or /c: Toggle option to keep cache (default is false).
  • /album or /a: Toggle option to show album art (default is false).
  • /mpris or /m: Toggle option to load mpv-mpris (default is false).
  • /help or /h: List all commands.

Storage

Tuner data (cache and config) is stored at ~/.cache/tuner. Tuner doesn't keep the songs downloaded, the only cached data is the album art (if the feature is enabled) and the info of playlist entries.

License

GPL Logo

This project is licensed under GNU General Public License v2.0.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL