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.
ytdl-android/README.md

143 lines
7.6 KiB
Markdown

<h1 align="center">
<img src="fastlane/metadata/android/en-US/images/icon.png" width="25%" /> <br>
YTDLnis
</h1>
<div align="center">
English
&nbsp;&nbsp;| &nbsp;&nbsp;
<a href="https://github.com/deniscerri/ytdlnis/blob/main/README-sq.md">Shqip</a>
&nbsp;&nbsp;| &nbsp;&nbsp;
<a href="https://github.com/deniscerri/ytdlnis/blob/main/README-az.md">Azərbaycanca</a>
&nbsp;&nbsp;| &nbsp;&nbsp;
<a href="https://github.com/deniscerri/ytdlnis/blob/main/README-id.md">Indonesia</a>
&nbsp;&nbsp;| &nbsp;&nbsp;
<a href="https://github.com/deniscerri/ytdlnis/blob/main/README-pt.md">Português</a>
</div>
<h3 align="center">
YTDLnis is a free and open source video/audio downloader using yt-dlp for Android 6.0 and above.
</h3>
<h4 align="center">
[Created by Denis Çerri. Currently being maintained by zaednasr]
</h4>
<div align="center">
[![Github Download](https://custom-icon-badges.herokuapp.com/badge/Download-blue?style=for-the-badge&logo=download&logoColor=white)](https://github.com/deniscerri/ytdlnis/releases/latest)
[![IzzyOnDroid Repo](https://custom-icon-badges.herokuapp.com/badge/IzzyOnDroid%20Repo-red?style=for-the-badge&logo=download&logoColor=white)](https://android.izzysoft.de/repo/apk/com.deniscerri.ytdl)
[![UpToDown](https://custom-icon-badges.herokuapp.com/badge/UpToDown-green?style=for-the-badge&logo=download&logoColor=white)](https://ytdlnis.en.uptodown.com/android/download)
![CI](https://github.com/deniscerri/ytdlnis/actions/workflows/android.yml/badge.svg?branch=main&event=pull)
[![preview release](https://img.shields.io/github/release/deniscerri/ytdlnis.svg?maxAge=3600&include_prereleases&label=preview)](https://github.com/deniscerri/ytdlnis/releases)
[![downloads](https://img.shields.io/github/downloads/deniscerri/ytdlnis/total?style=flat-square)](https://github.com/deniscerri/ytdlnis/releases)
[![Translation status](https://hosted.weblate.org/widgets/ytdlnis/-/svg-badge.svg)](https://hosted.weblate.org/engage/ytdlnis/?utm_source=widget)
[![community](https://img.shields.io/badge/Discord-YTDLnis-blueviolet?style=flat-square&logo=discord)](https://discord.gg/WW3KYWxAPm)
[![community](https://img.shields.io/badge/Telegram-YTDLnis-blue?style=flat-square&logo=telegram)](https://t.me/ytdlnis)
[![community](https://img.shields.io/badge/Telegram-Updates-red?style=flat-square&logo=telegram)](https://t.me/ytdlnisupdates)
### The links above are the only trusted sources of YTDLnis. Everything else is not related to me.
</div>
## 💡 Features:
- download audio/video files from more than <a href="https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md">1000 websites</a>
- process playlists
- edit every playlist item separately just like in a normal download item.
- select a common format for all items and/or select multiple audio formats in case you are downloading them as a video
- select a download path for all items
- select a filename template for all items
- batch update download type to audio/video/custom command in one click
- queue downloads and schedule them by date and time
- you can also schedule multiple items at the same time
- download multiple items at the same time
- use custom commands and templates or go full yt-dlp mode with a built in terminal
- you can backup and restore templates, so you can share with your buddies
- COOKIES support. Log in with your accounts and download private/unavailable videos, unlock premium formats etc.
- cut videos based on timestamps and video chapters (This yt-dlp feature is experimental on the original project)
- you can make unlimited cuts
- remove sponsorblock elements from the item
- embed them as a chapters in your video
- embed subtitles/metadata/chapters etc
- modify metadata such as title and author
- split item into separate files depending on its chapters
- select different download formats
- bottom card right from the share menu, no need to open the app
- you can create a txt file and fill it with links/playlists/search queries separate by a new line and the app will process them
- search or insert a link from the app
- you can stack searches so you can process them at the same time
- log downloads in case of problems
- re-download cancelled or failed downloads
- you can use gestures to swipe left to redownload and right to delete
- you can long click the redownload button in the details sheet to show the download card for more functionality
- incognito mode when you don't want to save a download history or logs
- quick download mode
- download immediately without having to wait for data to process. Turn off the bottom card and it will instantly start
- open / share downloaded files right from the finished notification
- most yt-dlp features are implemented, suggestions are welcome
- Material You interface
- Theming options
- Backup and restore features. (Almost everything can be backed up)
- MVVM Architecture w/ WorkManager
## 📲 Screenshots
<div>
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/01.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/02.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/03.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/04.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/05.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/06.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/07.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/08.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/09.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/10.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/11.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/12.png" width="30%" />
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/13.png" width="90%" />
</div>
## 💬 Contact
Join our [Telegram Channel](https://t.me/ytdlnis) or [Discord](https://discord.gg/WW3KYWxAPm) for discussion, announcements, and releases!
## 🔑 Connect with ReVanced
The App's package name is "com.deniscerri.ytdl"
## 📝 Help Translate on Weblate
<a href="https://hosted.weblate.org/engage/ytdlnis/">
<img src="https://hosted.weblate.org/widgets/ytdlnis/-/strings/open-graph.png" alt="Translation status" />
</a>
<a href="https://hosted.weblate.org/engage/ytdlnis/">
<img src="https://hosted.weblate.org/widgets/ytdlnis/-/multi-auto.svg" alt="Translation status" />
</a>
## 😇 Contributing
If you would like to contribute. Please read the [Contributing](CONTRIBUTING.MD) section.
## 📄 License
[GNU GPL v3.0](https://github.com/deniscerri/ytdlnis/blob/main/LICENSE)
⚠️ Warning <br>
Except for the source code licensed under the GPLv3 license, all other parties are prohibited from using the 'YTDLnis' name as a downloader app, and the same is true for its derivatives. Derivatives include but are not limited to forks and unofficial builds.
## 🙏 Thanks
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) and its contributors for making this tool possible. Without it this app wouldn't exist.
- [youtubedl-android](https://github.com/yausername/youtubedl-android) for porting yt-dlp to android
- [dvd](https://github.com/yausername/dvd) for showing how to implement youtubedl-android
- [seal](https://github.com/JunkFood02/Seal) for certain design elements and features i wanted to use aswell in this app
- [decipher3114](https://github.com/decipher3114) for the app icon
and alot of other internet forum strangers.