mirror of
https://git.sr.ht/~phw/scotty
synced 2025-04-16 10:09:28 +02:00
64 lines
3.3 KiB
Markdown
64 lines
3.3 KiB
Markdown
# Scotty
|
||
|
||
Scotty transfers your listens/scrobbles and favorite tracks between various music listen tracking and streaming services.
|
||
|
||
*Note: This project is currently work in progress. While the basics are working there are many loose ends and there is no documentation except for this file yet. Use at your own risk.*
|
||
|
||
|
||
## Example use cases
|
||
|
||
- Submit listens from ListenBrainz to Maloja or Last.fm
|
||
- Transfer loved tracks from Funkwhale to ListenBrainz
|
||
- Submit listens stored in a Rockbox `.scrobbler.log` file to ListenBrainz, Last.fm or Maloja
|
||
- Store your favorite tracks from Deezer as a JSPF playlist
|
||
|
||
|
||
## Configuration
|
||
|
||
Scotty requires the configuration of the services in a configuration file in TOML format. See [scotty.example.toml](./scotty.example.toml) for details.
|
||
|
||
|
||
## Usage
|
||
|
||
Run `scotty --help` for command line help.
|
||
|
||
|
||
## Supported backends
|
||
|
||
The following table lists the available backends and the currently supported features.
|
||
|
||
Backend | Listens Export | Listens Import | Loves Export | Loves Import
|
||
---------------|----------------|----------------|--------------|-------------
|
||
deezer | ✓ | ⨯ | ✓ | -
|
||
dump | ⨯ | ✓ | ⨯ | ✓
|
||
funkwhale | ✓ | ⨯ | ✓ | -
|
||
jspf | - | ✓ | - | ✓
|
||
lastfm | - | - | - | -
|
||
listenbrainz | ✓ | ✓ | ✓ | ✓
|
||
maloja | ✓ | ✓ | ⨯ | ⨯
|
||
scrobbler-log | ✓ | ✓ | ⨯ | ⨯
|
||
spotify | ✓ | ⨯ | ✓ | -
|
||
subsonic | ⨯ | ⨯ | ✓ | -
|
||
|
||
**✓** implemented **-** not yet implemented **⨯** unavailable / not planned
|
||
|
||
|
||
## Contribute
|
||
The source code for Scotty is available on [SourceHut](https://git.sr.ht/~phw/scotty). To report issues or feature requests please [create a ticket](https://todo.sr.ht/~phw/scotty).
|
||
|
||
Patches can be submitted to the mailing list [~phw/musicbrainz@lists.sr.ht](https://lists.sr.ht/~phw/musicbrainz). You can clone the repository directly on SourceHut and submit your changes with the "Prepare patchset" button. Please see SourceHut's [documentation for sending patches upstream](https://man.sr.ht/git.sr.ht/#sending-patches-upstream) for details.
|
||
|
||
|
||
## License
|
||
|
||
Scotty © 2023 Philipp Wolfer <phw@uploadedlobster.com>
|
||
|
||
Scotty is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||
|
||
Scotty is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License along with Scotty. If not, see <https://www.gnu.org/licenses/>.
|
||
|
||
See [COPYING](./COPYING) for details.
|
||
|
||
Some source files in Scotty are licensed under the MIT license. Please see the license notice in the headers of the individual files for more information.
|