add Noctalia YT Music plugin - #423
Open
aabidk20 wants to merge 2 commits into
Open
Conversation
aabidk20
marked this pull request as ready for review
August 20, 2026 19:31
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Plugin
aabidk20/noctalia-ytmusicplugin.toml)What it does
Noctalia YT Music is a YouTube Music client for Noctalia v5 featuring:
External dependencies
yt-dlp: Stream URL resolution, track metadata extraction, and offline track downloading.mpv: Background audio player daemon.mpv-mpris: System media controls and MPRIS interface integration. (Optional)jq: In-flight JSON parsing for InnerTube API responses.curl: Asynchronous HTTP network requests for browse, thumbnails, and likes.nc: Socket communication with the local MPV daemon.Testing
Tested Flows:
$XDG_CACHE_HOME/noctalia-ytmusic/audio/.panel-toggle aabidk20/noctalia-ytmusic:panelandmini).Tested on Niri
Tested on Hyprland
Tested on Sway
Tested on another compositor:
Noctalia version tested against: Noctalia v5 (v0.5.x)
Plugin API level: 23
Screenshots / Videos
Key Technical Details & Accounting
Security & Privacy Notice
yt-dlp --cookies-from-browserlocally to extract session cookies when triggered via the cookie extraction page. Cookies are strictly saved to$XDG_CACHE_HOME/noctalia-ytmusic/cookies.txtand are never uploaded or sent to third-party endpoints besides the Youtube Music endpoints explicitly listed here. Extraction happens only when user explicitly selects a browser and never automatically.$XDG_CACHE_HOME/noctalia-ytmusic/.Below is an account of network endpoints, commands, filesystem paths used by the plugin
1. Network
music.youtube.com/youtubei/v1/browsecurl+jqvia shellapi/browse.luauyoutubei/v1/like/likeEndpoint &like/removelikeEndpointcurlvia shellapi/likes.luauyoutubei/v1/searchnoctalia.httpapi/search.luau,api/innerTube.luaui.ytimg.com/vi/...curlvia shellapi/thumbnails.luauyoutube.com/watch?v=...yt-dlpapi/resolve.luau,api/stats.luau,scripts/cookies.sh2. Process
curlapi/browse.luau,api/likes.luau,api/thumbnails.luaujqapi/browse.luau,api/search.luauyt-dlpapi/resolve.luau,api/stats.luau,scripts/cookies.shmpvscripts/mpv.shncscripts/mpv.shtimeoutscripts/cookies.sh,scripts/mpv.shmkdir/du/rmapi/cache.luau,modules/cacheops.luau,scripts/cookies.sh,api/thumbnails.luau,api/resolve.luau,cacheops.luauxdg-open/ Browser launchscripts/cookies.sh3. Filesystem Accounting
$XDG_CACHE_HOME/noctalia-ytmusic/cookies.txtscripts/cookies.sh$XDG_CACHE_HOME/noctalia-ytmusic/{library,recent_playlists,session,quick_picks,stats}.jsonapi/cache.luau,modules/cacheops.luau$XDG_CACHE_HOME/noctalia-ytmusic/playlists/api/browse.luau$XDG_CACHE_HOME/noctalia-ytmusic/thumbnails/api/thumbnails.luau$XDG_CACHE_HOME/noctalia-ytmusic/audio/api/resolve.luau/tmp/noctalia-ytmusic-*mpv.sock), raw responses & scratch filesapi/*,scripts/mpv.shChecklist
idafter the/inplugin.tomlexactly.plugin.toml,README.md,thumbnail.webp, andtranslations/en.json.README.mdfollows the README template, documents every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.thumbnail.webpwith the thumbnail generator.versionfollows semver and is bumped in this PR;plugin_apiis the oldest API level this plugin requires.catalog.toml; CI generates it.Code review attestation
licensedeclared inplugin.toml.