Skip to content

Commit e35a8e7

Browse files
committed
upd readme
1 parent bbfc396 commit e35a8e7

3 files changed

Lines changed: 41 additions & 8 deletions

File tree

README.md

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -656,26 +656,55 @@ sockseek "artist=MC MENTAL" --song -g --skip-music-dir "path/to/music" --print r
656656
```
657657

658658
### Advanced example: Automatic wishlist downloader
659-
Create a file named `wishlist.txt`, and add some items as detailed in [Input types: List](#list-file):
659+
Create a file named `wishlist.txt`, and add some items as explained in [List Input](#list-file):
660+
660661
```
661-
"Artist - Some Album" strict-album=true;album-track-count=5
662+
"Artist - Some Album"
663+
"Artist - Album With Conditions" strict-album=true;album-track-count>=5
664+
"Another Album" banned-users=user-sharing-bad-files
665+
"Album With Pref. Conditions" format=mp3,flac format=flac
666+
662667
s:"Artist - My Favorite Song" strict-title=true;format=flac
663668
```
669+
664670
Add a profile to your `sockseek.conf`:
671+
665672
```ini
666673
[wishlist]
674+
# Will look for wishlist.txt in the same folder as your sockseek.conf
667675
input = {configdir}/wishlist.txt
668676
input-type = list
669-
index-path = {configdir}/wishlist-index.csv
670677
log-file = {configdir}/wishlist.log
678+
679+
# The index will keep track of successfully downloaded items to skip
680+
# them in the next runs:
681+
index-path = {configdir}/wishlist-index.csv
682+
# You can also make it remove the lines from wishlist.txt directly:
683+
# remove-from-source = true
684+
685+
# Add some global wishlist conditions, if you want:
686+
format = flac,mp3
687+
min-bitrate = 200
688+
689+
# To keep searching for a flac version of "Album With Pref. Conditions"
690+
# in the above list even after an mp3 version has been downloaded, make
691+
# it check the local version:
692+
693+
# skip-check-pref-cond = true
694+
695+
# Note that this requires the downloaded files to remain in the same
696+
# spot or for the index to be updated after any moves, e.g. via
697+
# on-complete update-index.
671698
```
672-
This will create a global index file `wishlist-index.csv` which will be scanned every time Sockseek is run to skip wishlist items that have already been downloaded. If you want to continue searching until a version satisfying the preferred conditions is found, also add `skip-check-pref-cond = true` (note that this requires the files to remain in the same spot after being downloaded).
673699

674-
Now you can manually run, or set up a cron job / scheduled task to periodically run Sockseek with the following option:
700+
Now set up a cron job / scheduled task to periodically run Sockseek with the following option:
701+
675702
```bash
676703
sockseek --profile wishlist
677704
```
678705

706+
You can also just manually run it, e.g. with `-t` (interactive mode).
707+
679708
<!-- sockseek-help:start(notes-and-tips) -->
680709
## Notes
681710
- **Soulseek's rate limits**: The server bans users for 30 minutes if too many searches are performed within a short timespan. Sockseek has a search limiter which can be adjusted with `--searches-per-time` and `--searches-renew-time` (when the limit is reached, the status of the downloads will be 'Waiting'). By default it is configured to allow up to 34 searches every 220 seconds.
@@ -768,7 +797,9 @@ Most used flags at a glance:
768797
--no-skip-existing Do not skip downloaded tracks
769798
--skip-mode-output-dir <mode> How to match files in the output dir: name|tag|index
770799
(default: index)
771-
--skip-check-cond Check file conditions when skipping existing files
800+
--skip-check-cond Check file conditions when skipping existing files. If the
801+
local candidate does not exist or does not satisfy the
802+
required conditions, the item will not be skipped.
772803
--skip-check-pref-cond Check preferred conditions when skipping existing files
773804
--skip-music-dir <path> Also skip downloading tracks found in a music library
774805
--skip-mode-music-dir <mode> How to match files in --skip-music-dir: name|tag

Sockseek.Cli/Help.Content.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ General Options
5656
--no-skip-existing Do not skip downloaded tracks
5757
--skip-mode-output-dir <mode> How to match files in the output dir: name|tag|index
5858
(default: index)
59-
--skip-check-cond Check file conditions when skipping existing files
59+
--skip-check-cond Check file conditions when skipping existing files. If the
60+
local candidate does not exist or does not satisfy the
61+
required conditions, the item will not be skipped.
6062
--skip-check-pref-cond Check preferred conditions when skipping existing files
6163
--skip-music-dir <path> Also skip downloading tracks found in a music library
6264
--skip-mode-music-dir <mode> How to match files in --skip-music-dir: name|tag

docs/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "Sockseek daemon API",
55
"description": "HTTP API for the Sockseek daemon.",
6-
"version": "3.0.3"
6+
"version": "3.0.4"
77
},
88
"paths": {
99
"/api/server/info": {

0 commit comments

Comments
 (0)