Skip to content

Player Module

Sam edited this page Aug 9, 2024 · 1 revision

Warning

This module must be built with the player feature enabled in cargo (already done in all pre-compiled releases).
As well as this, you must have dbus installed on your system which requires the systemd init system. You can check this using the "initsys" CrabFetch module.

If your not sure of any of this, just try to use the module anyway as it's highly likely your running these two, as alternatives are typically on power user distros.

The player module displays all your currently playing medias. It creates a new line per player.
Your players must support the "mpris" d-bus standard (most do).

Using

Insert into the modules array.

Configuration

  • title -> (String) The module title. Contains a singular {player} placeholder.
  • format -> (String) The format used to display the module. Check below to see available placeholders.
  • ignore -> (String Array) A list of players that CrabFetch will ignore.
  • title_color -> (Optional/String) Override the title color to be used.
  • title_bold -> (Optional/Bool) Make the title bold.
  • title_italic -> (Optional/Bool) Make the title italic.
  • separator -> (Optional/Char) Override the separator to be used.
format placeholders;
  • {player} -> The name of the player for that line.
  • {track} -> The currently playing track.
  • {album} -> The currently playing album.
  • {track_artists} -> The artists of the current track.
  • {album_artists} -> The artists of the current album.
  • {status} -> The status of the player, if it's currently playing or paused.
Default Configuration
[player]
title = "Player ({player})"
format = "{track} by {track_artists} ({album}) [{status}]"
ignore = []

Example

modules = [
    "player"
]

[player]
title = "{player}"
format = "{track}"
ignore = ["spotify"]