summaryrefslogtreecommitdiff
path: root/README.md
blob: c180d32e7734fa62d32d85b721337094991be29a (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
![Preview](https://github.com/GhostNaN/mpvpaper/blob/assests/preview.png)
# MPVPaper
### MPVPaper is a wallpaper program for wlroots based wayland compositors, such as sway. That allows you to play videos with mpv as your wallpaper.

## Dependencies
- mpv
- wlroots

## Building 
### Building Requirements:

- ninja
- meson
- pkg-config
### Instructions:
Clone:
```
git clone --single-branch https://github.com/GhostNaN/mpvpaper
```
Build:
```
cd mpvpaper
meson build --prefix=/usr/local
ninja -C build
```
Install:
```
ninja -C build install
```
## Installers 
### Arch Based:
AUR package: https://aur.archlinux.org/packages/mpvpaper-git/

### Gentoo:
GURU package: https://gpo.zugaina.org/Overlays/guru/gui-apps/mpvpaper/

## Usage
### Running
Simple example:
```
mpvpaper DP-2 /path/to/video
```
You can also forward mpv options by passing "--mpv-options" or "-o" like so:
```
mpvpaper -o "no-audio --loop-playlist shuffle" HDMI-A-1 www.url/to/playlist
```
### Controlling
If MPVPaper is running in a terminal and is not forked:

Simply enter your keyboard key bindings directly into the terminal.

Else if you would like to control MPVPaper while it's forked, use a mpv input-ipc-server like this:
```
mpvpaper -o "input-ipc-server=/tmp/mpv-socket" DP-1 /path/to/video
```
Then input commands with socat. For example, toggle pause:
```
echo 'cycle pause' | socat - /tmp/mpv-socket
```
For more commands read: https://mpv.io/manual/master/#command-interface
## Notes
If you are on sway, you can get your display outputs with:
```
swaymsg -t get_outputs
```
And make sure you don't let swaybg stand in your way:
```
killall swaybg
```
## Acknowledgments
- glpaper for the initial boilerplate code, check em out here:
  - https://hg.sr.ht/~scoopta/glpaper
## License
This project is licensed under the GPLv3 License - see the [LICENSE](/LICENSE) file for details