mirror of
https://github.com/fiso64/slsk-batchdl.git
synced 2024-12-23 06:52:42 +00:00
update readme
This commit is contained in:
parent
d5c42ad8b8
commit
dfe7fb7c23
2 changed files with 15 additions and 8 deletions
12
README.md
12
README.md
|
@ -1,6 +1,6 @@
|
||||||
# slsk-batchdl
|
# 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
|
## Index
|
||||||
- [Options](#options)
|
- [Options](#options)
|
||||||
|
@ -250,7 +250,7 @@ Create an app and add http://localhost:48721/callback as a redirect url in its s
|
||||||
|
|
||||||
### Bandcamp
|
### Bandcamp
|
||||||
An bandcamp url: Download a single track, and album, or an artist's entire discography.
|
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.
|
number of visible tracks on the bandcamp page.
|
||||||
|
|
||||||
### Search string
|
### Search string
|
||||||
|
@ -314,9 +314,9 @@ will be ignored.
|
||||||
### Search Query
|
### Search Query
|
||||||
The search query is determined as follows:
|
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'
|
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'
|
Otherwise, search for 'Artist Album'
|
||||||
|
|
||||||
### Soulseek's rate limits
|
### Soulseek's rate limits
|
||||||
|
@ -395,6 +395,9 @@ tag1 is null, use tag2. String literals enclosed in parentheses are ignored in t
|
||||||
- "{artist( - )title|filename}"
|
- "{artist( - )title|filename}"
|
||||||
If artist and title are not null, name it 'Artist - Title', otherwise use the original
|
If artist and title are not null, name it 'Artist - Title', otherwise use the original
|
||||||
filename.
|
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:
|
### Available variables:
|
||||||
```
|
```
|
||||||
|
@ -410,6 +413,7 @@ salbum Source album name
|
||||||
year Track year or date
|
year Track year or date
|
||||||
track Track number
|
track Track number
|
||||||
disc Disc number
|
disc Disc number
|
||||||
|
filename Soulseek filename without extension
|
||||||
foldername Soulseek folder name (only available for album downloads)
|
foldername Soulseek folder name (only available for album downloads)
|
||||||
default-foldername Default sldl folder name
|
default-foldername Default sldl folder name
|
||||||
extractor Name of the extractor used (CSV/Spotify/YouTube/etc)
|
extractor Name of the extractor used (CSV/Spotify/YouTube/etc)
|
||||||
|
|
|
@ -286,9 +286,9 @@ public static class Help
|
||||||
Search Query
|
Search Query
|
||||||
The search query is determined as follows:
|
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'
|
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'
|
Otherwise, search for 'Artist Album'
|
||||||
|
|
||||||
Soulseek's rate limits
|
Soulseek's rate limits
|
||||||
|
@ -369,6 +369,9 @@ public static class Help
|
||||||
""{artist( - )title|filename}""
|
""{artist( - )title|filename}""
|
||||||
If artist and title are not null, name it 'Artist - Title', otherwise use the original
|
If artist and title are not null, name it 'Artist - Title', otherwise use the original
|
||||||
filename.
|
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:
|
Available variables:
|
||||||
artist First artist (from the file tags)
|
artist First artist (from the file tags)
|
||||||
|
|
Loading…
Reference in a new issue