From 210fe928fdabe117337b6eda3992ecd57f4d6fd6 Mon Sep 17 00:00:00 2001
From: Philipp Wolfer <ph.wolfer@gmail.com>
Date: Mon, 15 Jan 2024 07:34:42 +0100
Subject: [PATCH] Update config.example.toml

Add spotify-history and listenbrainz check-duplicate-listens. Clarify
documentation.
---
 config.example.toml | 38 +++++++++++++++++++++++++++++++-------
 1 file changed, 31 insertions(+), 7 deletions(-)

diff --git a/config.example.toml b/config.example.toml
index 11930a2..6a5eb88 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -11,6 +11,13 @@ backend  = "listenbrainz"
 username = ""
 # Your ListenBrainz access token from https://listenbrainz.org/profile/
 token    = ""
+# If true, for each listen to submit it is checked whether this listen already
+# exists on ListenBrainz. For this similar listens are searched at the listen
+# time +/- the duration of the track. The default is false and this check is not
+# perfomed. Note that this verification significanly slows down the import and
+# is only recommended if you are importing historic listens which might or might
+# not already exists in your ListenBrainz profile.
+check-duplicate-listens = false
 
 [service.maloja]
 # Maloja is a self hosted listening service (https://github.com/krateng/maloja)
@@ -46,8 +53,9 @@ token      = ""
 [service.scrobbler-log]
 # Read or write listens from a Rockbox .scobbler.log file
 backend         = "scrobbler-log"
-# The file path to the .scrobbler.log file
-file-path       = "data/.scrobbler.log"
+# The file path to the .scrobbler.log file. Relative paths are resolved against
+# the current working directory when running scotty.
+file-path       = "./.scrobbler.log"
 # If true, reading listens from the file also returns listens marked as "skipped"
 include-skipped = true
 # If true (default), new listens will be appended to the existing file. Set to
@@ -57,16 +65,17 @@ append          = true
 [service.jspf]
 # Write listens and loves to JSPF playlist files (https://xspf.org/jspf)
 backend    = "jspf"
-# The file path to the XSPF file
-file-path  = "data/playlist.jspf"
+# The file path to the JSPF file. Relative paths are resolved against
+# the current working directory when running scotty.
+file-path  = "./playlist.jspf"
 # If true (default), new listens will be appended to the existing file. Set to
 # false to overwrite the file and create a new JSPF playlist on every run.
 append     = true
-# Title of the playlist
+# Title of the playlist. Not used in append mode.
 title      = "My Playlist"
-# Creator of the playlist (only informational)
+# Creator of the playlist (only informational). Not used in append mode.
 username   = ""
-# A unique identifier for your playlist
+# A unique identifier for your playlist. Not used in append mode.
 identifier = ""
 
 [service.spotify]
@@ -79,6 +88,21 @@ backend       = "spotify"
 client-id     = ""
 client-secret = ""
 
+[service.spotify-history]
+# Read listens from a Spotify extended history export
+backend          = "spotify-history"
+# Directory where the extended history JSON files are located. The files must
+# follow the naming scheme "Streaming_History_Audio_*.json".
+dir-path         = "./my_spotify_data_extended/Spotify Extended Streaming History"
+# If true (default), ignore listens from a Spotify "private session".
+ignore-incognito = true
+# If true, ignore listens marked as skipped. Default is false.
+ignore-skipped   = false
+# Only consider skipped listens with a playback duration longer than this number
+# of seconds. Default is 30 seconds. If ignore-skipped is set to false this
+# setting has no effect.
+ignore-min-duration-seconds = 30
+
 [service.deezer]
 # Read listens and loves from a Deezer account
 backend       = "deezer"