Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonniek/mpv-playlistmanager

Mpv lua script to create and manage playlists
https://github.com/jonniek/mpv-playlistmanager

lua mpv mpv-script playlist script

Last synced: 5 days ago
JSON representation

Mpv lua script to create and manage playlists

Awesome Lists containing this project

README 

        
# 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.



![](playlistmanager.png)  

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](https://mpv.io/manual/master/#files) and [https://mpv.io/manual/master/#script-location](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](https://mpv.io/manual/master/#options-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

- __showplaylist__(SHIFT+ENTER)

  - Displays the current playlist and loads the dynamic keybinds for navigating  



#### Functions without default keybindings

- __sortplaylist__ 

  - Sorts the current playlist with stripped values from filename(not media title, no paths, usercreated strips applied). To start playlist from start you can use a script message `KEY script-message playlistmanager sortplaylist startover`. Settings involving sort include alphanumeric sort(nonpadded numbers in order, case insensitivity), sort on mpv start and sort on file added to playlist. Sort algorithm credit [zsugabubus](https://github.com/zsugabubus/dotfiles/blob/master/.config/mpv/scripts/playlist-filtersort.lua)  

- __shuffleplaylist__

  - Shuffles the current playlist. Stops currently playing file and starts playlist from start of new playlist unlike native shuffle that doesn't shuffle current file.  

- __reverseplaylist__

  - Reverses the current playlist. Does not stop playing the current file.  

- __loadfiles__

  - Attempts to load all files from the currently playing files directory to the playlist keeping the order. Option to run at startup if 0 or 1 files are opened, with 0 opens files from working directory. On startup with no file requires `--idle=yes or --idle=once`.  

- __saveplaylist__

  - Saves the current playlist to m3u file. Saves to `mpv/playlists/` by default. If you want to name playlists manually rather than the automatic naming you can use [playlistmanager-save-interactive.lua](https://github.com/jonniek/mpv-playlistmanager/blob/master/playlistmanager-save-interactive.lua) module. It will prompt for a name when you save the playlist.



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

 - Edit the `playlistmanager.lua` settings

   - Downside: you have to merge two versions if you want to update the script

 - Edit the `playlistmanager.conf` settings

   - Upside: you can update the `playlistmanager.lua` file without losing your configurations

 - Edit `input.conf` with for example `KEY script-binding playlistmanager/showplaylist`

   - in above example you might want to remove the default keybind of `showplaylist` or use `--no-input-default-bindings`



If you want to use the above controls from a "gui" rather than keybinds, then you can check out 

[mpv-menu](https://github.com/jonniek/mpv-menu) and use the `menu.json` found in this repository.



### Dynamic keybindings for navigating the playlist

- __moveup__(UP)

- __movedown__(DOWN)

- __movepageup__ (Page Up)

- __movepagedown__ (Page Down)

- __movebegin__ (Home)

- __moveend__ (End)

- __removefile__(Backspace)

  - Removes the file currently selected with the cursor from the playlist

- __playfile__(Enter)

  - Opens the file currently selected with the cursor, if cursor on playing file, open the next file

- __selectfile__(RIGHT or LEFT)

  - Selects or unselects the file under the cursor

  - When moving the cursor the selected file will follow, allowing reordering of the playlist

- __unselectfile__(no default bind)

  - Unselects the file under the cursor if it was selected

- __closeplaylist__(ESC)



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](https://github.com/jonniek/mpv-scripts)