SCROBBLER-HELPER(1p)

📦
version 0.01 · 2 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ SCROBBLER-HELPER 💅

okay so bestie, this is scrobbler-helper from the User Contributed Perl Documentation, and it's literally the little utility that yeets one (1) single track into AudioScrobbler. welcome to the function, pull up a chair 🫶

🌸 SYNOPSIS 🌸

scrobbler-helper [-nv] [-e encoding] [-f configfile] -P progname
  -V progver title artist album year comment genre length

💖 DESCRIPTION 💖

So. The scrobbler-helper utility is out here using the Audio::Scrobbler module to submit a single track's info to Last.fm's AudioScrobbler — yes, that one, http://www.audioscrobbler.com/. 👑

Here's the vibe check: it needs the program (plug-in) name and version handed to it on the command line, and it also needs all seven track attributes. all seven, bestie, every last one. some of them you can get away with by passing empty strings, but like... you still gotta pass them. no skipping. periodt. 💅

The following command-line options are recognized:

  • -e encoding — says what character encoding the track info is in, but only if it's neither UTF-8 nor whatever default_encoding says in the config file. otherwise, mind your business. ✨
  • -f configfile — points at a different config file than the usual ~/.scrobbler-helper.conf. living your own truth, love that for you. 🦋
  • -n — do NOT actually perform the handshake and submission (this sets the Audio::Scrobbler fake option). it's giving dress rehearsal, not the real thing. 🎀
  • -P progname — the name of the AudioScrobbler plug-in that's submitting the data. this option is mandatory! not optional, not negotiable, not a suggestion! 😤
  • -v — verbose operation, aka it spills diagnostic messages to standard output (sets the Audio::Scrobbler verbose option). do it if you're nosy. i'm nosy. 😭
  • -V progver — the version of the AudioScrobbler plug-in submitting the data. also mandatory! you can't just skip this one either. 🙈

🧚 config file behaviour: a deep dive

Besides the command line, scrobbler-helper also pulls info from a per-user configuration file, usually ~/.scrobbler-helper.conf. it's an INI-style file, and it must contain a section named global. no global section? no service. 💀

The following variables are recognized, with username and password being mandatory:

  • default_encoding — the encoding to assume for the track info if nothing got supplied with the -e command-line option. and listen — if -e is not on the command line AND default_encoding isn't in the config file, scrobbler-helper just assumes UTF-8. it trusts. ✨
  • fix_track_name — a boolean flag saying whether to do some trivial fixes on the song name before submitting. right now, "trivial fixes" means it only removes a DD. sequence at the start of the name, where D is a digit. that's the whole glow-up. 💅

The values on, true, yes, and 1 are considered to be true. 👑

  • password — the password for the AudioScrobbler account. 🤫
  • username — the username for the AudioScrobbler account. 💖

and here's the little example config, verbatim, because it's iconic:

[global]
username=jrandomlistener
password=mylittlesecret
# Optional (the default is UTF-8)
default_encoding=windows-1251
# Optional (the default is "no")
fix_track_name=yes

🎀 TODO 🎀

the devs left a lil to-do list, and honestly same:

  • Command-line options, so people don't have to submit everything... 😩
  • Storing and caching unsuccessful submissions for later retrying. 🔥

🌈 SEE ALSO 🌈

and the home site of the Audio::Scrobbler module is http://devel.ringlet.net/audio/Audio-Scrobbler/ — that's where it lives, iykyk 🦋

🌸 AUTHOR 🌸

Peter Pentchev, <roam@ringlet.net> — the actual main character here 👑

Copyright (C) 2005, 2006 by Peter Pentchev.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available. slay, that's the license, respect it 🫶

$Id: scrobbler-helper 88 2006-01-02 09:16:32Z roam $

okay bye bestie, this was perl v5.36.0 on 2023-07-20, and yes it came from the SCROBBLER-HELPER(1p) page. go scrobble something iconic, no cap. ⭐🎀💅

📦 where this page comes from