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

155 lines
6.7 KiB
Markdown

4 years ago
# ytDownloader
[![Flathub](https://img.shields.io/flathub/downloads/io.github.aandrew_me.ytdn?label=Flathub%20downloads)](https://beta.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)
[![Flathub](https://img.shields.io/flathub/v/io.github.aandrew_me.ytdn)](https://beta.flathub.org/apps/io.github.aandrew_me.ytdn)
4 years ago
[![AUR version](https://img.shields.io/aur/version/ytdownloader-gui)](https://aur.archlinux.org/packages/ytdownloader-gui)
[![Snapcraft](https://badgen.net/snapcraft/v/ytdownloader)](https://snapcraft.io/ytdownloader)
3 years ago
![Chocolatey Version](https://img.shields.io/chocolatey/v/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
<a href="https://beta.flathub.org/apps/io.github.aandrew_me.ytdn"><img src="https://flathub.org/assets/badges/flathub-badge-en.svg" style="width:180px;"></a>
4 years ago
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/ytdownloader)
3 years ago
[![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://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>
3 years ago
<a href="https://github.com/aandrew-me/ytDownloader/releases/latest/download/YTDownloader_Mac.dmg"><img src="https://user-images.githubusercontent.com/66430340/189808142-0a4725c6-b167-4afd-98f1-dfcb16bfbd43.png" style="width:200px;"></a>
## Features 🚀
4 years ago
✅ Light/Dark mode
4 years ago
✅ Supports hundreds of sites including Youtube, Facebook, Instagram, Tiktok, Twitter and so on.
4 years ago
4 years ago
✅ Advanced options like Range Selection
4 years ago
4 years ago
✅ Download playlists
4 years ago
✅ Available on Linux, Windows & 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
![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
4 years ago
# Installation
## Windows 🪟
4 years ago
- **Traditional way**
4 years ago
4 years ago
Download and install the exe file. Windows defender may create problems as usual.
4 years ago
4 years ago
- **Chocolatey**
App can be installed from [Chocolatey](https://community.chocolatey.org/packages/ytdownloader) using the following command
```
choco install ytdownloader
```
4 years ago
4 years ago
4 years ago
## Linux 🐧
4 years ago
4 years ago
Linux has several options available - Flatpak, AppImage, Snap and AUR.
Flatpak is recommended.
- ### AppImage
**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.
- ### AUR package
The app is available in [AUR](https://aur.archlinux.org/packages/ytdownloader-gui) with the name `ytdownloader-gui`. To build with pamac the required command is -
```
pamac install ytdownloader-gui
```
Using yay
```
yay -S ytdownloader-gui
```
- ### Flatpak
```
flatpak install flathub io.github.aandrew_me.ytdn
4 years ago
```
- ### Snapcraft
```
sudo snap install ytdownloader
```
## macOS 🍎
Since the app is not signed, when you will try to open the app, macOS will not allow you to open it. So you will need to follow some steps to open it.
1. Click on **System Preferences** on your Mac Dock.
2. Choose **Security & Privacy**
3. The app will be shown there. Click on **Open**
## Internationalization (Localization) 🌍
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)
### ✅ Available languages
|Name |Status |
|--|--|
|English | ✔️ |
|Finnish | ✔️ |
4 years ago
|French | ✔️ |
|German | ✔️ |
|Greek | ✔️ |
|Italian | ✔️ |
|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) and others for helping.
4 years ago
## Used technologies
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
- [Electron](https://www.electronjs.org/)
- [ffmpeg](https://ffmpeg.org/)
- [nodeJS](https://nodejs.org/en/)
4 years ago
- [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.
```
git clone https://github.com/aandrew-me/ytDownloader.git
cd ytDownloader
npm i
```
To run with [Electron](https://www.electronjs.org/) :
```
npm start
4 years ago
```
4 years ago
To build for Linux (It will create packages as specified in package.json). The builds are stored in **release** folder. You need to be in a Linux environment to execute those scripts. Otherwise you can download the ffmpeg binary for the respective platform and put it in the root directory of the app and build with electron-builder.
```
npm run linux
4 years ago
```
4 years ago
To build for Windows
```
npm run windows
```
To build for macOS
```
npm run mac
```
3 years ago
## Donate
<a href="https://www.buymeacoffee.com/aandrew" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>