diff options
| author | GhostNaN <59353890+GhostNaN@users.noreply.github.com> | 2020-08-02 01:18:38 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-02 01:18:38 +0000 |
| commit | 6205c8d7b4643f6bf31fc4ba9abe592f87059403 (patch) | |
| tree | 579cd5a2160a178d6acd2786d622b4ac27af371b | |
| parent | d4bcc4842dbe9e3939acde51c0c004b7115ed0d9 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 44 |
1 files changed, 42 insertions, 2 deletions
@@ -1,2 +1,42 @@ -# mpvpaper -A fork of glpaper that plays videos using mpv, instead of rendering shaders. +# MPVPaper +### MPVPaper is a wallpaper program for wlroots based wayland compositors such as sway that allows you to ~~render glsl shaders~~ play videos with mpv as your wallpaper. +###### Or a fork of glpaper that plays videos using mpv, instead of rendering shaders. +## Dependencies +- mpv + +## Building +### Building Requirements: + +- ninja +- meson +- pkg-config + +``` +git clone https://github.com/GhostNaN/mpvpaper +cd mpvpaper +meson build +cd build +ninja +``` +## Installing +``` +sudo cp mpvpaper /usr/bin +``` +## Usage +Simple example: +``` +mpvpaper DP-2 /path/to/video +``` +You can also pass mpv options by passing "--mpv-options" or "-o" like so: +``` +mpvpaper -o "no-audio --loop shuffle" HDMI-A-1 www.url/to/video +``` +If you are on sway you can get your display outputs with: +``` +swaymsg -t get_outputs +``` +## Acknowledgments +- glpaper for the boilderplate 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 |