sptlrx(5)

🌸 NAME 🌸

sptlrx — synchronized lyrics, but make it your terminal 💖 like literally your fave songs singing along with you while you live your main character era.

---

📍 LOCATION 📍

okay so bestie, the config file creates itself on the very first launch 🎀 no setup arc needed. It lives right here:

~/.config/sptlrx/config.yaml

need the full path spelled out for you? just run sptlrx -h and it'll show you the whole thing 💅

---

🎧 SPOTIFY 🎧

✨ FORMAT ✨

# config.yaml
player: spotify

📝 NOTES 📝

so if you wanna use Spotify as your player, you gotta log in first. no skipping this part, bestie 🙈

1. Go to developer.spotify.com ⟨https://developer.spotify.com/dashboard⟩, create a new app, and set the redirect URI to http://127.0.0.1:8888/callback. Grab your Client ID and Client Secret. 👑
2. Run sptlrx login. You can pass Client ID and Client Secret in one of three ways:
   • As environmental variables: SPOTIFY_CLIENT_ID and SPOTIFY_CLIENT_SECRET 🌱
   • As CLI parameters: --client-id and --client-secret ⌨️
   • Interactively: run sptlrx login without providing credentials and you will be prompted to enter them 💬
3. Spotify login page will open. Log in and wait for the success message. ✨

You only need to do this once. Fr fr. Your credentials will then be saved to $XDG_STATE_HOME/sptlrx/spotify-auth.json 🫶

---

🎵 MPD 🎵

✨ FORMAT ✨

# config.yaml
player: mpd
mpd:
  address: 127.0.0.1:6600
  password: ""

---

🦋 MOPIDY 🦋

✨ FORMAT ✨

# config.yaml
player: mopidy
mopidy:
  address: 127.0.0.1:6680

---

🌈 MPRIS 🌈

✨ FORMAT ✨

# config.yaml
player: mpris
mpris:
  players: []

📝 NOTES 📝

A system player that supports the MPRIS protocol will be used, periodt. You can also specify a whitelist of players to use, example: players: [rhythmbox, spotifyd, ncspot]. Run playerctl -l to get the names 💖

---

🌐 BROWSER 🌐

✨ FORMAT ✨

# config.yaml
player: browser
browser:
  port: 8974

📝 NOTES 📝

You need to install a browser extension ⟨https://wnp.keifufu.dev/extension/getting-started⟩ 🧚

If you don't change the default port, no further configuration is required — iconic. Otherwise, create a custom adapter in the extension settings. You can only run one instance on one port. That's the rule bestie, no cap 💀

---

📁 LOCAL 📁

✨ FORMAT ✨

# config.yaml
local:
  folder: ""

📝 NOTES 📝

If you wanna use your local collection of .lrc files to display lyrics, specify the folder to scan. The application will use files with the most similar name. All other lyrics sources will be disabled 🎀

---

okay that's the whole page bestie, you ate that 💅 This was sptlrx from the File Formats Manual, section 5, and the page signs off as sptlrx(5) — go forth and slay your synchronized lyrics, mwah 💖🌸✨