Skip to content
The most up-to-date open source Spotify client
Java Shell
Branch: dev
Clone or download
devgianlu Added `connectionDropped` and `connectionEstablished` events + better…
… response codes for API + updated api/README (#172)
Latest commit 9c9842a Jan 26, 2020

README.md

librespot-java

Build Status Codacy Badge Maven Central

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.

Disclaimer!

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.

Features

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)

Get started

All the configuration you need is inside the config.toml file, there you can decide to authenticate with:

  • Username and password
  • Zeroconf
  • Facebook
  • Auth blob

Username and password

This is pretty straightforward, but remember that having hardcoded passwords isn't the best thing on earth.

Zeroconf

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.

Facebook

Authenticate with Facebook. The console will provide a link to visit in order to continue the login process.

Auth blob

This is more advanced and should only be used if you saved an authentication blob. The blob should have already been Base64-decoded.

Run

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:

  1. In your configuration file (config.toml by default), under the player section, make sure logAvailableMixers is set to true and restart the application
  2. Connect to the client and start playing something
  3. Along with the previous exception there'll be a log message saying "Available mixers: ..."
  4. Pick the right mixer and copy it's name inside the mixerSearchKeywords option. If you need to specify more search keywords, you can separate them with a semicolon
  5. Restart and enjoy

Build it

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 core/target. To run the newly build jar run java -jar ./core/target/librespot-core-jar-with-dependencies.jar.

Protobuf generation

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. The com.spotify package is reserved for the generated files.

Logging

The application uses Log4J for logging purposes, the configuration file is placed inside core/src/main/resources or api/src/main/resources depending on what you're working with.

Related Projects

Special thanks

  • All the developers of librespot which started this project in Rust
  • All the contributors of this project for testing and fixing stuff
  • that provided a free license for their Java Profiler
You can’t perform that action at this time.