My Lua scripts and settings for MPV

This repository contains several Lua scripts and settings I wrote for open-source media player mpv. Many parts in my code are from internet obviously.

Installation

You can install each Lua script below individually by just copying it. Please notice that the installation script is probably just for me, and also that subtitle settings of mpv.conf and script-opts/on-file-loaded.conf are for Koreans. Anyhow it installs all the scripts and settings of this repository.

First install mpv and then download 9beach/mpv-config. Before install it, please notice that:

1. To play and download media from URLs with mpv, you need to install yt-dlp. For Microsoft Windows users, download yt-dlp.exe and copy it to C:\Windows.
2. To download the highest resolution media, and preserve chapter markers, you need to install ffmpeg.

In Mac or Linux, run the following from the terminal. Then it installs 9beach/mpv-config to your mpv configuration directory. Your original mpv settings are copied to ~/Downloads directory if it exists.

cd mpv-config-main
./install.sh

If your machine has NVIDIA GPU installed, run ./install.sh nvidia.

If you prefer portable_config, run the following.

MPV_CONF_PATH="path-to-my-mpv/portable_config" ./install.sh

In Microsoft Windows, run the following from the Command Prompt, or double-click install.bat in file explorer.

C:\path-to\mpv-config-main> install.bat

If your machine has NVIDIA GPU installed, run install.bat nvidia.

If you prefer portable_config, run the following.

C:\path-to\mpv-config-main> SET MPV_CONF_PATH=C:\path-to-my-mpv\portable_config
C:\path-to\mpv-config-main> install.bat

Notice that there are no quotation marks in MPV_CONF_PATH definition.

Lua scripts

You can copy and install each script below to your mpv scripts directory, which is usually ~/.config/mpv/scripts/ or %APPDATA%/mpv/scripts/. Please see https://mpv.io/manual/master/#files and https://mpv.io/manual/master/#script-location for more information.

copy-and-paste.lua

This script gives mpv the capability to copy and paste file paths and URLs. You can paste and play multiple lines of media file paths, media URLs, and HTML page URLs including YouTube, Twitter, Twitch.tv, Naver, Kakao...

You can edit key bindings below in script-opts/copy-and-paste.conf:

• Pastes file paths or URLs in clipboard to playlist. (Alt+V, Ctrl+V, Meta+V)
• Appends file paths or URLs in clipboard to playlist. (Alt+b, Ctrl+b, Meta+b)
• Appends file paths or URLs in clipboard to current track. (Alt+v, Ctrl+v, Meta+v)
• Copies file path or URL of current track. (Alt+c, Ctrl+c, Meta+c)

Please notice that:

1. To play and download media from URLs with mpv, you need to install yt-dlp. For Microsoft Windows users, download yt-dlp.exe and copy it to C:\Windows.
2. For OSX users, when option key pressed, the context menu of a file reveals Copy as pathname menu item (or just press ⌘⌥C). You can paste the pull paths of local media to mpv with this.

web-download.lua

You can download media URLs of mpv playlist from web sites including YouTube, Twitter, Twitch.tv, Naver, Kakao, ... with this script:

• Downloads currently playing media. (Ctrl+d, Alt+d, Meta+d)
• Downloads all media of mpv playlist. (Ctrl+D, Alt+D, Meta+D)
• Downloads currently playing media as a audio file. (Ctrl+e, Alt+e, Meta+e)
• Downloads all media of mpv playlist as audio files. (Ctrl+E, Alt+E, Meta+E)
• Downloads currently playing media with alternative option. (Ctrl+y, Alt+y, Meta+y)
• Downloads all media of mpv playlist with alternative option. (Ctrl+Y, Alt+Y, Meta+Y)

You can edit key bindings above in script-opts/web-download.conf. Please notice that:

1. To play and download media from URLs with mpv, you need to install yt-dlp. For Microsoft Windows users, download yt-dlp.exe and copy it to C:\Windows.
2. To download the highest resolution media, and preserve chapter markers, you need to install ffmpeg.

simple-playlist.lua

This script provides the script messages below:

• script-message simple-playlist sort name-asc (Alt+n, Ctrl+n, Meta+n)
• script-message simple-playlist sort name-asc startover
• script-message simple-playlist sort date-desc (Alt+t, Ctrl+t, Meta+t)
• script-message simple-playlist sort date-desc startover

simple-playlist sort also support size-asc, size-desc, date-asc, name-desc with or without startover. It's quite fast. Of course, the time complexity of my sorting algorithm is O(nlog n) for Lua data, but for the mpv system call, i.e., mp.commandv('playlist-move', i, j), the time complexity is O(n).

• script-message simple-playlist shuffle
• script-message simple-playlist shuffle startover (Alt+s, Ctrl+s, Meta+s)
• script-message simple-playlist reverse (Alt+R, Ctrl+R, Meta+R)
• script-message simple-playlist playfirst (Alt+a, Ctrl+a, Meta+a)
• script-message simple-playlist playlast (Alt+z, Ctrl+z, Meta+z)
• script-message simple-playlist show-text 5 (Alt+p, Ctrl+p, Meta+p)
• script-message simple-playlist show-osc 5 (Alt+l, Ctrl+l, Meta+l)
• script-message simple-playlist hide (Alt+k, Ctrl+k, Meta+k)
• script-message simple-playlist save (Alt+P, Ctrl+P, Meta+P)

5 in show-text and show-osc is the duration in seconds. To keep the code simple, the playlist is not refreshed automatically, so another show-text or show-osc is needed to refresh the playlist.

You can edit key bindings in input.conf.

META+t script-message simple-playlist sort date-desc
META+n script-message simple-playlist sort name-asc
META+s script-message simple-playlist shuffle startover
...

Many parts in my code are from https://github.com/jonniek/mpv-playlistmanager.

on-file-loaded.lua

This script provides the functions below:

• Always starts from the begining when do_not_resume is set even if mpv option save-position-on-quit is set. (Ctrl+*)

• Shows OSC always when an audio file (that is of known audio extensions or has no video) is loaded.

• Plays even in paused state when a new file is loaded.

• Does not show subtitle if lower-case path matches given patterns.

• Does not show subtitle if audio language matches given values.

• Resets mpv geometry when an non-audio file (that is not of known audio extensions and has video) is loaded. When you turn on this feature, mpv can escape from small rectangle when a webm media has video even if mpv.conf has settings below.

  [extension.webm]
  geometry=800x800+100%+100%
  

watch_later setting for each file overrides subtitle visibilities above. So if you change the visibility of subtitle in a file, mpv remembers it just for that file if you resume to play it.

You can edit the settings in script-opts/on-file-loaded.conf.

finder-integration.lua

This script provides the script messages below:

• reveal-in-finder runs explorer.exe/Finder.app/Nautilus with currently playing file selected. (Ctrl+f, Alt+f, Meta+f)
• touch-file updates the modification time of currently playing file. If you want to mark it to delete later or do something else with, it will help you. (Ctrl+x, Alt+x, Meta+x)

You can edit the settings in script-opts/finder-integration.conf.

autoload-ex.lua

This script provides the functions below:

• Like well-known autoload, automatically loads playlist entries by scanning the directory a file is located in when starting playback.
• Provides many sorting methods and shuffling when scanning the directory.
• Provides keybinds for the functions of scannig the directory, sorting and shuffling the files.
• Remembers the sorting and shuffling states of the directory. So when you open a file in the directory next time, autoload-ex restores previous sorting states of the directory.
• Even though you set disabled=yes in script-opts/autoload-ex.conf and call autoload-ex manually by keybinds, autoload-ex scans entries of the directory automatically next time.
• If you set disabled=no and call autoload-ex remove-others manually by keybinds, autoload-ex does not scan entries of the directory next time.

Notice that when manually called, autoload-ex does reload and sort not the current playlist entries, but the files in the directory of the current track. It means that autoload-ex remembers the state of a directory, not that of a playlist.

This script provides the script messages below:

• script-message autoload-ex shuffle
• script-message autoload-ex shuffle startover (Alt+S, Ctrl+S, Meta+S)
• script-message autoload-ex sort name-asc (Alt+N, Ctrl+N, Meta+N)
• script-message autoload-ex sort name-desc
• script-message autoload-ex sort name-asc startover
• script-message autoload-ex sort name-desc startover
• script-message autoload-ex sort date-asc
• script-message autoload-ex sort date-desc (Alt+T, Ctrl+T, Meta+T)
• script-message autoload-ex sort date-asc startover
• script-message autoload-ex sort date-desc startover
• script-message autoload-ex sort size-asc
• script-message autoload-ex sort size-desc
• script-message autoload-ex sort size-asc startover
• script-message autoload-ex sort size-desc startover
• script-message autoload-ex remove-others (Alt+R, Ctrl+R, META+R)

You can edit key bindings in input.conf.

META+SHIFT+n script-message autoload-ex sort name-asc
META+SHIFT+t script-message autoload-ex sort date-desc
META+SHIFT+s script-message autoload-ex shuffle startover
META+SHIFT+r script-message autoload-ex remove-others
...

Many parts in my code are from https://github.com/mpv-player/mpv/blob/master/TOOLS/lua/autoload.lua, http://lua-users.org/wiki/SecureHashAlgorithm, and https://www.snpedia.com/extensions/Scribunto/engines/LuaCommon/lualib/bit32.lua.

on-startup-shutdown.lua

This script provides the functions below:

• Saves and restores sound volume level automatically.

watch_later setting for each file overrides sound volume level above. So if you change the sound volume level of a file, mpv remembers it just for that file if you resume to play it.

You can edit the settings in script-opts/on-startup-shutdown.conf.

modernx-and-quotes.lua

The original code is from ModernX.

An MPV OSC script based on mpv-osc-modern that aims to mirror the functionality of MPV's stock OSC while with a more modern-looking interface.

I added a simple feature. In idle state, it shows a quote about writing and art. You can copy the text with script-message copy-quote, and also add your favorite quotes to script-opts/modernx-and-quotes.txt file.

To install modernx-and-quotes, please copy scripts/modernx-and-quotes.lua, script-opts/osc.conf, and script-opts/modernx-and-quotes.txt to your system.