README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

# Yeetube.el
Tests: [![builds.sr.ht status](https://builds.sr.ht/~thanosapollo/yeetube.el.svg)](https://builds.sr.ht/~thanosapollo/yeetube.el?)

Repo: [![Sourcehut](https://img.shields.io/badge/Master-sourcehut-lightgrey.svg?logo=sourcehut)](https://sr.ht/~thanosapollo/yeetube.el)

Available via
[![MELPA](https://melpa.org/packages/yeetube-badge.svg)](https://melpa.org/#/yeetube)

## About 
- YouTube & Invidious Front-End for Emacs.

This package provides the ability to scrape YouTube or any Invidious
instance, with the results displayed in a read-only org-mode buffer.

Key features:
 - Search video query
 - Play video URL, *by default with MPV*
 - Save video URL with a custom name/label
 - Download video, *this package serves also as a front-end for
   yt-dlp, thus supporting platforms beyond YouTube/Invidious.*


## Installation 
You can install it via [MELPA](https://melpa.org/#/yeetube)

*Or directly from source*
- Download the latest tar-archive or clone the repo 

``` shell
git clone https://git.sr.ht/~thanosapollo/yeetube.el
```

- Load `yeetube.el`

``` emacs-lisp
(load-file "~/path/to/yeetube.el")
```


### Dependencies
- [mpv](https://mpv.io/): default multimedia player 
- [yt-dlp](https://github.com/yt-dlp/yt-dlp): download functionality 

*Debian/Ubuntu*
``` shell
sudo apt install mpv yt-dlp
```

### Configuration 
#### Media Player 
Changing `yeetube-player` example: 

``` emacs-lisp
(setq yeetube-player 'vlc)
```

You can also use [mpv.el](https://github.com/kljohann/mpv.el) or other
similar packages with yeetube by simple redefining `yeetube-play-url`
to something like this:

``` emacs-lisp
  (defun yeetube-play-url (url)
    "Open URL using mpv-play-url."
    (when (string-prefix-p "http" url)
      (mpv-play-url url)))
```

## Contributing 

- [Mailing list](https://lists.sr.ht/~thanosapollo/yeetube.el)
- [Tickets](https://todo.sr.ht/~thanosapollo/yeetube.el)