Merge pull request #14 from patryk-ku/dev

v0.2.1

Author: patryk-ku

.github/assets/banner.png

@@ -1,8 +1,4 @@
 ## Changes:
 
-- (⚠️ **Breaking**) The `-n`, `--player-name` argument has been removed. Use `-a`, `--allowlist-add` instead.
-- (⚠️ **Breaking**) The previous button arguments (`-p`, `--profile-button`, `-y`, `--yt-button`) have been consolidated into a single new argument: `-b, --button` with options: `yt`, `lastfm`, `listenbrainz` and separate arguments for setting service usernames. More additional buttons coming in the future.
-- Added support for configuring the program via a configuration file.
-- Added commands for easy setup of autostart using systemd.
-- Now available as `.deb` and `.rpm` packages, and in the AUR.
-- Print debug logs with `--debug-log`.
+- Added option to hide album title in activity.
+- Added the ability to customize displayed icon adjacent to album artwork. Available options: none, play/pause icons, music player icon, Last.fm avatar.

.github/assets/banner.xcf

@@ -1,3 +1,8 @@
+## v0.2.1
+
+- Added option to hide album title in activity.
+- Added the ability to customize displayed icon adjacent to album artwork. Available options: none, play/pause icons, music player icon, Last.fm avatar.
+
 ## v0.2.0
 
 - (⚠️ **Breaking**) The `-n`, `--player-name` argument has been removed. Use `-a`, `--allowlist-add` instead.

.github/release-notes.md

@@ -1,6 +1,6 @@
 [package]
 name = "mpris-discord-rpc"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 authors = ["Patryk Kurdziel <patryk.kurdziel@protonmail.com>"]
 description = "MPRIS Discord music rich presence status with support for album covers and progress bar."

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Maintainer: Patryk Kurdziel <patryk.kurdziel@protonmail.com>
 
 pkgname=mpris-discord-rpc
-pkgver=0.2.0
+pkgver=0.2.1
 pkgrel=1
 pkgdesc='MPRIS Discord music rich presence status with support for album covers and progress bar.'
 url="https://github.com/patryk-ku/$pkgname"

Cargo.lock

@@ -1,8 +1,8 @@
 # mpris-discord-rpc
 
-![img-min-optimized](https://github.com/user-attachments/assets/15990d23-51af-4d98-ae7d-7feabe84c351)
+![banner](.github/assets/banner.png)
 
-MPRIS Discord music rich presence status **with support for album covers and progress bar**. In addition, there is also an option to enable buttons with links to your profile on last.fm and a search song on Youtube. Written in Rust.
+Linux Discord rich presence for music, using MPRIS with **album cover and progress bar support**. You can customize additional buttons, such as linking to your Last.fm profile or searching for the current song on YouTube. There's also an option to display either the music player's icon or your Last.fm avatar next to the album cover. The application is written in Rust.
 
 ## Supported players
 
@@ -113,8 +113,10 @@ Options:
   -b, --button <name>                 Select visible buttons [possible values: yt, lastfm, listenbrainz, shamelessAd]
       --lastfm-name <nickname>        Your Last.fm nickname
       --listenbrainz-name <nickname>  Your Listenbrainz nickname
+  -s, --small-image <name>            Select the icon displayed next to the album cover (default playPause) [possible values: playPause, player, lastfmAvatar, none]
   -l, --list-players                  Displays all available music player names and exits. Use to get your player name for -a argument
   -a, --allowlist-add <Player Name>   Get status only from given player. Use multiple times to add several players
+      --hide-album-name               Hide album name
   -d, --disable-cache                 Disable cache (not recommended)
       --debug-log                     Show debug log
       --reset-config                  Reset config file (overwrites the old file if exists)
@@ -196,6 +198,31 @@ lastfm_name: "nickname"
 
 > You can request more buttons by opening an Issue.
 
+### The icon next to the album cover
+
+You can choose from available options: `playPause`, `player`, `lastfmAvatar`, `none`.
+
+arguments:
+
+```sh
+mpris-discord-rpc -s player
+```
+
+config:
+
+```yaml
+small_image: player
+```
+
+Available music player icons: `Amberol`, `Elisa`, `GNOME Music`, `Google Chrome`, `Lollypop`, `Mozilla Firefox`, `Spotify`, `Strawberry`, `Tauon`, `VLC Media Player`, `Zen Browser`.
+
+Missing your player icon? Open an Issue with:
+
+- Icon link (png, min. 512x512 resolution - Discord requirement)
+- Player ID (obtainable by running with `--debug-log` parameter, search for the line with `[debug] player_id:`)
+
+Icons are managed through Discord Developer Portal, so no app update is needed after adding new ones.
+
 ### Flatpak Discord fix
 
 As flatpak applications are sandboxed this makes it difficult for any other programs to communicate with them. But this can be easily fixed using the following command:
@@ -238,3 +265,5 @@ If not disabled, the program stores the cache in `$XDG_CACHE_HOME/mpris-discord-
 ## Credits
 
 I wouldn't have been able to create this without two fantastic crates: [mpris-rs](https://github.com/Mange/mpris-rs) and [discord-rich-presence](https://github.com/vionya/discord-rich-presence). Implementing these features myself would have been beyond my current skills. A huge thank you to their creators.
+
+Any trademarks, featured track metadata, artwork and coverart in banner, music player icons and streaming service logos belong to their respective owners.

Cargo.toml

@@ -17,6 +17,9 @@ interval: 10
 # lastfm_name: "nickname"
 # listenbrainz_name: "nickname"
 
+# Select the icon displayed next to the album cover (default playPause) [possible values: playPause, player, lastfmAvatar, none]
+small_image: playPause
+
 # Only use the status from the following music players
 # Use -l, --list-players to get player exact name to use with this option
 # The order matters and the first is the most important.
@@ -25,5 +28,8 @@ interval: 10
 #   - "Chrome"
 #   - "Any other player"
 
+# Hide the album name to decrease activity height
+hide_album_name: false
+
 # Disable cache (not recommended)
 disable_cache: false

PKGBUILD

@@ -50,6 +50,18 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let lastfm_name = settings.lastfm_name.unwrap_or_default();
     let listenbrainz_name = settings.listenbrainz_name.unwrap_or_default();
 
+    let small_image = settings.small_image.unwrap_or(String::from("playPause"));
+    let mut lastfm_avatar = String::new();
+    if small_image == "lastfmAvatar" && !lastfm_name.is_empty() {
+        lastfm_avatar = utils::get_lastfm_avatar(&lastfm_name, LASTFM_API_KEY);
+        debug_log!(settings.debug_log, "lastfm_avatar: {}", lastfm_avatar);
+    }
+    let lastfm_icon_text = if !lastfm_name.is_empty() {
+        lastfm_name.to_string() + " on Last.fm"
+    } else {
+        String::new()
+    };
+
     // Enable/disable use of cache
     let mut cache_enabled: bool = !settings.disable_cache;
     if !home_exists {
@@ -226,6 +238,11 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
             }
         };
 
+        let player_name = player.identity();
+        let player_id = utils::sanitize_name(player_name);
+        debug_log!(settings.debug_log, "player_name: {}", player_name);
+        debug_log!(settings.debug_log, "player_id: {}", player_id);
+
         // Connect with Discord
         if is_first_time {
             match client.connect() {
@@ -423,19 +440,37 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
                 "paused".to_string()
             };
 
-            let payload = activity::Activity::new()
+            let mut assets = activity::Assets::new().large_image(&image);
+
+            if !settings.hide_album_name {
+                assets = assets.large_text(&album);
+            }
+
+            match small_image.as_str() {
+                "player" => assets = assets.small_image(&player_id).small_text(&player_name),
+                "lastfmAvatar" => {
+                    if !lastfm_avatar.is_empty() {
+                        assets = assets
+                            .small_image(&lastfm_avatar)
+                            .small_text(&lastfm_icon_text);
+                    }
+                }
+                "none" => {}
+                _ => assets = assets.small_image(&status_text).small_text(&status_text),
+            }
+
+            // Display paused icon anyway if playpack is paused or stopped
+            if status_text != "playing" {
+                assets = assets.small_image(&status_text).small_text(&status_text)
+            }
+
+            let mut payload = activity::Activity::new()
                 .state(&artist)
                 .details(&title)
-                .assets(
-                    activity::Assets::new()
-                        .large_image(&image)
-                        .small_image(&status_text)
-                        .large_text(&album)
-                        .small_text(&status_text),
-                )
+                .assets(assets)
                 .activity_type(activity::ActivityType::Listening);
 
-            let payload = if is_track_position & (track_duration > 0) {
+            payload = if is_track_position & (track_duration > 0) {
                 let time_end = time_start + track_duration;
                 if is_playing {
                     payload.timestamps(
@@ -517,7 +552,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
                 }
             }
 
-            let payload = match buttons.is_empty() {
+            payload = match buttons.is_empty() {
                 false => payload.buttons(buttons),
                 true => payload,
             };

README.md

@@ -29,6 +29,10 @@ pub struct Cli {
     #[arg(long, value_name = "nickname", value_parser = clap::value_parser!(String))]
     pub listenbrainz_name: Option<String>,
 
+    /// Select the icon displayed next to the album cover (default playPause)
+    #[arg(short, long, value_name = "name", value_parser = ["playPause", "player", "lastfmAvatar", "none"])]
+    pub small_image: Option<String>,
+
     /// Displays all available music player names and exits. Use to get your player name for -a argument
     #[arg(short, long)]
     #[serde(skip_deserializing)]
@@ -38,6 +42,10 @@ pub struct Cli {
     #[arg(short = 'a', long = "allowlist-add", value_name = "Player Name", value_parser = clap::value_parser!(String))]
     pub allowlist: Vec<String>,
 
+    /// Hide album name
+    #[arg(long)]
+    pub hide_album_name: bool,
+
     /// Disable cache (not recommended)
     #[arg(short, long)]
     pub disable_cache: bool,
@@ -102,6 +110,9 @@ interval: 10
 # lastfm_name: "nickname"
 # listenbrainz_name: "nickname"
 
+# Select the icon displayed next to the album cover (default playPause) [possible values: playPause, player, lastfmAvatar, none]
+small_image: playPause
+
 # Only use the status from the following music players
 # Use -l, --list-players to get player exact name to use with this option
 # The order matters and the first is the most important.
@@ -110,6 +121,9 @@ interval: 10
 #   - "Chrome"
 #   - "Any other player"
 
+# Hide the album name to decrease activity height
+hide_album_name: false
+
 # Disable cache (not recommended)
 disable_cache: false
 "#;
@@ -200,6 +214,14 @@ pub fn load_settings() -> Cli {
         config.listenbrainz_name = args.listenbrainz_name;
     }
 
+    if args.small_image != config.small_image && args.small_image.is_some() {
+        config.small_image = args.small_image;
+    }
+
+    if args.hide_album_name {
+        config.hide_album_name = args.hide_album_name;
+    }
+
     if args.disable_cache {
         config.disable_cache = args.disable_cache;
     }

config.yaml

@@ -225,3 +225,45 @@ pub fn get_cover_url(
 
     return String::from("missing-cover");
 }
+
+pub fn get_lastfm_avatar(username: &str, lastfm_api_key: &str) -> String {
+    let request_url = format!(
+        "http://ws.audioscrobbler.com/2.0/?method=user.getinfo&api_key={}&user={}&format=json",
+        lastfm_api_key,
+        url_escape::encode_component(username)
+    );
+
+    let mut url: String = match reqwest::blocking::get(request_url) {
+        Ok(res) => match res.json::<serde_json::Value>() {
+            Ok(data) => data["user"]["image"][3]["#text"].to_string(),
+            Err(_) => String::new(),
+        },
+        Err(_) => String::new(),
+    };
+
+    if !url.is_empty() && (url.len() > 15) {
+        url.pop();
+        url.remove(0);
+        println!("[last.fm] fetched avatar link: {}", url);
+        return url;
+    }
+
+    return String::new();
+}
+
+pub fn sanitize_name(input: &str) -> String {
+    input
+        .to_lowercase()
+        .split_whitespace()
+        .collect::<Vec<&str>>()
+        .join("_")
+        .chars()
+        .filter(|c| c.is_alphanumeric() || *c == '_')
+        .collect()
+}
+
+// pub fn format_time(seconds: u64) -> String {
+//     let minutes = seconds / 60;
+//     let remaining_seconds = seconds % 60;
+//     format!("{:02}:{:02}", minutes, remaining_seconds)
+// }