Skip to content

spotify-lyrics-widget - #67

Draft
goatnath wants to merge 7 commits into
noctalia-dev:mainfrom
goatnath:main
Draft

spotify-lyrics-widget#67
goatnath wants to merge 7 commits into
noctalia-dev:mainfrom
goatnath:main

Conversation

@goatnath

Copy link
Copy Markdown

Plugin

  • Id: goatnath/spotify-lyrics-widget
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

This adds a seamless, time-synced scrolling lyrics widget for the Noctalia desktop shell. It reads the current track from Spotify and automatically displays and scrolls the lyrics in sync with the song, creating an immersive listening experience on the desktop.

External dependencies

  • python3: Used to run the backend script for fetching and syncing lyrics.
  • playerctl (Optional/Likely): Used to fetch the current MPRIS status of Spotify.

(Note: If you use any specific Python packages like spotipy, mention them here!)

Testing

I opened the widget via the Noctalia panel, played various tracks on Spotify, and ensured that the IPC messages successfully updated the scrolling position in sync with the song's timestamp.

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor:
  • Noctalia version tested against: v5
  • Plugin API level: 3

Screenshots / Videos

recording_20260721_021308.mp4

Checklist

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the
    README template, documents
    every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • I created thumbnail.webp with the thumbnail generator.
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and
    understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

Plugins run as trusted, unsandboxed Luau in the user's session. Confirm:

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

@h465855hgg

Copy link
Copy Markdown
Contributor

wow this plugins so cool

@goatnath

Copy link
Copy Markdown
Author

@h465855hgg Ayy thanks man!

@ItsLemmy

Copy link
Copy Markdown
Contributor

• 1. blocking - spotify-lyrics/plugin.toml:1

The plugin uses the noctalia author namespace even though plugin.toml:5 identifies the author as goatnath, and the PR declares a goatnath/... canonical ID. Repository policy says the author namespace belongs to the contributor. This falsely attributes the community plugin and creates the wrong permanent identity. Use goatnath/spotify-lyrics and update spotify-lyrics/README.md:11 and spotify-lyrics/bar.luau:35 accordingly.

  1. blocking - spotify-lyrics/thumbnail.webp:1

The thumbnail was not generated with the thumbnail generator. as it should

The thumbnail depicts album artwork, playback controls, a progress bar, and a larger multi-line media interface. The implemented panel in spotify-lyrics/panel.luau:54 only provides a track header and previous/current/next lyric lines, with none of those controls or media features. Because the store image materially misrepresents the shipped interface, replace it with an actual or visually accurate plugin screenshot.

@ItsLemmy
ItsLemmy marked this pull request as draft July 21, 2026 17:44
@Reiling-Jeff

Copy link
Copy Markdown
Contributor

i installed this plugin from your repo following the steps in the README.md, for some reason, the bar icon doesnt show up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants