multiplatform-lyric-downloader/.env.example at main · tappyduckmancodes/multiplatform-lyric-downloader · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# ============================================================
# multiplatform-lyric-downloader -- .env configuration
# ============================================================
# Run setup_wizard.py (or setup.bat) to fill this in interactively.
# NEVER commit this file to git -- it contains your credentials.
# ============================================================


# ------------------------------------------------------------
# Spotify API Keys  (resolver -- gets track lists from Spotify URLs)
# ------------------------------------------------------------
# Create a free developer app at https://developer.spotify.com/dashboard
# Set a Redirect URI in the app settings matching SPOTIFY_REDIRECT_URI below.
#
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
# IMPORTANT: Spotify no longer accepts 'localhost' as a redirect URI.
# Use your machine's LAN IP address (run setup_wizard.py to auto-detect it).
# Add this exact URL to your Spotify app: developer.spotify.com → Edit Settings → Redirect URIs
# Example: SPOTIFY_REDIRECT_URI=http://192.168.1.50:8888/callback
SPOTIFY_REDIRECT_URI=


# ------------------------------------------------------------
# Spotify Lyrics Token  (lyrics plugin -- fetches synced lyrics)
# ------------------------------------------------------------
# Separate from the API keys above. Required to fetch Spotify lyrics.
# Lasts ~1 hour, then you will be prompted to refresh it.
#
# How to get:
#   1. Open https://open.spotify.com and play any song
#   2. DevTools (F12) -> Network tab -> filter: color-lyrics
#   3. Click the request -> Headers -> copy 'authorization' value
#   You can paste the full "Bearer BQA..." string -- prefix stripped automatically
#
# NOTE: sp_dc cookie auth is permanently removed. Spotify added TLS fingerprinting
#       in 2024 and that method no longer works. Bearer token is the only option.
#
SPOTIFY_AUTH_TOKEN=


# ------------------------------------------------------------
# Deezer ARL Cookie  (resolver + lyrics plugin)
# ------------------------------------------------------------
# Covers both resolving track lists from Deezer URLs AND fetching lyrics.
# Excellent non-English coverage (K-pop, J-pop, Latin, Arabic, etc.)
# Lasts ~3 months.
#
# How to get:
#   1. Open https://www.deezer.com and log in
#   2. DevTools (F12) -> Application -> Cookies -> deezer.com
#   3. Copy the value of the 'arl' cookie
#
DEEZER_ARL=


# ------------------------------------------------------------
# YouTube Music resolver  (optional -- music.youtube.com URLs only)
# ------------------------------------------------------------
# Leave blank for public content. For private playlists:
#   pip install ytmusicapi
#   ytmusicapi browser   (generates a headers file)
# Then set this to the path of that file.
#
YTMUSIC_AUTH_HEADERS=


# ------------------------------------------------------------
# Source priority order  (written by setup_wizard.py)
# ------------------------------------------------------------
# YouTube cookie authentication (optional)
# Needed for age-restricted videos or private YouTube Music content.
#
# Option A — read directly from your browser (recommended, no export needed):
#   Supported browsers: chrome, firefox, edge, brave, opera, chromium, safari
YTDLP_BROWSER=
#
# Option B — path to a Netscape-format cookies.txt file:
#   Export with a browser extension like "Get cookies.txt LOCALLY"
YTDLP_COOKIES_FILE=

# ------------------------------------------------------------
# Edit manually to reorder without re-running the wizard.
# Comma-separated. First = highest priority.
#
# RESOLVER_ORDER: which service provides track metadata
#   Available: Spotify, Deezer, YouTube, Tidal (pip install tidalapi),
#              YouTube Music (pip install ytmusicapi)
#
RESOLVER_ORDER=Spotify,Deezer,YouTube

# PLUGIN_ORDER: which lyrics database is tried first (waterfall)
#   Available: Spotify, Deezer, LRCLIB, Musixmatch, YouTube (pip install yt-dlp)
#
PLUGIN_ORDER=Spotify,Deezer,LRCLIB,Musixmatch,YouTube

# NOTE: Runtime cache files (tokens, sessions) are stored in .cache/
# Delete .cache/ to force re-authentication on next run.

# Optional: Musixmatch usertoken
MUSIXMATCH_TOKEN=