mirror of
https://github.com/librespot-org/librespot.git
synced 2024-12-18 17:11:53 +00:00
56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
# 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](https://github.com/stepancheg/rust-protobuf) plugin.
|
|
`protoc-gen-rust` must be in your `$PATH`.
|
|
|
|
Also required is an installation of [portaudio](http://portaudio.com/), which
|
|
can be installed via `brew install portaudio` for an OS X machine.
|
|
|
|
On debian / ubuntu the following dependencies need to be installed:
|
|
`libavahi-compat-libdnssd-dev`, `portaudio19-dev`, `libprotoc-dev`, `libprotobuf-dev`
|
|
|
|
Once you've cloned this repository you can build *librespot* using `cargo`.
|
|
```shell
|
|
cargo build
|
|
```
|
|
|
|
## Usage
|
|
A sample program implementing a headless Spotify Connect receiver is provided.
|
|
Once you've built *librespot*, run it using :
|
|
```shell
|
|
target/debug/librespot -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.
|
|
|
|
## Troubleshooting
|
|
If you connect using a facebook account, librespot will not show up among the
|
|
devices in the Spotify app. What you need to do is apply for a
|
|
[device password](http://www.spotify.com/account/set-device-password/) and
|
|
use that to sign in instead.
|
|
|
|
## 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.
|
|
|