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

# Yeetube.el
[![builds.sr.ht status](https://builds.sr.ht/~thanosapollo/yeetube.el.svg)](https://builds.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 
- socat: control mpv *e.g pause/play*

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

## Contributing 

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