diff --git a/README.md b/README.md index d749204..395e860 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,50 @@ -# YT-DLP Handler -A frontend for [yt-dlp](https://github.com/yt-dlp/yt-dlp) created by [Sprinter05](https://github.com/Sprinter05) with a Linux/MacOS version created by [tulip-sudo](https://github.com/tulip-sudo). -# Installation -## Dependencies -### Windows 10/11 -Download [FFMPEG](https://www.gyan.dev/ffmpeg/builds/) essentials and place the `ffmpeg` and `ffprobe` binaries (located inside the bin folder) within your PATH. Then download the [yt-dlp](https://github.com/yt-dlp/yt-dlp/#installation) .exe file (If you get any problems, it is recommended to try the x86 binary, but remember to rename it when using it) and also place it within your PATH (Unless you want to use `LEGACY` mode, in which case you will need the [youtube-dl](https://github.com/ytdl-org/youtube-dl/) binaries). -### Linux/BSD -Install Python 3.7+ from your package manager. -#### Rolling Release Distributions -Download both FFMPEG and yt-dlp from your package manager. -#### Stable Release Distributions -Download FFMPEG (from your package manager) and then download yt-dlp from pip using `python3 -m pip install --user -U yt-dlp` (Note: This won't be in PATH by default. Make sure to add it!)
-This is recommended as on some distributions (Like Ubuntu 22.04 LTS), the version of yt-dlp that is provided has bugs relating to downloading .mkv files. -### MacOS -Install Python 3.7+ from your package manager. -Install a package manager (e.g. [Brew](https://brew.sh)) then install FFMPEG.
-Next, install yt-dlp either from pip (`python3 -m pip install --user -U yt-dlp`) or from your installed package manager. -## Post-Dependencies -After installing the necessary dependencies, execute the file specific to your OS after downloading it from the **Releases** page.
-For Windows 10/11, the executable is the start.cmd file.
-For older versions of Windows, the executable is the start_win.cmd file.
-For both Linux and MacOS, the executable is the start.sh file. -# Settings -## Program Settings -`LEGACY` - Enables Legacy mode which uses [youtube-dl](https://github.com/ytdl-org/youtube-dl/) instead of the default [yt-dlp](https://github.com/yt-dlp/yt-dlp) binaries. Some settings might not work in Legacy mode (check .ini file for more information).
-`MUSICDIR` - This is where audio-only downloads are stored. Value is a path.
-`VIDEODIR` - This is where video files are stored. Value is a path.
-`EXPLORER` - Opens your file browser after download audio/video. Value is a number that is either 1 or 0 (1 being enabled).
-`REOPEN` - Launches the executable again after finishing the operation instead of closing the program (if the value is set to 1).
-## YouTube Download -`RATELIMIT` - Determines if a download speed limiter should be applied. Value is a number that is either 1 or 0 (1 being enabled).
-`SPEED` - Affects the download speed limit if `RATELIMIT` is enabled. Value should be a number followed by a single letter to indicate the unit being used (K for Kilobytes, M for Megabytes etc.)
-`VIDEOQUALITY` - Determines which resolution should be downloaded for videos with the value specifically being the video height. Value is a positive whole number.
-`THUMBNAIL`, `SUBTITLES`, `METADATA` - Enables downloading the specific feature. Value is a number that is either 1 or 0 (1 being enabled).
-`CHAPTERS` - Divides the download into multiple files depending on the amount of chapters (if available).
-## Video Processing -`REMUX` - Determines if a downloaded MP4 should be remuxed instead of being entirely re-encoded. Value is a number that is either 1 or 0 (1 being enabled).
-`POSTPROCESSING` - Enables post-processing for MP4 files. Affected by `PPARGS`. Value is a number that is either 1 or 0 (1 being enabled). It is recommended to read [the yt-dlp README](https://github.com/yt-dlp/yt-dlp#post-processing-options) before modifying this and PPARGS.
-`PPARGS` - FFMPEG post-processing arguments (It is recommended to read [the FFMPEG docs](https://trac.ffmpeg.org/wiki/Encode/) before messing with this.
-`DEBUG` - Enables verbose logging. Helpful if an error occurs! Value is a number that is either 1 or 0 (1 being enabled).
-## Audio Processing -`AUDIOQUALITY` - Affects the quality of audio downloaded. This only affects FFMPEG conversion from m4a to any other audio format and does not affect video audio. Accepts a number between 0 and 10 (inclusive). The best is 0 and the worst is 10. The default (5) is 128K.
-# License -**ytdlp-handler** is released under the _LGPLv3 license_. Please refer to the `LICENSE` file for more information +# YT-DLP Handler +A frontend for [yt-dlp](https://github.com/yt-dlp/yt-dlp) created by [Sprinter05](https://github.com/Sprinter05) with a Linux/MacOS version created by [tulip-sudo](https://github.com/tulip-sudo). +# Installation +## Dependencies +### Windows 10/11 +#### Automatic Installation +Download the setup.bat file from the [releases](https://github.com/Sprinter05/ytdlp-handler/releases/) page and run it. Open the ytdlp-handler folder and run start.cmd once the installation has completed. +#### Manual Installation +Download [FFMPEG](https://www.gyan.dev/ffmpeg/builds/) essentials and place the `ffmpeg` and `ffprobe` binaries (located inside the bin folder) within your PATH. Then download the [yt-dlp](https://github.com/yt-dlp/yt-dlp/#installation) .exe file (If you get any problems, it is recommended to try the x86 binary, but remember to rename it when using it) and also place it within your PATH (Unless you want to use `LEGACY` mode, in which case you will need the [youtube-dl](https://github.com/ytdl-org/youtube-dl/) binaries). +### Linux/BSD +Install Python 3.7+ from your package manager. +#### Rolling Release Distributions +Download both FFMPEG and yt-dlp from your package manager. +#### Stable Release Distributions +Download FFMPEG (from your package manager) and then download yt-dlp from pip using `python3 -m pip install --user -U yt-dlp` (Note: This won't be in PATH by default. Make sure to add it!)
+This is recommended as on some distributions (Like Ubuntu 22.04 LTS), the version of yt-dlp that is provided has bugs relating to downloading .mkv files. +### MacOS +Install Python 3.7+ from your package manager. +Install a package manager (e.g. [Brew](https://brew.sh)) then install FFMPEG.
+Next, install yt-dlp either from pip (`python3 -m pip install --user -U yt-dlp`) or from your installed package manager. +## Post-Dependencies +After installing the necessary dependencies, execute the file specific to your OS after downloading it from the [releases](https://github.com/Sprinter05/ytdlp-handler/releases/) page.
+ +For Windows 10/11, the executable is the start.cmd file.
+For older versions of Windows, the executable is the start_win.cmd file.
+For both Linux and MacOS, the executable is the start.sh file.
+**NOTE:** start_win.cmd has been deprecated since 3.0 and the installer/updater will already fit the needs of the Windows version. +# Settings +## Program Settings +`LEGACY` - Enables Legacy mode which uses [youtube-dl](https://github.com/ytdl-org/youtube-dl/) instead of the default [yt-dlp](https://github.com/yt-dlp/yt-dlp) binaries. Some settings might not work in Legacy mode (check .ini file for more information).
+`MUSICDIR` - This is where audio-only downloads are stored. Value is a path.
+`VIDEODIR` - This is where video files are stored. Value is a path.
+`EXPLORER` - Opens your file browser after download audio/video. Value is a number that is either 1 or 0 (1 being enabled).
+`REOPEN` - Launches the executable again after finishing the operation instead of closing the program (if the value is set to 1).
+`CHECKUPD` - Checks for updates when the program (start.cmd) is ran. Requires a changelog.txt file in order to work. +## YouTube Download +`RATELIMIT` - Determines if a download speed limiter should be applied. Value is a number that is either 1 or 0 (1 being enabled).
+`SPEED` - Affects the download speed limit if `RATELIMIT` is enabled. Value should be a number followed by a single letter to indicate the unit being used (K for Kilobytes, M for Megabytes etc.)
+`VIDEOQUALITY` - Determines which resolution should be downloaded for videos with the value specifically being the video height. Value is a positive whole number.
+`THUMBNAIL`, `SUBTITLES`, `METADATA` - Enables downloading the specific feature. Value is a number that is either 1 or 0 (1 being enabled).
+`CHAPTERS` - Divides the download into multiple files depending on the amount of chapters (if available).
+## Video Processing +`REMUX` - Determines if a downloaded MP4 should be remuxed instead of being entirely re-encoded. Value is a number that is either 1 or 0 (1 being enabled).
+`POSTPROCESSING` - Enables post-processing for MP4 files. Affected by `PPARGS`. Value is a number that is either 1 or 0 (1 being enabled). It is recommended to read [the yt-dlp README](https://github.com/yt-dlp/yt-dlp#post-processing-options) before modifying this and PPARGS.
+`PPARGS` - FFMPEG post-processing arguments (It is recommended to read [the FFMPEG docs](https://trac.ffmpeg.org/wiki/Encode/) before messing with this.
+`DEBUG` - Enables verbose logging. Helpful if an error occurs! Value is a number that is either 1 or 0 (1 being enabled).
+## Audio Processing +`AUDIOQUALITY` - Affects the quality of audio downloaded. This only affects FFMPEG conversion from m4a to any other audio format and does not affect video audio. Accepts a number between 0 and 10 (inclusive). The best is 0 and the worst is 10. The default (5) is 128K.
+# License +**ytdlp-handler** is released under the _LGPLv3 license_. Please refer to the `LICENSE` file for more information diff --git a/changelog.txt b/changelog.txt index b0565be..3c25dc9 100644 --- a/changelog.txt +++ b/changelog.txt @@ -1,22 +1,28 @@ -Changelog for ytdlp-handler ---------------------------- - -2.2 (2023-01-12) - * Implemented REOPEN parameter for Linux [3f38db7] - * Implemented REOPEN parameter for Windows [6f2aa22] - -2.1 (2022-12-17) - * Implemented 2.0 features in Linux [5be9721] - * Implemented new update method for Linux [6e867a2] - * Updated README and improved LEGACY mode [a106c2f] - -2.0 (2022-12-17) - * Implemented new Windows updater [8e6051d] - * Implemented required binaries checker [2a9c4e9] - * Legacy Mode for W10 implemented [010dc61] - -1.0 (2022-11-11) - * introduced update.bat [bd2c10b] - * README implemented [f3da6ad] - * first release implemented for Linux and MacOS [f2aaa6c] +Changelog for ytdlp-handler +--------------------------- + +3.0 (2023-04-19) + * Deprecated start_win.cmd in favor of automatic Windows version detector [319afc3] + * You can now check for updates when running start.cmd with the CHECKUPD parameter [2780e60] + * Improved update.bat that includes external libraries [77e5d9a] + * New setup.bat file for easier installation on Windows [8881ba4] + +2.2 (2023-01-12) + * Implemented REOPEN parameter for Linux [3f38db7] + * Implemented REOPEN parameter for Windows [6f2aa22] + +2.1 (2022-12-17) + * Implemented 2.0 features in Linux [5be9721] + * Implemented new update method for Linux [6e867a2] + * Updated README and improved LEGACY mode [a106c2f] + +2.0 (2022-12-17) + * Implemented new Windows updater [8e6051d] + * Implemented required binaries checker [2a9c4e9] + * Legacy Mode for W10 implemented [010dc61] + +1.0 (2022-11-11) + * introduced update.bat [bd2c10b] + * README implemented [f3da6ad] + * first release implemented for Linux and MacOS [f2aaa6c] * first release implemented for W10 [59450c6] \ No newline at end of file diff --git a/start.cmd b/start.cmd index 31cf541..dfd223d 100644 --- a/start.cmd +++ b/start.cmd @@ -117,7 +117,7 @@ for /F %%i in ('powershell -command "((Invoke-WebRequest -Uri https://api.github set "onlinever=%%i" ) echo Local version is %currver:~0,3%. Online version is %onlinever%. -if "%onlinever%"=="%currver:~0,3%" ( +if "%onlinever%" leq "%currver:~0,3%" ( echo The ytdlp-handler program is up to date. ) else ( echo There is a new ytdlp-handler update available. diff --git a/start_win.cmd b/start_win.cmd index 1f45e6a..3da7167 100644 --- a/start_win.cmd +++ b/start_win.cmd @@ -117,7 +117,7 @@ for /F %%i in ('powershell -command "((Invoke-WebRequest -Uri https://api.github set "onlinever=%%i" ) echo Local version is %currver:~0,3%. Online version is %onlinever%. -if "%onlinever%"=="%currver:~0,3%" ( +if "%onlinever%" leq "%currver:~0,3%" ( echo The ytdlp-handler program is up to date. ) else ( echo There is a new ytdlp-handler update available.