summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGhostNaN <59353890+GhostNaN@users.noreply.github.com>2022-09-20 16:15:30 +0000
committerGitHub <noreply@github.com>2022-09-20 16:15:30 +0000
commitf5e036c03f077d4b2cb4fb0e566b3f34b321196a (patch)
tree940a9d293be68378ed5577d51d86191c4e95f51d
parent6b0f7a8b9a18e757dbcba44b9d34afe59a9094e2 (diff)
Update README.md
- Rename the title to mpvpaper as I didn't like the look glpaper title - Improve the build script - Remove the installers as there would be too many to list if I add more - Also because the AUR git is not ideal and the Gentoo one is not maintained - Modified the "Usage" to reflect more like the man page - Modified "Notes" to be less biased to Sway - Added swaybg to "Acknowledgments" because there's probably more code from swaybg than glpaper at this point
-rw-r--r--README.md53
1 files changed, 20 insertions, 33 deletions
diff --git a/README.md b/README.md
index c180d32..de418b4 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
![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.
+# 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
+- [mpv](https://github.com/mpv-player/mpv)
+- [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots)
## Building
### Building Requirements:
@@ -12,44 +12,33 @@
- ninja
- meson
- pkg-config
-### Instructions:
-Clone:
+### Clone | Build | Install:
```
+# Clone
git clone --single-branch https://github.com/GhostNaN/mpvpaper
-```
-Build:
-```
+# Build
cd mpvpaper
meson build --prefix=/usr/local
ninja -C build
-```
-Install:
-```
+# 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
```
+To play the same video on all outputs:
+```
+mpvpaper '*' /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.
+You can also control mpvpaper just like mpv in the terminal with keyboard bindings.
-Else if you would like to control MPVPaper while it's forked, use a mpv input-ipc-server like this:
+But if you would like to control mpvpaper while it's forked, you could use a mpv input-ipc-server like this:
```
mpvpaper -o "input-ipc-server=/tmp/mpv-socket" DP-1 /path/to/video
```
@@ -57,18 +46,16 @@ 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
+For more mpv 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:
+To see display outputs names, check the "not selected" error messages of:
```
-killall swaybg
+mpvpaper -v a a
```
+For more info on mpvpaper, please refer the the [man page](/mpvpaper.man).
## Acknowledgments
-- glpaper for the initial boilerplate code, check em out here:
+- glpaper and swaybg for the initial boilerplate code, check em out here:
- https://hg.sr.ht/~scoopta/glpaper
+ - https://github.com/swaywm/swaybg
## License
This project is licensed under the GPLv3 License - see the [LICENSE](/LICENSE) file for details