diff --git a/README.md b/README.md
index 229b2016..6c0664a5 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,14 @@
![GitHub top language](https://img.shields.io/github/languages/top/lwilletts/mpvc)
![GitHub lines of Code](https://sloc.xyz/github/lwilletts/mpvc/?category=code)
-# mpvc ๐ง
+# mpvc ๐ง [^install]
A terminal music player in POSIX sh(1) that interfaces mpv providing mpc(1) commands + extras.
Originally a fork of [lwillets/mpvc](https://github.com/lwilletts/mpvc) that evolved on its own, providing some extra goodies such as: improved CLI, TUI, FZF, WEB, EQ, & playing media from YouTube & streaming services.
Check the [Wiki](../../wiki), [LogBook](../../wiki#logbook) & [Casts](../../wiki#screencasts) for a detailed view of the extra features of this fork.
+Skip directly to [Installation](#Installation) to try mpvc!
+
mpvc-tui -T: running the mpvc TUI (click to view screenshot)
@@ -18,7 +20,7 @@ Check the [Wiki](../../wiki), [LogBook](../../wiki#logbook) & [Casts](../../wiki
mpvc-fzf -f: running with fzf to manage the playlist (click to view screenshot)
-
+
![mpvc-fzf screenshot](../../blob/master/docs/assets/mpvc-tui-arch.png)
@@ -26,9 +28,9 @@ Check the [Wiki](../../wiki), [LogBook](../../wiki#logbook) & [Casts](../../wiki
mpvc-tui -n: running with mpvc-fzf and desktop notifications on the upper-right corner (click to view screenshot)
![mpvc tui+fzf+notifications screenshot](../../blob/master/docs/assets/mpvc-tui-fzf.png)
-
+
-## Overview โถ๏ธ
+## Overview โถ๏ธ [^install]
[mpvc](../../) player functionality is provided by:
@@ -36,6 +38,7 @@ Check the [Wiki](../../wiki), [LogBook](../../wiki#logbook) & [Casts](../../wiki
- [extras/mpvc-tui](../../blob/master/extras/mpvc-tui): provides a console TUI, using mpvc underneath
- [extras/mpvc-fzf](../../blob/master/extras/mpvc-fzf): provides FZF integration to mpvc.
- [extras/mpvc-web](../../blob/master/extras/mpvc-web): a hack to remotely control mpvc from web (handy on mobile)
+- [extras/mpvc-now](../../blob/master/extras/mpvc-now): generates a URL to share the current playlist
- [extras/mpvc-mpris](../../blob/master/extras/mpvc-mpris): speaks MPRIS to control mpv player through key-bindings.
- [extras/mpvc-equalizer](../../blob/master/extras/mpvc-equalizer): provides a basic mpv equalizer for the CLI.
- [extras/mpvc-autostart](../../blob/master/extras/mpvc-autostart): automatic mpv start/stop based on presence.
@@ -52,7 +55,7 @@ Required:
- `socat`: is preferred due to the differing implementations of `netcat` across UNIXes.
- `awk`: a sane version of `awk` for the same reason (`gawk` works)
-Recommended extras:
+Recommended extras:
- `curl`
- `fzf`
@@ -72,6 +75,8 @@ Check for missing dependencies using `mpvc-installer check-reqs`.
- [Gentoo](#gentoo-mpvc)
- [Nix](#nix-mpvc)
+Installing is just a matter of fetching the scripts either via Git/Curl/etc., scripts can be used directly from the repo, the `mpvc-installer` bit is just there for easiness, to fetch & link them into your `BINDIR=~/bin/` by default,
+
### Manual
The easiest install method is just to run the [mpvc-installer](../../blob/master/extras/mpvc-installer) to install under `$HOME/bin`
@@ -83,11 +88,14 @@ curl -fsSL -o mpvc-installer https://github.com/lwilletts/mpvc/raw/master/extras
### Git
+Below is a **Quick Start** guide showcasing mpvc commands usage.
+
```sh
# fetch a local copy of the github repo
git clone https://github.com/lwilletts/mpvc/
# use extras/mpvc-installer: just copy/link to your $HOME/bin
(cd mpvc; extras/mpvc-installer link-user)
+ (cd mpvc; extras/mpvc-installer check-reqs)
# use mpvc-fzf to search and play youtube media
mpvc-fzf -p 'kupla mirage'
@@ -121,10 +129,10 @@ pacman -Sy mpv gawk curl socat fzf rlwrap jq libnotify
### BSD
-BSD (and pkg(1) based derivatives such as FreeBSD):
+BSD (and pkg(1) based derivatives as FreeBSD, see [FAQ](../../wiki/FAQ)):
```console
-pkg install -y mpv gawk curl socat fzf rlwrap jq libnotify
+pkg install -y mpv curl socat fzf rlwrap jq libnotify # gawk gsed
```
### MacOS
@@ -132,16 +140,16 @@ pkg install -y mpv gawk curl socat fzf rlwrap jq libnotify
MacOS (and brew(1) based derivatives see [FAQ](../../wiki/FAQ)):
```console
-brew install gawk socat fzf rlwrap jq gnu-sed yt-dlp # mpv curl libnotify
+brew install mpv curl socat fzf rlwrap jq libnotify yt-dlp # gawk gnu-sed
```
### Gentoo [mpvc](https://gitlab.com/xy2_/osman)
```console
emerge mpvc
-```
+```
-### Nix [mpvc](http://github.com/nixos/nixpkgs/tree/master/pkgs/applications/misc/mpvc)
+### Nix [mpvc](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/mp/mpvc/)
```console
nix-env -i mpvc
@@ -199,7 +207,7 @@ usage: mpvc-fzf -[01ab:cCd:efFg:G:hk:K:n:s:p:P:o:Or:lL:xv] args # @version v1.5
## Tricks
-There's some basic tricks in [Git](#git) to get you started.
+There's some basic tricks in [Git](#git) to get you started.
For more check the [LogBook](../../wiki#logbook).
This gives just a sneak peek on what's possible to manage mpv from the command-line, your best chances are to go play and have fun.
@@ -215,3 +223,6 @@ Like any piece of software, mpvc is not perfect:
all effort has been made to make mpvc as POSIX compliant as possible.
Check out the [Issue Tracker](../../issues) for further improvements to be made.
+
+[^install]: Skip directly to [Installation](#Installation) to try mpvc
+
diff --git a/docs/logbook.html b/docs/logbook.html
index 611e00aa..a43fe7de 100644
--- a/docs/logbook.html
+++ b/docs/logbook.html
@@ -91,6 +91,7 @@
Introducing mpvc-web: a mpvc-tui like hack for the web
alias mcI="mpvc chapter-list-full"
alias me="mpvc-equalizer"
alias mtt="mpvc-tui"
+ alias mtth="mpvc-tui -H"
alias mm="mpvc-mpris"
alias mw="mpvc-web"
alias mff="mpvc-fzf" # fzf on mpvc
@@ -405,7 +407,8 @@
Introducing mpvc-web: a mpvc-tui like hack for the web
alias mffo="mpvc-fzf -o" # fzf search and return first ytid URL
alias mffp="mpvc-fzf -p" # fzf search and add ytid URLs from Invidious
alias xargn="xargs -n1" # xargn mpvc cmd
- rseq() { seq "$@" | tac; } # rseq | xargn mpvc cmd
+ rseq() { seq "$@" | tac; } # rseq | xargn mpvc cmd
+ mffo1() { mpvc add $(mpvc-fzf -o "$@" | mpvc-fzf -1); }
@@ -542,20 +545,20 @@
On the security of mpvc-web, 17 Nov 2023
So, now the following alternatives are available, ordered from less to more secure:
- For local purposes, just run mpvc-web that defaults to `localhost` with: `mpvc-web`.
+ For local purposes, just run mpvc-web that defaults to `localhost` with: `mpvc-web`.
- If its safe running plain HTTP on the home LAN, then use: `MPVC_WEB_HOST=0 mpvc-web`.
+ If its safe running plain HTTP on the home LAN, then use: `MPVC_WEB_HOST=0 mpvc-web`.
- Otherwise, if its not safe for running plain HTTP on the LAN, then use:
- `MPVC_WEB_HOST=0 MPVC_WEB_SSL_ENABLE=1 mpvc-web` to require HTTPS.
+ Otherwise, if its not safe for running plain HTTP on the LAN, then use:
+ `MPVC_WEB_HOST=0 MPVC_WEB_SSL_ENABLE=1 mpvc-web` to require HTTPS.
- If additionally, the environment can get attacks from malicious users, then
- require the use of peer certificates, therefore, limiting access only to those
- clients/peers that have present valid `stunnel(1)` certificate with:
- `MPVC_WEB_HOST=0 MPVC_WEB_SSL_ENABLE=1 MPVC_WEB_SSL_VERIFY=2 mpvc-web`
+ If additionally, the environment can get attacks from malicious users, then
+ require the use of peer certificates, therefore, limiting access only to those
+ clients/peers that have present valid `stunnel(1)` certificate with:
+ `MPVC_WEB_HOST=0 MPVC_WEB_SSL_ENABLE=1 MPVC_WEB_SSL_VERIFY=2 mpvc-web`
@@ -645,7 +648,46 @@
Introducing mpvc-osd: interfacing mpvc with a 4x20 USB
mpvc-tui -S 'echo $(date +"T%H:%M") $(mpvc -f "[%status%] #%position%/%playlistlength% %time% %artist% - %title% - %path%")' 'false'
And this is how it looks:
-
+
+
+
+
+
+
Some notes on my current mpvc setup, 4 July 2024
+
+
+Some notes on my current mpvc setup, I've setled on having the following commands continuosly running on background: mpvc-tui, mpvc-web, mpvc-autostart, and mpvc-osd:
+
+
+
+ mpvc-tui: to manage from the CLI, with the -T option to get desktop notifications.
+
+
+ mpvc-web: to manage from the WEB, to access from any browser in the LAN.
+
+
+ mpvc-autostart: to automatically start/stop mpvc when a personal device is detected (LAN).
+
+
+ mpvc-osd: to have mpvc playing status updated on a USB LCD (see above entry)
+
+
+
+For the record, this is the list of commands currently running:
+
+
+
+Using mpvc-web, on a device with a HDMI display, opens news possibilities of displaying video media, that is beyond just acting as a jukebox for playing music.
+For setups where the mediacenter has a video display with X11 x2x(1) might come handy to send X11 input events from a ssh-client to control the remote mpv running on X11, an example invocation is:
+
+ssh -X $USER@$HOST x2x -west -to :0 # be sure to read x2x(1)
+
+
@@ -653,7 +695,7 @@
Introducing mpvc-osd: interfacing mpvc with a 4x20 USB
- Last-Modified: Sunday, 5 May 2024 by gmt4
+ Last-Modified: Thursday, 4 July 2024 by gmt4Powered by #HTML ๐งก ๐ ๐
diff --git a/docs/now/index.html b/docs/now/index.html
index a4a1f90c..2c04b9a3 100644
--- a/docs/now/index.html
+++ b/docs/now/index.html
@@ -68,6 +68,7 @@