diff --git a/README.md b/README.md index ee6aee7..7230c9b 100644 --- a/README.md +++ b/README.md @@ -7,26 +7,41 @@ A batch downloader for Soulseek built with Soulseek.NET. Accepts CSV files or Sp Download tracks from a csv file: ``` slsk-batchdl test.csv -``` +``` +
+ CSV details + The names of the columns in the csv should be: `Artist`, `Title`, `Album`, `Length`. Some alternatives are also accepted. You can use `--print tracks` before downloading to check if everything has been parsed correctly. Only the title or album column is required, but additional info may improve search results. +
+
Download spotify likes while skipping songs that already exist in the output folder: ``` slsk-batchdl spotify-likes --skip-existing ``` +
+ Spotify details + To download private playlists or liked songs you will need to provide a client id and secret, which you can get here https://developer.spotify.com/dashboard/applications. Create an app and add `http://localhost:48721/callback` as a redirect url in its settings. +
+
Download from a youtube playlist with fallback to yt-dlp in case it is not found on soulseek, and retrieve deleted video titles from wayback machine: ``` slsk-batchdl --get-deleted --yt-dlp "https://www.youtube.com/playlist?list=PLI_eFW8NAFzYAXZ5DrU6E6mQ_XfhaLBUX" ``` +
+ YouTube details + Playlists are retrieved using the YoutubeExplode library which unfortunately doesn't always return all videos. You can use the official API by providing a key with `--youtube-key`. Get it here https://console.cloud.google.com. Create a new project, click "Enable Api" and search for "youtube data", then follow the prompts. Also note that due the high number of music videos in the above example playlist, it may be better to remove all text in parentheses and disable song duration checking: `--regex "[\[\(].*?[\]\)]" --length-tol -1 --pref-length-tol -1`. +
+
Search & download a specific song, preferring lossless: @@ -54,7 +69,7 @@ Depending on the provided input, the download behaviour changes: - Normal download: When the song title is set (in the CSV row, or in the string input), the program will download a single file for every entry. - Album download: When the album name is set and the song title is NOT set, the program will search for the album and download the entire folder. -- Aggregate download: With `--aggregate`, the program will first perform an ordinary search for the input, then attempt to group the results into distinct songs and download one of each kind. This can be used to download an artist's entire discography (or simply printing it, like in the example above). +- Aggregate download: With `--aggregate`, the program will first perform an ordinary search for the input, then attempt to group the results into distinct songs and download one of each kind. This can be used to download an artist's entire discography (or simply printing it, like in the example above), finding remixes of a song, etc. Note that it is not 100% reliable, which is why `--min-users-aggregate` is set to 2 by default, i.e. any song that is shared by only one person will be ignored. Enabling `--relax` will give even more results. ## Options ``` @@ -90,8 +105,8 @@ Options: -n --number Download the first n tracks of a playlist -o --offset Skip a specified number of tracks -r --reverse Download tracks in reverse order - --name-format Name format for downloaded tracks, e.g "{artist} - {title}" - --fast-search Begin downloading as soon as a file satisfying the preferred + --nf --name-format Name format for downloaded tracks, e.g "{artist} - {title}" + --fs --fast-search Begin downloading as soon as a file satisfying the preferred conditions is found. Increases chance to download bad files. --m3u