jonniek / mpv-playlistmanager

Mpv lua script to create and manage playlists
The Unlicense
559 stars 42 forks source link
lua mpv mpv-script playlist script

Mpv-Playlistmanager

Mpv lua script to create and manage playlists.

This script allows you to see and interact with your playlist in an intuitive way. The key features are removing, reordering and playing files. Additional features include resolving url titles, stripping filenames according to patterns and creating/saving/shuffling/sorting playlists.


Default visual cues(might render differently on browsers):
○ default file
▷ playing file
● hovered file(for removing, playing and moving)
▶ playing and hovered file
➔ selected file(file is being moved)
➤ playing and selected file
It will make sense once you try the script!

Installation

Copy the playlistmanager.lua file to your mpv scripts directory which is usually ~/.config/mpv/scripts/ or %APPDATA%/mpv/scripts/. See https://mpv.io/manual/master/#files and https://mpv.io/manual/master/#script-location for more detailed information.

Settings

You can modify behaviour of the script in the settings variable in the lua file or a playlistmanager.conf lua-setting file in script-opts directory. Note: the conf file will override any changed setting in the lua file. There is a playlistmanager.conf file in this repo with the default values of the script for reference.

You can pass settings from the command line on startup such as mpv --idle=once --script-opts=playlistmanager-loadfiles_on_start=yes.

You can also change settings during runtime with a keybind or command like KEY change-list script-opts append playlistmanager-showamount=10.

If you are using save-position-on-quit then the playlist will by default write watch later config when switching between files. There is a setting to disable this.

Title resolving

This script is able to resolve titles for local files with ffprobe and urls with youtube-dl. See the resolve_url_titles, resolve_local_titles, prefer_titles and youtube_dl_executable settings for details.

Keybinds

Static keybindings

Functions without default keybindings

The above functions do not have default keybindings(except for showplaylist). There is a couple of ways to bind keys for them:

If you want to use the above controls from a "gui" rather than keybinds, then you can check out mpv-menu and use the menu.json found in this repository.

Dynamic keybindings for navigating the playlist

Dynamic keybinds will only work when playlist is visible. Dynamic binds cannot be defined in input.conf, only in playlistmanager.lua or playlistmanager.conf. There is a setting to change the binds to static ones, which allows you to define keybindings in input.conf.

Script messages

In order to control the playlistmanager from other script it registers some script messages. The script messages can also be invoked by keybinds KEY script-message playlistmanager command value value2.

List of commands, values and their effects:

Command Value Value2 Effect
show playlist - / duration / toggle show for default duration, show for given seconds, toggle playlist visibility
show playlist-nokeys - / duration / toggle same as above but don't bind dynamic keys to navigate playlist
show filename - / seconds shows stripped filename for default or set seconds
sort startover - Sorts the playlist, any value will start playlist from start on sort
shuffle - - Shuffles the playlist
reverse - - Reverses the playlist
loadfiles - / path - Loads files from playing files dir(default), or specified path
save - / filename - Saves the playlist
playlist-next - - Plays next item in playlist (position of current file saved)
playlist-prev - - Plays previous item in playlist (position of current file saved)
playlist-next-random - - Jumps to a random file in the playlist
close - - Hides the playlist if it's being rendered

examples:
RIGHT playlist-next ; script-message playlistmanager show playlist Shows the playlist after playlist-next. Note that the playlist-next is native mpv command, not the playlistmanager one.
KEY show-text "Shuffled playlist" ; script-message playlistmanager shuffle Text message on shuffle

My other mpv scripts

collection of scripts