You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-31Lines changed: 45 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Tubifarry for Lidarr 🎶
2
2

3
3
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 seamless integration. 🛠️
4
+
Tubifarry is a versatile plugin for **Lidarr** that enhances your music library by fetching metadata from **Spotify** and enabling direct music downloads from **YouTube**. While it is not explicitly a Spotify-to-YouTube downloader, it leverages the YouTube API to seamlessly integrate music downloads into your Lidarr setup. Built on the foundation of trevTV's projects, Tubifarry also supports **Slskd**, the Soulseek client, as both an **indexer** and **downloader**, allowing you to tap into the vast music collection available on the Soulseek network. 🛠️
5
5
6
-
Additionally, Tubifarry supports fetching soundtracks from **Sonarr** (series) and **Radarr** (movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This allows you to easily manage and download soundtracks for your favorite movies and TV shows. 🎬🎵
6
+
Additionally, Tubifarry supports fetching soundtracks from **Sonarr** (series) and **Radarr** (movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This makes it easy to manage and download soundtracks for your favorite movies and TV shows. 🎬🎵
7
7
8
8
---
9
9
@@ -26,40 +26,39 @@ To switch to the Plugins Branch:
26
26
---
27
27
28
28
### Plugin Installation 📥
29
-
30
-
#### **For Docker Users**:
31
-
1. **Install the Plugin**:
32
-
- In Lidarr, go to `System -> Plugins`.
33
-
- Paste `https://github.com/TypNull/Tubifarry` into the GitHub URL box and click **Install**.
34
-
35
-
2. **Configure the Indexer**:
36
-
- Navigate to `Settings -> Indexers` and click **Add**.
37
-
- In the modal, select `Tubifarry` (located under **Other** at the bottom).
38
-
39
-
3. **Set Up the Download Client**:
40
-
- Go to `Settings -> Download Clients` and click **Add**.
41
-
- In the modal, choose `Youtube` (under **Other** at the bottom).
42
-
- Set the download path and adjust other settings as needed.
43
-
- **Optional**: If using FFmpeg, ensure the FFmpeg path is correctly configured.
29
+
- In Lidarr, go to `System -> Plugins`.
30
+
- Paste `https://github.com/TypNull/Tubifarry` into the GitHub URL box and click **Install**.
44
31
45
32
---
46
33
47
-
### Fetching Soundtracks from Sonarr and Radarr 🎬🎵
48
-
Tubifarry also supports fetching soundtracks from **Sonarr** (for TV series) and **Radarr** (for movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This allows you to easily manage and download soundtracks for your favorite movies and TV shows.
34
+
### Soulseek (Slskd) Setup 🎧
35
+
Tubifarry supports **Slskd**, the Soulseek client, as both an **indexer** and **downloader**. Follow the steps below to configure it.
49
36
50
-
To enable this feature:
51
-
1. **Set Up the Import List**:
52
-
- Navigate to `Settings -> Import Lists` in Lidarr.
53
-
- Add a new import list and select the option for **Arr-Soundtracks**.
54
-
- Configure the settings to match your Sonarr and Radarr instances.
55
-
- Provide a cache path to store responses from MusicBrainz for faster lookups.
37
+
#### **Setting Up the Soulseek Indexer**:
38
+
1. Navigate to `Settings -> Indexers` and click **Add**.
39
+
2. Select `Slskd` from the list of indexers.
40
+
3. Configure the following settings:
41
+
- **URL**: The URL of your Slskd instance (e.g., `http://localhost:5030`).
42
+
- **API Key**: The API key for your Slskd instance (found in Slskd's settings under 'Options').
43
+
- **Include Only Audio Files**: Enable to filter search results to audio files only (beta).
56
44
57
-
2. **Enjoy Soundtracks**:
58
-
- Once configured, Tubifarry will automatically fetch soundtracks from your Sonarr and Radarr libraries and add them to Lidarr for download and management.
45
+
#### **Setting Up the Soulseek Download Client**:
46
+
1. Go to `Settings -> Download Clients` and click **Add**.
47
+
2. Select `Slskd` from the list of download clients.
48
+
3. Set the **download path** where downloaded files will be downloaded.
59
49
60
50
---
61
51
62
-
### Optional: FFmpeg and Audio Quality 🎧
52
+
### YouTube Downloader Setup 🎥
53
+
Tubifarry allows you to download music directly from YouTube. Follow the steps below to configure the YouTube downloader.
54
+
55
+
#### **Setting Up the YouTube Download Client**:
56
+
1. Go to `Settings -> Download Clients` and click **Add**.
57
+
2. Select `Youtube` from the list of download clients.
58
+
3. Set the download path and adjust other settings as needed.
59
+
4. **Optional**: If using FFmpeg, ensure the FFmpeg path is correctly configured.
60
+
61
+
#### **FFmpeg and Audio Conversion**:
63
62
1. **FFmpeg**: FFmpeg can be used to extract audio from downloaded files, which are typically embedded in MP4 containers. If you choose to use FFmpeg, ensure it is installed and accessible in your system's PATH or the specified FFmpeg path. If not, the plugin does attempt to download it automatically during setup. Without FFmpeg, songs will be downloaded in their original format, which may not require additional processing.
64
63
65
64
**Important Note**: If FFmpeg is not used, Lidarr may incorrectly interpret the MP4 container as corrupt. While FFmpeg usage is **recommended**, it is not strictly necessary. However, to avoid potential issues, you can choose to extract audio without re-encoding, but this may lead to better compatibility with Lidarr.
@@ -76,6 +75,21 @@ To enable this feature:
76
75
77
76
---
78
77
78
+
### Fetching Soundtracks from Sonarr and Radarr 🎬🎵
79
+
Tubifarry also supports fetching soundtracks from **Sonarr** (for TV series) and **Radarr** (for movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This allows you to easily manage and download soundtracks for your favorite movies and TV shows.
80
+
81
+
To enable this feature:
82
+
1. **Set Up the Import List**:
83
+
- Navigate to `Settings -> Import Lists` in Lidarr.
84
+
- Add a new import list and select the option for **Arr-Soundtracks**.
85
+
- Configure the settings to match your Sonarr and Radarr instances.
86
+
- Provide a cache path to store responses from MusicBrainz for faster lookups.
87
+
88
+
2. **Enjoy Soundtracks**:
89
+
- Once configured, Tubifarry will automatically fetch soundtracks from your Sonarr and Radarr libraries and add them to Lidarr for download and management.
90
+
91
+
---
92
+
79
93
### Troubleshooting 🛠️
80
94
- **Optional: FFmpeg Issues**: If you choose to use FFmpeg and 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.
81
95
- **Metadata Issues**: If metadata is not being added to downloaded files, confirm that the files are in a supported format. If using FFmpeg, ensure it is extracting audio to formats like AAC embedded in MP4 containers (check debug logs).
@@ -90,7 +104,7 @@ To enable this feature:
90
104
---
91
105
92
106
## Acknowledgments 🙌
93
-
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. 🎉
107
+
Special thanks to [**trevTV**](https://github.com/TrevTV) for laying the groundwork with his plugins. Additionally, thanks to [**IcySnex**](https://github.com/IcySnex) for providing the YouTube API. 🎉
94
108
95
109
---
96
110
@@ -100,8 +114,8 @@ If you'd like to contribute to Tubifarry, feel free to open issues or submit pul
100
114
---
101
115
102
116
## License 📄
103
-
Tubifarry is licensed under the MIT License. See the [LICENSE](https://github.com/TypNull/Tubifarry/blob/main/LICENSE) file for more details.
117
+
Tubifarry is licensed under the MIT License. See the [LICENSE](https://github.com/TypNull/Tubifarry/blob/master/LICENSE) file for more details.
0 commit comments