aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 2e87d1043c068f6f4ed8e6ebaa84126f4d5b9ef5 (plain)
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
[![License: GPLv3+](https://archive.org/download/libreweb/license.svg)](https://www.gnu.org/licenses/gpl-3.0.txt)

# Livie is Video in Emacs

![screenshot](screenshot.png)

Livie allows the user to search youtube.com and play the video from `mpv`.

## Requirements

- `hypervideo`
- `curl`
- `mpv`

  `sudo pacman -S mpv hypervideo`

## Installation

``` emacs-lisp
(require 'livie "~/.emacs.d/path/to/livie.el")
(setq livie-script-path (expand-file-name "path/to/livie.py" user-emacs-directory))
```

## Installation in emacs-personal

Create new dir:

    mkdir ~/.emacs.d/private/

Clone repo:

    git clone https://git.sr.ht/~heckyel/livie ~/.emacs.d/private/livie

Open `settings.el` write the following:

``` emacs-lisp
(require 'livie "~/.emacs.d/private/livie/livie.el")
(setq livie-script-path (expand-file-name "private/livie/livie.py" user-emacs-directory))
```

## Usage
Just run `M-x livie` and enter a search query. `n`, `p` and `tab`
can be used to navigate the buffer.

| key               | binding                      |
|-------------------|------------------------------|
| <key>n</key>      | `next-line`                  |
| <key>p</key>      | `previous-line`              |
| <key>q</key>      | `livie-quit`                 |
| <key>s</key>      | `livie-search`               |
| <key>></key>      | `livie-search-next-page`     |
| <key><</key>      | `livie-search-previous-page` |
| <key>return</key> | `livie-watch-this-video`     |

Type `s` to enter another search. To watch a video, press `<enter>`.