sudacode/mpv-youtube-queue
1
0
Fork 0
mirror of https://github.com/ksyasuda/mpv-youtube-queue.git synced 2024-10-28 04:44:11 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity
YouTube 'Add To Queue' for MPV
69 Commits 2 Branches 0 Tags 3.9 MiB
Lua 100%
fa2014acd6
Go to file
Kyle Yasuda fa2014acd6
All checks were successful
Luacheck / luacheck (push) Successful in 4s
Details
Dev (#16) 
* convert get_video_info to use mp functions and add menu_timeout option
* add menu_timeout config option
* fix add_to_queue not returning when given invalid url or path
2023-08-09 23:14:00 -07:00
.assets update image 2023-08-06 03:13:18 -07:00
.github/workflows update luacheck workflow 2023-08-09 01:21:40 -07:00
LICENSE initial commit for mpv-youtube-queue 2023-08-02 10:35:46 -07:00
mpv-youtube-queue.conf Dev (#16) 2023-08-09 23:14:00 -07:00
mpv-youtube-queue.lua Dev (#16) 2023-08-09 23:14:00 -07:00
README.md Dev (#16) 2023-08-09 23:14:00 -07:00

README.md

mpv-youtube-queue

A Lua script that implements the YouTube 'Add to Queue' functionality for mpv

mpv-youtube-queue image

Features

  • Add videos to a queue from the clipboard
  • An interactive menu to show the queue, to select a video to play, or to edit the order of the queue
  • Customizable keybindings to interact with the currrently playing video and the queue
  • Open the URL or channel page of the currently playing video in a new browser tab
  • Download a video in the queue using yt-dlp
  • Customizable download options
  • Integrates with the internal mpv playlist

Notes

  • This script uses the Linux xclip utility to read from the clipboard. If you're on macOS or Windows, you'll need to adjust the clipboard_command config variable in mpv-youtube-queue.conf
  • When adding videos to the queue, the script fetches the video name using yt-dlp. Ensure you have yt-dlp installed and in your PATH.

Requirements

This script requires the following software to be installed on the system

Installation

  • Copy the mpv-youtube-queue.lua script to your ~~/scripts directory (~/.config/mpv on Linux)
  • Optionally copy the mpv-youtube-queue.conf to the ~~/script-opts directory to customize the script configuration as described in the next section

Configuration

Default Keybindings

  • add_to_queue - ctrl+a: Add a video in the clipboard to the queue
  • download_current_video - ctrl+d: Download the currently playing video
  • download_selected_video - ctrl+D: Download the currently selected video in the queue
  • move_cursor_down - ctrl+j: Move the cursor down one row in the queue
  • move_cursor_up - ctrl+k- Move the cursor up one row in the queue
  • move_video - ctrl+m: Mark/move the selected video in the queue
  • play_next_in_queue - ctrl+n: Play the next video in the queue
  • open_video_in_browser - ctrl+o: Open the currently playing video in the browser
  • open_channel_in_browser - ctrl+O: Open the channel page for the currently playing video in the browser
  • play_previous_in_queue - ctrl+p: Play the previous video in the queue
  • print_current_video - ctrl+P: Print the name and channel of the currently playing video to the OSD
  • print_queue - ctrl+q: Print the contents of the queue to the OSD
  • remove_from_queue - ctrl+x: Remove the currently selected video from the queue
  • play_selected_video - ctrl+ENTER: Play the currently selected video in the queue

Default Option

  • browser - firefox: The browser to use when opening a video or channel page
  • clipboard_command - xclip -o: The command to use to get the contents of the clipboard
  • cursor_icon - ➤: The icon to use for the cursor
  • display_limit - 10: The maximum amount of videos to show on the OSD at once
  • download_directory - ~/videos/YouTube: The directory to use when downloading a video
  • download_quality 720p: The maximum download quality
  • downloader - curl: The name of the program to use to download the video
  • font_name - JetBrains Mono: The name of the font to use
  • font_size - 12: Size of the font
  • marked_icon - ⇅: The icon to use to mark a video as ready to be moved in the queue
  • menu_timeout - 5: The number of seconds until the menu times out
  • show_errors - yes: Show error messages on the OSD
  • ytdlp_file_format - mp4: The preferred file format for downloaded videos
  • ytdlp_output_template - %(uploader)s/%(title)s.%(ext)s: The yt-dlp output template string
    • Full path with the default download_directory is: ~/videos/YouTube/<uploader>/<title>.<ext>

License

This project is licensed under the terms of the GPLv3 license.