mirror/slsk-batchdl
1
0
Fork 0
mirror of https://github.com/fiso64/slsk-batchdl.git synced 2025-01-09 15:02:43 +00:00
Code Issues Activity

update readme

Browse source
This commit is contained in:
fiso64 2024-12-23 12:02:27 +01:00
parent b5e7e58a9c
commit 33cfca6177
2 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -13,7 +13,7 @@ See the [usage examples](#examples-1).
- [Spotify](#spotify) - [Spotify](#spotify)
- [Bandcamp](#bandcamp) - [Bandcamp](#bandcamp)
- [Search string](#search-string) - [Search string](#search-string)
- [List](#list) - [List file](#list-file)
- [Download modes](#download-modes) - [Download modes](#download-modes)
- [Normal](#normal) - [Normal](#normal)
- [Album](#album) - [Album](#album)
@ -279,6 +279,7 @@ The following properties are accepted: title, artist, album, length (in seconds)
artist-maybe-wrong, album-track-count. artist-maybe-wrong, album-track-count.
Example inputs: Example inputs:
```
| Input String | Artist | Title | Album | Length | | Input String | Artist | Title | Album | Length |
|-----------------------------------------|----------|----------|----------|--------| |-----------------------------------------|----------|----------|----------|--------|
| Foo Bar (without hyphens) | | Foo Bar | | | | Foo Bar (without hyphens) | | Foo Bar | | |
@ -286,8 +287,8 @@ Example inputs:
| Foo - Bar (with --album) | Foo | | Bar | | | Foo - Bar (with --album) | Foo | | Bar | |
| Artist - Title, length=42 | Artist | Title | | 42 | | Artist - Title, length=42 | Artist | Title | | 42 |
| artist=AR, title=T, album=AL | AR | T | AL | | | artist=AR, title=T, album=AL | AR | T | AL | |
```
### List ### List file
List input must be manually activated with `--input-type=list`. The input is a path to a text List input must be manually activated with `--input-type=list`. The input is a path to a text
file containing lines of the following form: file containing lines of the following form:
```bash ```bash
@ -313,14 +314,15 @@ string or csv row has no track title, or when `-a/--album` is enabled.
With `-g/--aggregate`, sldl performs an ordinary search for the input, then attempts to With `-g/--aggregate`, sldl performs an ordinary search for the input, then attempts to
group the results into distinct songs and download one of each, starting with the one shared group the results into distinct songs and download one of each, starting with the one shared
by the most users. Note that `--min-shares-aggregate` is 2 by default, meaning that songs by the most users. Note that `--min-shares-aggregate` is 2 by default, meaning that songs
shared by only one user will be ignored. shared by only one user will be ignored. Aggregate mode can be used to (for example) download
all songs by an artist.
### Album Aggregate ### Album Aggregate
Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and
download one of each distinct album, starting with the one shared by the most users. It is download one of each distinct album, starting with the one shared by the most users. Note
recommended to pair this with `--interactive`. Note that `--min-shares-aggregate` is 2 by that `--min-shares-aggregate` is 2 by default, meaning that albums shared by only one user
default, meaning that albums shared by only one user will be ignored. will be ignored. Album-aggregate mode can be used to (for example) download all albums by an
artist. It is recommended to pair it with `--interactive`.
## Searching ## Searching

10
slsk-batchdl/Help.cs
View file

@ -287,13 +287,15 @@ public static class Help
With `-g/--aggregate`, sldl performs an ordinary search for the input, then attempts to With `-g/--aggregate`, sldl performs an ordinary search for the input, then attempts to
group the results into distinct songs and download one of each, starting with the one shared group the results into distinct songs and download one of each, starting with the one shared
by the most users. Note that `--min-shares-aggregate` is 2 by default, meaning that songs by the most users. Note that `--min-shares-aggregate` is 2 by default, meaning that songs
shared by only one user will be ignored. shared by only one user will be ignored. Aggregate mode can be used to (for example) download
all songs by an artist.
Album Aggregate Album Aggregate
Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and Activated when both `--album` and `--aggregate` are enabled. sldl will group shares and
download one of each distinct album, starting with the one shared by the most users. It is download one of each distinct album, starting with the one shared by the most users. Note
recommended to pair this with `--interactive`. Note that `--min-shares-aggregate` is 2 by that `--min-shares-aggregate` is 2 by default, meaning that albums shared by only one user
default, meaning that albums shared by only one user will be ignored. will be ignored. Album-aggregate mode can be used to (for example) download all albums by an
artist. It is recommended to pair it with `--interactive`.
"; ";
const string searchHelp = @" const string searchHelp = @"