From dfe7fb7c23829c78e20307daf9476ca408eda456 Mon Sep 17 00:00:00 2001 From: fiso64 Date: Tue, 27 Aug 2024 23:02:21 +0200 Subject: [PATCH] update readme --- README.md | 16 ++++++++++------ slsk-batchdl/Help.cs | 7 +++++-- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9bef7a9..e47e4ff 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # slsk-batchdl -A batch downloader for Soulseek built with Soulseek.NET. Accepts CSV files and Spotify or YouTube urls. +A batch downloader for Soulseek built with Soulseek.NET. Accepts CSV files as well as Spotify and YouTube urls. See [Examples](#examples-1). ## Index - [Options](#options) @@ -250,7 +250,7 @@ Create an app and add http://localhost:48721/callback as a redirect url in its s ### Bandcamp An bandcamp url: Download a single track, and album, or an artist's entire discography. -Extracts the artist name, album name and sets --album-track-count=""n+"", where n is the +Extracts the artist name, album name and sets --album-track-count="n+", where n is the number of visible tracks on the bandcamp page. ### Search string @@ -314,9 +314,9 @@ will be ignored. ### Search Query The search query is determined as follows: -- For album downloads: If the album field is non-empty, search for 'Artist Album' +- For album downloads: If the album field is non-empty, search for 'Artist Album'. Otherwise, search for 'Artist Title' -- For all other download types: If the title field is non-empty, search for 'Artist Title' +- For all other download types: If the title field is non-empty, search for 'Artist Title'. Otherwise, search for 'Artist Album' ### Soulseek's rate limits @@ -389,12 +389,15 @@ Name format supports subdirectories as well as conditional expressions like {tag tag1 is null, use tag2. String literals enclosed in parentheses are ignored in the null check. ### Examples: - - "{artist} - {title}" + - "{artist} - {title}" Always name it 'Artist - Title'. Because some files on Soulseek are untagged, the following is generally preferred: - - "{artist( - )title|filename}" + - "{artist( - )title|filename}" If artist and title are not null, name it 'Artist - Title', otherwise use the original filename. + - "{artist(/)album(/)track(. )title|(missing-tags/)filename}" + Sort files into artist/album folders if all tags are present, otherwise put them in + the 'missing-tags' folder. ### Available variables: ``` @@ -410,6 +413,7 @@ salbum Source album name year Track year or date track Track number disc Disc number +filename Soulseek filename without extension foldername Soulseek folder name (only available for album downloads) default-foldername Default sldl folder name extractor Name of the extractor used (CSV/Spotify/YouTube/etc) diff --git a/slsk-batchdl/Help.cs b/slsk-batchdl/Help.cs index ea399ef..51f796c 100644 --- a/slsk-batchdl/Help.cs +++ b/slsk-batchdl/Help.cs @@ -286,9 +286,9 @@ public static class Help Search Query The search query is determined as follows: - - For album downloads: If the album field is non-empty, search for 'Artist Album' + - For album downloads: If the album field is non-empty, search for 'Artist Album'. Otherwise, search for 'Artist Title' - - For all other download types: If the title field is non-empty, search for 'Artist Title' + - For all other download types: If the title field is non-empty, search for 'Artist Title'. Otherwise, search for 'Artist Album' Soulseek's rate limits @@ -369,6 +369,9 @@ public static class Help ""{artist( - )title|filename}"" If artist and title are not null, name it 'Artist - Title', otherwise use the original filename. + ""{artist(/)album(/)track(. )title|(missing-tags/)filename}"" + Sort files into artist/album folders if all tags are present, otherwise put them in + the 'missing-tags' folder. Available variables: artist First artist (from the file tags)