https://github.com/Parranoh/mpv-notify-send

A Lua script for mpv to send notifications with notify-send(1).
https://github.com/Parranoh/mpv-notify-send

libnotify mpv

Last synced: about 1 month ago
JSON representation

A Lua script for mpv to send notifications with notify-send(1).

• Host: GitHub
• URL: https://github.com/Parranoh/mpv-notify-send
• Owner: Parranoh
• License: wtfpl
• Created: 2020-01-22T21:49:33.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T07:36:08.000Z (5 months ago)
• Last Synced: 2024-10-07T19:03:55.237Z (3 months ago)
• Topics: libnotify, mpv
• Language: Lua
• Size: 940 KB
• Stars: 31
• Watchers: 4
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: COPYING.txt

Awesome Lists containing this project

• awesome-mpv - notify-send - A simpler and more recent notifications script for libnotify-compatible (i.e. Unix-like) notifications daemons only. Supports cover art. (Other)

README

        
===============

mpv-notify-send

===============

This is a simple Lua script for mpv_

that sends notifications about the playing media.

It uses ``notify-send(1)`` and should therefore work

with any libnotify-compatible notifications daemon.

It reports title, album and year if available,

and shows a cover image if present

in the same directory as the media file

(embedded images aren’t currently supported).

.. _mpv: https://mpv.io/

Screenshot

==========

.. image:: screenshot.jpg

    :alt:

      A screenshot of GNOME displaying a notification

      with title “Guilford Avenue Bridge”

      and body “Dan Deacon — America (2012)”

      as mpv plays the corresponding track.

    :width: 1125

    :height: 750

Usage

=====

Either copy/link ``notify-send.lua``

into ``$XDG_CONFIG_HOME/mpv/scripts``,

or set ``script=/path/to/notify-send.lua`` in ``mpv.conf``

or on the command line.

If you use `Nix(OS)`_ then you can install ``default.nix`` directly

or use the included ``overlay.nix`` in your ``configuration.nix``:

.. code:: nix

  { pkgs, ... }:

  {

    nixpkgs.overlays = [

      # ...

      (import /path/to/mpv-notify-send/overlay.nix)

    ];

    # ...

    environment.systemPackages = with pkgs; [

      # ...

      mpv

      mpv-notify-send

    ];

    environment.pathsToLink = ["/share/mpv"];

  }

You can then link ``/share/mpv/scripts/notify-send.lua``

(e.g. ``/run/current-system/sw/share/...`` on NixOS,

``$HOME/.nix-profile/share/...`` when using ``nix-env``)

into ``$XDG_CONFIG_HOME/mpv/scripts``.

.. _Nix(OS): https://nixos.org/

Licence

=======

mpv-notify-send is licensed under the WTFPL_.

.. _WTFPL: COPYING.txt