You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ytDownloader/README.md

200 lines
9.1 KiB
Markdown

3 years ago
<img src="https://github-production-user-asset-6210df.s3.amazonaws.com/66430340/238887646-33b4cba9-3c45-4042-83d1-b79e94a3a769.png" style="width:80px;">
4 years ago
3 years ago
# ytDownloader
4 years ago
3 years ago
[![Flathub](https://img.shields.io/flathub/downloads/io.github.aandrew_me.ytdn?label=Flathub%20downloads)](https://flathub.org/apps/details/me.aandrew.ytdownloader)
3 years ago
[![GitHub downloads](https://img.shields.io/github/downloads/aandrew-me/ytdownloader/total?label=Github%20downloads)](https://github.com/aandrew-me/ytDownloader/releases)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/aandrew-me/ytdownloader?label=latest%20release)](https://github.com/aandrew-me/ytDownloader/releases/latest)
3 years ago
[![Flathub](https://img.shields.io/flathub/v/io.github.aandrew_me.ytdn)](https://flathub.org/apps/io.github.aandrew_me.ytdn)
4 years ago
[![Snapcraft](https://badgen.net/snapcraft/v/ytdownloader)](https://snapcraft.io/ytdownloader)
3 years ago
![Chocolatey Version](https://img.shields.io/chocolatey/v/ytdownloader)
10 months ago
![WinGet Package Version](https://img.shields.io/winget/v/aandrew-me.ytDownloader)
4 years ago
A modern GUI video and audio downloader supporting [hundreds of sites](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md)
4 years ago
3 years ago
4 years ago
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/ytdownloader)
[![Get AppImage](https://raw.githubusercontent.com/srevinsaju/get-appimage/master/static/badges/get-appimage-branding-blue.png)](https://github.com/aandrew-me/ytDownloader/releases/latest/download/YTDownloader_Linux.AppImage)
<a href="https://flathub.org/apps/io.github.aandrew_me.ytdn"><img src="https://flathub.org/assets/badges/flathub-badge-en.svg" style="width:180px;"></a>
<a href="https://github.com/aandrew-me/ytDownloader/releases/latest/download/YTDownloader_Win.exe
4 years ago
"><img src="https://user-images.githubusercontent.com/66430340/187172806-a8edd12a-ef58-4a05-96a3-99d7490b42f6.png" style="width:190px;"></a>
<a href="https://github.com/aandrew-me/ytDownloader/releases/latest/download/YTDownloader_Mac_arm64.dmg"><img src="https://cdn.jsdelivr.net/gh/aandrew-me/badges/download_mac_apple_silicon.png" style="width:200px;"></a>
<a href="https://github.com/aandrew-me/ytDownloader/releases/latest/download/YTDownloader_Mac_x64.dmg"><img src="https://cdn.jsdelivr.net/gh/aandrew-me/badges/download_mac_intel.png" style="width:200px;"></a>
3 years ago
<a href="https://community.chocolatey.org/packages/ytdownloader"><img style="width:200px;" src="https://github-production-user-asset-6210df.s3.amazonaws.com/66430340/238886537-7b2769fe-bd62-4921-a0eb-edf2eb06216d.png" alt="Chocolatey"></a>
## Features 🚀
4 years ago
4 years ago
✅ Supports hundreds of sites including Youtube, Facebook, Instagram, Tiktok, Twitter and so on.
4 years ago
1 year ago
✅ Multiple themes
✅ Video Compressor with Hardware Acceleration
✅ Advanced options like Range Selection, Subtitles
4 years ago
4 years ago
✅ Download playlists
1 year ago
✅ Available on Linux, Windows, Freebsd & macOS
4 years ago
4 years ago
✅ Fast download speeds
4 years ago
✅ And of-course no trackers or ads
4 years ago
4 years ago
## Screenshots
3 years ago
3 years ago
<!-- ![dark](https://user-images.githubusercontent.com/66430340/196022794-885e5b90-40d2-4b58-a8fa-74f10c6e470e.png) -->
<!-- ![light](https://user-images.githubusercontent.com/66430340/196022796-1215038d-bafb-4450-82b1-7baddd60c0e8.png) -->
4 years ago
2 years ago
<!-- ![ytdownloader_dark](https://github.com/aandrew-me/ytDownloader/assets/66430340/62efbca0-28b8-4016-bcf2-1a14bcaa782c) -->
<!-- ![ytdownloader_light](https://github.com/aandrew-me/ytDownloader/assets/66430340/34f5270f-bdea-460e-8622-6459cd147b73) -->
![ss_dark](https://github.com/user-attachments/assets/0e810d71-6e8e-428f-9cca-9af71b5d7c16)
2 years ago
![ss_prefs](https://github.com/user-attachments/assets/12097005-b41c-44a3-a579-61b8e990432f)
![ss_compressor](https://github.com/user-attachments/assets/b366aa8e-a004-4697-873f-965f51752f15)
<!-- ![ytdownloader_dark](https://github.com/aandrew-me/ytDownloader/assets/66430340/2f6695e7-6ca0-4f7c-91a0-0ad735c1e3af) -->
<!-- ![ytdownloader_light](https://github.com/aandrew-me/ytDownloader/assets/66430340/3c974ab0-8257-4b8a-88ec-ee6bd119751e) -->
4 years ago
4 years ago
# Installation
3 years ago
## Windows 🪟
4 years ago
3 years ago
- **Traditional way**
4 years ago
3 years ago
Download and install the exe or msi file. Exe file lets you choose custom download location, msi file doesn't ask for location. Windows defender may show a popup saying **Windows Protected Your PC**. Just click on **More info** and click on **Run Anyway**
- **Chocolatey**
4 years ago
App can be installed from [Chocolatey](https://community.chocolatey.org/packages/ytdownloader) using the following command
```
choco install ytdownloader
```
3 years ago
- **Scoop**
App can be installed with [Scoop](https://scoop.sh) using the following command
```
scoop install https://raw.githubusercontent.com/aandrew-me/ytDownloader/main/ytdownloader.json
```
10 months ago
- **Winget**
2 years ago
App can be installed with [Winget](https://github.com/microsoft/winget-cli) using the following command
```
winget install aandrew-me.ytDownloader
```
4 years ago
## Linux 🐧
4 years ago
1 year ago
Linux has several options available - Flatpak, AppImage and Snap.
Flatpak is recommended. For arm processors, download from flathub.
3 years ago
- ### AppImage
4 years ago
**AppImage** format is supported on most Linux distros and has Auto-Update support.
It just needs to be executed after downloading. See more about [AppImages here](https://appimage.org/).
[AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) is recommended for integrating AppImages.
3 years ago
- ### Flatpak
4 years ago
```
flatpak install flathub io.github.aandrew_me.ytdn
4 years ago
```
3 years ago
- ### Snapcraft
4 years ago
```
sudo snap install ytdownloader
```
3 years ago
## macOS 🍎
3 years ago
10 months ago
Since the app is not signed, when you will try to open the app, macOS will not allow you to open it.
10 months ago
You need to open terminal and execute:
```
sudo xattr -r -d com.apple.quarantine /Applications/YTDownloader.app
```
10 months ago
You will also need to install `yt-dlp` with [homebrew](https://brew.sh/)
```
brew install yt-dlp
```
2 years ago
## Internationalization (Localization) 🌍
3 years ago
3 years ago
Translations into other languages would be highly appreciated. If you want to help translating the app to other languages, you can join from [here](https://crwd.in/ytdownloader). Open a new issue and that language will be added to Crowdin. Please don't make pull requests with json files, instead use Crowdin.
[![Crowdin](https://badges.crowdin.net/ytdownloader/localized.svg)](https://crowdin.com/project/ytdownloader)
3 years ago
### ✅ Available languages
3 years ago
| Name | Status |
| ------------------- | ------ |
2 years ago
| Arabic | ✔️ |
3 years ago
| English | ✔️ |
| Simplified Chinese | ✔️ |
3 years ago
| Finnish | ✔️ |
| French | ✔️ |
| German | ✔️ |
| Greek | ✔️ |
3 years ago
| Hungarian | ✔️ |
3 years ago
| Italian | ✔️ |
| Japanese | ✔️ |
3 years ago
| Persian | ✔️ |
| Polish | ✔️ |
| Portuguese (Brazil) | ✔️ |
| Russian | ✔️ |
| Spanish | ✔️ |
| Turkish | ✔️ |
| Ukrainian | ✔️ |
| Vietnamese | ✔️ |
Thanks to [nxjosephofficial](https://github.com/nxjosephofficial), [LINUX-SAUNA](https://t.me/linuxsauna), [Proxycon](https://github.com/proxycon), [albanobattistella](https://github.com/albanobattistella), [TheBlueQuasar](https://github.com/TheBlueQuasar), [MrQuerter](https://github.com/MrQuerter), [KotoWhiskas](https://github.com/KotoWhiskas), [André](https://github.com/andre1828), [haggen88](https://github.com/haggen88), [XfedeX](https://github.com/XfedeX), [Jok3r](https://github.com/th3knv), [TitouanReal](https://github.com/TitouanReal), [soredake](https://github.com/soredake), [yoi](https://github.com/thiennguyenqn), [HowlingWerewolf](https://github.com/HowlingWerewolf), [Kum](https://github.com/kum4423), [Mohammed Bakry](https://crowdin.com/profile/m7md_b4kry), [Huang Bingfeng](https://github.com/jackiotyu) and others for helping.
3 years ago
4 years ago
## Used technologies
3 years ago
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
- [Electron](https://www.electronjs.org/)
- [ffmpeg](https://ffmpeg.org/)
- [nodeJS](https://nodejs.org/en/)
- [flaticon](https://www.flaticon.com/)
4 years ago
4 years ago
## For building or running from source code
4 years ago
[Nodejs](https://nodejs.org/) (along with npm) needs to be installed.
Required commands to get started.
3 years ago
4 years ago
```
git clone https://github.com/aandrew-me/ytDownloader.git
cd ytDownloader
npm i
```
To run with [Electron](https://www.electronjs.org/) :
3 years ago
4 years ago
```
npm start
4 years ago
```
3 years ago
You need to download ffmpeg and put it in the root directory of the project. If you don't need to build for arm processor, you can download ffmpeg by executing any of the files - linux.sh / mac.sh / windows.sh depending on the platform. Otherwise you need to download ffmpeg from [here](https://github.com/yt-dlp/FFmpeg-Builds/releases) for windows/linux and from [here](http://www.osxexperts.net/) for mac (not tested)
3 years ago
To build for Linux (It will create packages as specified in package.json). The builds are stored in **release** folder.
```
npm run linux
4 years ago
```
3 years ago
4 years ago
To build for Windows
3 years ago
4 years ago
```
npm run windows
```
3 years ago
To build for macOS
3 years ago
```
npm run mac
```
If you only want to build for one format, you can do
```
npx electron-builder -l appimage
```
1 year ago
It will just create a linux appimage build.