librespot/README.md
ChristianHersevoort 985e8bed68 Update README.md
Incorrect argument in documentation
2015-07-20 22:11:48 +02:00

1.6 KiB

librespot

librespot is an open source client library for Spotify. It enables applications to use Spotify's service, without using the official but closed-source libspotify. Additionally, it provides extra features which are not available in the official library.

Status

librespot is currently under development and is not fully functional yet. You are however welcome to experiment with it.

Building

Building librespot requires rust nightly. It will not work on rust stable or beta.

You will also need the protobuf compiler, and the rust-protobuf plugin. protoc-gen-rust must be in your $PATH.

Once you've cloned this repository you can build librespot using cargo.

cargo build

Usage

A sample program implementing a headless Spotify Connect receiver is provided. Once you've built librespot, run it using :

target/debug/main -a APPKEY -u USERNAME -c CACHEDIR -n DEVICENAME

where APPKEY is the path to a Spotify application key file, USERNAME is your Spotify username, CACHEDIR is the path to directory where data will be cached, and DEVICENAME is the name that will appear in the Spotify Connect menu.

Disclaimer

Using this code to connect to Spotify's API is probably forbidden by them, and might result in you application key getting banned. Use at you own risk

Contact

Come and hang out on gitter if you need help or want to offer some. https://gitter.im/sashahilton00/spotify-connect-resources

License

Everything in this repository is licensed under the MIT license.