From ac5a9e3ef917df5973abc6d693d47ba368116299 Mon Sep 17 00:00:00 2001 From: FalloNero Date: Sat, 3 Jan 2026 00:42:52 +0100 Subject: [PATCH] Revise README for VLC yt-dlp Lua Wrapper Expanded README with detailed usage instructions and features. --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 44 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6cdf028..8d3ddad 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,54 @@ -Simple lua script that wraps yt-dlp.exe into VLC +VLC yt-dlp Lua Wrapper -By default it requires yt-dlp.exe in the VLC directory but feel free to change its path in the script +A simple Lua script that integrates yt-dlp directly into VLC, allowing you to stream supported online videos by simply opening a network URL in VLC. -Also uses a powershell command to hide the cmd window that appears meanwhile yt-dlp cooks the links, -also it uses if found yt-dlp-silent.exe that just a c++ wrapper that does kinda the same without using powershell +Features + +Wraps yt-dlp.exe for seamless use inside VLC + +By default, expects yt-dlp.exe in the VLC directory + +The path can be easily changed inside the script + +Automatically hides the command window while yt-dlp resolves the stream: + +Uses a PowerShell command by default + +If yt-dlp-silent.exe is found, it will be used instead (a small C++ wrapper that suppresses the console without PowerShell) + +Usage + +Place the Lua script in VLC’s Lua playlist directory. + +Make sure yt-dlp.exe (or yt-dlp-silent.exe) is available. + +In VLC, select Media → Open Network Stream. + +Paste a supported video URL and play. + +Video Quality Selection + +You can force a specific video quality by appending the quality parameter to the URL: + +&quality=xxx -Simply open a network stream in VLC and let it rip - -add &quality=xxx to the URL to select the video quality, omit to default to maximum quality possible +Supported values: 360p + 480p + 720p + 1080p + 2160p + +If the parameter is omitted, the script defaults to the highest available quality. + +Notes + +Requires Windows (due to PowerShell / executable usage). + +VLC must have Lua playlist scripts enabled (default behavior).