Documentation
¶
Overview ¶
Command mixmusic is a desktop music player that brings Spotify and YouTube Music together in one customizable interface.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package builtin holds the add-ons MixMusic ships with, laid out as the add-ons folder of the user: themes/<id>/theme.json and its files.
|
Package builtin holds the add-ons MixMusic ships with, laid out as the add-ons folder of the user: themes/<id>/theme.json and its files. |
|
internal
|
|
|
addons
Package addons manages themes and plugins: those MixMusic ships with, those the user installs from the community registry, and those they put in the add-ons folder themselves.
|
Package addons manages themes and plugins: those MixMusic ships with, those the user installs from the community registry, and those they put in the add-ons folder themselves. |
|
app
Package app wires MixMusic together: the services its pages call, the events it sends them, and its place on the desktop: windows, the tray, media keys and notifications.
|
Package app wires MixMusic together: the services its pages call, the events it sends them, and its place on the desktop: windows, the tray, media keys and notifications. |
|
artwork
Package artwork picks the color of a piece of artwork, which themes use as the accent of what plays.
|
Package artwork picks the color of a piece of artwork, which themes use as the accent of what plays. |
|
discord
Package discord shows what MixMusic plays on the user's Discord profile, as Rich Presence.
|
Package discord shows what MixMusic plays on the user's Discord profile, as Rich Presence. |
|
lastfm
Package lastfm scrobbles what MixMusic plays to Last.fm.
|
Package lastfm scrobbles what MixMusic plays to Last.fm. |
|
library
Package library keeps what the user collects in MixMusic itself, across services: liked tracks, playlists that mix tracks of every service, the history of what they played and their recent searches.
|
Package library keeps what the user collects in MixMusic itself, across services: liked tracks, playlists that mix tracks of every service, the history of what they played and their recent searches. |
|
lyrics
Package lyrics finds the lyrics of tracks on LRCLIB, an open database of lyrics synchronized to the music, and reads the LRC format they come in.
|
Package lyrics finds the lyrics of tracks on LRCLIB, an open database of lyrics synchronized to the music, and reads the LRC format they come in. |
|
match
Package match finds a Spotify track's recording on YouTube Music, so that Spotify tracks play through MixMusic's own player, with its equalizer, crossfade and visualizer, and without Spotify Premium.
|
Package match finds a Spotify track's recording on YouTube Music, so that Spotify tracks play through MixMusic's own player, with its equalizer, crossfade and visualizer, and without Spotify Premium. |
|
media
Package media defines the catalog that every music source shares: tracks, albums, artists and playlists, whichever service they come from.
|
Package media defines the catalog that every music source shares: tracks, albums, artists and playlists, whichever service they come from. |
|
proc
Package proc starts helper programs, such as yt-dlp, without showing a console window for them on Windows.
|
Package proc starts helper programs, such as yt-dlp, without showing a console window for them on Windows. |
|
settings
Package settings defines the user's preferences and their defaults.
|
Package settings defines the user's preferences and their defaults. |
|
spotify
Package spotify reads the Spotify catalog and the user's library through the Spotify Web API, and plays tracks on Spotify Connect devices.
|
Package spotify reads the Spotify catalog and the user's library through the Spotify Web API, and plays tracks on Spotify Connect devices. |
|
store
Package store keeps values in JSON files.
|
Package store keeps values in JSON files. |
|
stream
Package stream finds the audio streams of YouTube videos with yt-dlp, and serves them to the player's audio element through a local scheme, with range requests, so it can seek.
|
Package stream finds the audio streams of YouTube videos with yt-dlp, and serves them to the player's audio element through a local scheme, with range requests, so it can seek. |
|
tools
Package tools finds and installs the programs MixMusic runs: yt-dlp, which finds the audio streams of YouTube, and a JavaScript runtime, which yt-dlp needs to solve the challenges YouTube sends.
|
Package tools finds and installs the programs MixMusic runs: yt-dlp, which finds the audio streams of YouTube, and a JavaScript runtime, which yt-dlp needs to solve the challenges YouTube sends. |
|
youtube
Package youtube reads YouTube Music's catalog through InnerTube, the API the YouTube Music website itself uses: search, the home feed, albums, artists, playlists and radios.
|
Package youtube reads YouTube Music's catalog through InnerTube, the API the YouTube Music website itself uses: search, the home feed, albums, artists, playlists and radios. |
|
tools
|
|
|
genicon
command
Command genicon draws the MixMusic icons: the app icon and the tray icon.
|
Command genicon draws the MixMusic icons: the app icon and the tray icon. |
|
registry
command
Command registry builds community/registry.json, the index of the community's themes and plugins that MixMusic's marketplace reads, and checks every add-on on the way.
|
Command registry builds community/registry.json, the index of the community's themes and plugins that MixMusic's marketplace reads, and checks every add-on on the way. |
Click to show internal directories.
Click to hide internal directories.