Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
David Futcher committed Aug 26, 2017
1 parent d48b05e commit e9f594d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
The MIT License (MIT)

Copyright (c) 2015 Paul Lietar
Copyright (c) 2015 - 2017 Paul Lietar
Copyright (c) 2017 David Futcher

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
spotify-connect-scrobbler
# spotify-connect-scrobbler


*spotify-connect-scrobbler* is a Last.fm music logging ("scrobbling") service for Spotify. It uses [Spotify Connect](https://www.spotify.com/connect/) to allow you to log music played on any Spotify device, including those which do not have any Last.fm support (such as Amazon Echo).

# Usage

To use *spotify-connect-scrobbler* have your Spotify username & password, your Last.fm username & password, plus a [Last.fm API key and API secret](https://www.last.fm/api/account/create) to hand.

Clone the repo & build with Cargo (`cargo build`). Then run:

`./target/debug/spotify-connect-scrobbler --spotify-username <Spotify username> --spotify-password <Spotify password> --backend pipe --name Scrobbler --lastfm-username <Last.fm username> --lastfm-password <Last.fm password> --lastfm-api-key <Last.fm API key> --lastfm-api-secret <Last.fm API secret>`

The service will sit in the background and log all Spotify tracks played from any Connect enabled client to the given Last.fm account. It is strongly recommended that you turn off Last.fm integration in any Spotify client where it is enabled (Desktop & Mobile apps). Instructions for the opposite [here](https://support.spotify.com/us/using_spotify/app_integrations/scrobble-to-last-fm/).

# Implementation

*spotify-connect-scrobbler* is built on top (more accurately, is a fork of) of Paul Lietar's [librespot](https://github.com/plietar/librespot) project, an open-source Spotify Connect implementation in Rust. It connects to Spotify as a fully-fledged Spotify Connect device. The active Spotify Connect device (the one playing music) broadcasts its status to all other Connect devices on an account, in order to show now-playing track data on other clients. For example, when playing Spotify tracks on an Amazon Echo, the Echo device will broadcast the currently playing track so that it can be shown on the Spotify app on your phone). Thus *spotify-connect-scrobbler* can see the currently playing track and send that to be logged on your Last.fm account.

# License

Released under the MIT license. See `LICENSE`.

0 comments on commit e9f594d

Please sign in to comment.