|
1 | 1 | # Tubifarry for Lidarr 🎶 |
2 | 2 |      |
3 | 3 |
|
4 | | -This plugin fetches metadata from **Spotify** and **YouTube** to download music directly from YouTube. It builds on the groundwork laid by trevTV's projects and utilizes the YouTube API for seamless integration. 🛠️ |
| 4 | +Tubifarry is a plugin for **Lidarr** that fetches metadata from **Spotify** and **YouTube**, enabling direct music downloads from YouTube. Built on the foundation of trevTV's projects, it leverages the YouTube API for smooth integration. 🛠️ |
5 | 5 |
|
6 | 6 | --- |
7 | 7 |
|
8 | 8 | ## Installation 🚀 |
9 | | -To use Tubifarry, your Lidarr setup must be on the `plugins` branch. Below is a detailed guide to get started. |
| 9 | +To use Tubifarry, ensure your Lidarr setup is on the `plugins` branch. Follow the steps below to get started. |
10 | 10 |
|
11 | 11 | ### Docker Setup (Hotio Image) 🐳 |
12 | | -Here’s the Docker path for Hotio's image: |
| 12 | +For Docker users using Hotio's image, use the following path: |
13 | 13 | ```yml |
14 | 14 | image: ghcr.io/hotio/lidarr:pr-plugins |
15 | 15 | ``` |
16 | 16 |
|
| 17 | +### Non-Docker Installation |
| 18 | +To switch to the Plugins Branch: |
| 19 | +1. Open Lidarr and navigate to `System -> General`. |
| 20 | +2. Scroll down to the **Branch** section. |
| 21 | +3. Replace "master" with "plugins". |
| 22 | +4. Force an update check to update Lidarr to the plugins branch. |
| 23 | + |
17 | 24 | --- |
18 | 25 |
|
19 | 26 | ### Prerequisites ⚙️ |
20 | | -1. **FFmpeg**: FFmpeg is **required** for converting downloaded files to MP3 format. Ensure FFmpeg is installed and available on Windows system PATH or the specified ffmpeg path. If not, you can attempt to download it automatically during setup. Without FFmpeg, many songs fail to process correctly because they are downloaded as MP4 files, and TagLib cannot add metadata to MP4 formats. |
| 27 | +1. **FFmpeg**: FFmpeg is **essential** for converting downloaded files to MP3 format. Ensure FFmpeg is installed and accessible in your system's PATH or the specified FFmpeg path. If not, you can attempt to download it automatically during setup. Without FFmpeg, many songs may fail to process correctly, as they are downloaded as MP4 files, and TagLib cannot add metadata to MP4 formats. |
| 28 | + |
| 29 | +2. **Max Audio Quality**: Tubifarry supports a maximum audio quality of **256kb/s** for downloaded files. However, most files are in **MP3-VBR-V0** format. |
21 | 30 |
|
22 | | -2. **Max Audio Quality**: Tubifarry supports a maximum audio quality of **128 kb/s** for downloaded files. Ensure your settings align with this for optimal performance. |
| 31 | + **What is MP3-VBR-V0?** |
| 32 | + MP3-VBR-V0 is a high-quality audio format that uses **Variable Bitrate (VBR)** to optimize both sound quality and file size. Unlike a fixed bitrate (e.g., 128kb/s), VBR adjusts the bitrate dynamically based on the complexity of the audio. For example, it uses a higher bitrate for detailed parts of a song (like a chorus) and a lower bitrate for simpler parts (like silence). |
23 | 33 |
|
24 | 34 | --- |
25 | 35 |
|
26 | 36 | ### Plugin Installation 📥 |
| 37 | + |
| 38 | +#### **For Docker Users**: |
27 | 39 | 1. **Install the Plugin**: |
28 | | - - In Lidarr, navigate to `System -> Plugins`. |
29 | | - - Paste `https://github.com/TypNull/Tubifarry` into the GitHub URL box and press **Install**. |
| 40 | + - In Lidarr, go to `System -> Plugins`. |
| 41 | + - Paste `https://github.com/TypNull/Tubifarry` into the GitHub URL box and click **Install**. |
30 | 42 |
|
31 | 43 | 2. **Configure the Indexer**: |
32 | | - - Go to `Settings -> Indexers` and press **Add**. |
33 | | - - In the modal, select `Tubifarry` (found under **Other** at the bottom). |
| 44 | + - Navigate to `Settings -> Indexers` and click **Add**. |
| 45 | + - In the modal, select `Tubifarry` (located under **Other** at the bottom). |
34 | 46 |
|
35 | 47 | 3. **Set Up the Download Client**: |
36 | | - - Go to `Settings -> Download Clients` and press **Add**. |
| 48 | + - Go to `Settings -> Download Clients` and click **Add**. |
37 | 49 | - In the modal, choose `Youtube` (under **Other** at the bottom). |
38 | | - - Set the download path and adjust other settings to your preference. |
39 | | - |
40 | | -4. **Enable Tubifarry in Delay Profiles**: |
41 | | - - Go to `Settings -> Profiles -> Delay Profiles`. |
42 | | - - For each profile, click the **wrench icon** on the right and enable Tubifarry. |
| 50 | + - Set the download path and adjust other settings as needed. |
| 51 | + - **Important**: Ensure the FFmpeg path is correctly configured! |
43 | 52 |
|
44 | 53 | --- |
45 | 54 |
|
46 | 55 | ### Troubleshooting 🛠️ |
47 | | -- **FFmpeg Issues**: If songs fail to process, ensure FFmpeg is correctly installed and accessible in your system's PATH. If not, try reinstalling or downloading it manually. |
48 | | -- **MP4 Metadata**: If metadata is not being added to downloaded files, verify that FFmpeg is converting files to MP3 format. MP4 files are not supported for metadata tagging by TagLib. |
| 56 | +- **FFmpeg Issues**: If songs fail to process, verify that FFmpeg is correctly installed and accessible in your system's PATH. If not, try reinstalling or downloading it manually. |
| 57 | +- **MP4 Metadata**: If metadata is not being added to downloaded files, confirm that FFmpeg is converting files to MP3 format (check debug logs). MP4 files are not supported for metadata tagging by TagLib. |
49 | 58 | - **Audio Quality**: Ensure the maximum audio quality is set to **128 kb/s** in your settings to avoid compatibility issues. |
50 | 59 |
|
51 | 60 | --- |
52 | 61 |
|
53 | 62 | ## Acknowledgments 🙌 |
54 | | -Special thanks to **trevTV** for the groundwork with [Lidarr.Plugin.Tidal](https://github.com/TrevTV/Lidarr.Plugin.Tidal), [Lidarr.Plugin.Deezer](https://github.com/TrevTV/Lidarr.Plugin.Deezer), and [Lidarr.Plugin.Qobuz](https://github.com/TrevTV/Lidarr.Plugin.Qobuz). Additionally, thanks to [IcySnex/YouTubeMusicAPI](https://github.com/IcySnex/YouTubeMusicAPI) for providing the YouTube API. 🎉 |
| 63 | +Special thanks to **trevTV** for laying the groundwork with [Lidarr.Plugin.Tidal](https://github.com/TrevTV/Lidarr.Plugin.Tidal), [Lidarr.Plugin.Deezer](https://github.com/TrevTV/Lidarr.Plugin.Deezer), and [Lidarr.Plugin.Qobuz](https://github.com/TrevTV/Lidarr.Plugin.Qobuz). Additionally, thanks to [IcySnex/YouTubeMusicAPI](https://github.com/IcySnex/YouTubeMusicAPI) for providing the YouTube API. 🎉 |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +## Contributing 🤝 |
| 68 | +If you'd like to contribute to Tubifarry, feel free to open issues or submit pull requests on the [GitHub repository](https://github.com/TypNull/Tubifarry). Your feedback and contributions are highly appreciated! |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +## License 📄 |
| 73 | +Tubifarry is licensed under the MIT License. See the [LICENSE](https://github.com/TypNull/Tubifarry/blob/main/LICENSE) file for more details. |
| 74 | + |
| 75 | +--- |
55 | 76 |
|
| 77 | +Enjoy seamless music downloads with Tubifarry! 🎧 |
0 commit comments