librespot-java is a port of librespot, originally written in Rust, which as evolved into the most up-to-date open-source Spotify client. Additionally, this implementation provides an useful API to request metadata or control the player, more here.
We (the librespot-org organization and me) DO NOT encourage piracy and DO NOT support any form of downloader/recorder designed with the help of this repository. If you're brave enough to put at risk this entire project, just don't publish it. This is meant to provide support for all those devices that are not officially supported by Spotify.
This client is pretty much capable of playing anything that's available on Spotify. Its main features are:
- Tracks and podcasts/episodes playback
- Stations and dailymixes support
- Local content caching
- Zeroconf (Spotify Connect)
- Gapless playback
- Mixed playlists (cuepoints and transitions)
All the configuration you need is inside the
config.toml file, there you can decide to authenticate with:
- Username and password
- Auth blob
Username and password
This is pretty straightforward, but remember that having hardcoded passwords isn't the best thing on earth.
In this mode
librespot becomes discoverable with Spotify Connect by devices on the same network. Just open a Spotify client and select
librespot-java from the available devices list.
Authenticate with Facebook. The console will provide a link to visit in order to continue the login process.
This is more advanced and should only be used if you saved an authentication blob. The blob should have already been Base64-decoded.
You can download the latest release from here and then run
java -jar ./librespot-core-jar-with-dependencies.jar from the command line.
Audio output configuration
On some system, many mixers could be installed making librespot-java playback on the wrong one, therefore you won't hear anything and likely see an exception in the logs. If that's the case, follow the guide below:
- In your configuration file (
config.tomlby default), under the
playersection, make sure
logAvailableMixersis set to
trueand restart the application
- Connect to the client and start playing something
- Along with the previous exception there'll be a log message saying "Available mixers: ..."
- Pick the right mixer and copy it's name inside the
mixerSearchKeywordsoption. If you need to specify more search keywords, you can separate them with a semicolon
- Restart and enjoy
This project uses Maven, after installing it you can compile with
mvn clean package in the project root, if the compilation succeeds you'll be pleased with a JAR executable in
To run the newly build jar run
java -jar ./core/target/librespot-core-jar-with-dependencies.jar.
The compiled Java protobuf definitions aren't versioned, therefore, if you want to open the project inside you're IDE, you'll need to run
mvn compile first to ensure that all the necessary files are created.
com.spotify package is reserved for the generated files.
The application uses Log4J for logging purposes, the configuration file is placed inside
api/src/main/resources depending on what you're working with.
- ansible-role-librespot - Ansible role that will build, install and configure librespot-java.
- spocon - Install librespot-java from APT