Config file#

The configuration uses the YAML file format and is named config or config.yaml. Valid directories for this file are C:/Users/{username}/.config/yasb/ or ENV variable YASB_CONFIG_HOME if set. All valid options for the widgets are listed on the widgets page.

Environment Variables Support#

YASB supports loading environment variables from a .env file.
This allows you to securely store sensitive information (such as API keys or tokens) outside of your main config.yaml.

• The .env file should be placed in your config directory:
  C:/Users/{username}/.config/yasb/.env
  or in the directory specified by the YASB_CONFIG_HOME environment variable.

• Variables defined in .env can be referenced in your config.yaml by setting the value to env (for example, api_key: env or api_key: "$env:YASB_WEATHER_API_KEY").

• The .env file is loaded automatically on startup.

Example .env file:

YASB_WEATHER_API_KEY=your_api_key_here
YASB_GITHUB_TOKEN=your_github_token_here
YASB_WEATHER_LOCATION=your_location_here
# Some Qt settings
QT_SCREEN_SCALE_FACTORS="1.25;1"
QT_SCALE_FACTOR_ROUNDING_POLICY="PassThrough"

YASB Font Engine#

YASB supports different font engines to improve text rendering quality. You can set the font engine by defining the YASB_FONT_ENGINE environment variable in your .env file or in OS environment variables. Valid options are:

• native: Uses the DirectWrite font rendering engine.
• gdi: Uses the GDI font rendering engine.
• freetype: Uses the FreeType font rendering engine.

Status Bar Root Configuration#

Logging and Debugging#

YASB provides detailed logging to help troubleshoot widget or configuration issues.

• Enable Debug Mode: Set debug: true in your root configuration to output verbose logs.
• View Logs via CLI: Run yasbc log in your terminal to stream real-time logs.
• View Log File: Check the yasb.log file located in your config directory (default: C:/Users/{username}/.config/yasb/).

Tooltip Configuration#

Global configuration for tooltips and their blur effects.

Tooltip Blur Effect Configuration#

Example Configuration:

tooltip:
  offset: 5
  blur_effect:
    enabled: true
    dark_mode: false
    round_corners: true
    round_corners_type: "small"
    border_color: "None"

Komorebi settings for tray menu#

Adds a Komorebi submenu to the YASB tray icon menu. None of the commands are set by default. The submenu is shown only when Komorebi is installed and at least one command is set, and it only lists the actions you set a command for.

Example Configuration:

komorebi:
  start_command: "komorebic start --whkd"
  stop_command: "komorebic stop --whkd"
  reload_command: "komorebic reload-configuration"

Glazewm settings for tray menu#

Adds a GlazeWM submenu to the YASB tray icon menu. None of the commands are set by default. The submenu is shown only when GlazeWM is installed and at least one command is set, and it only lists the actions you set a command for.

Example Configuration:

glazewm:
  start_command: "glazewm.exe start"
  stop_command: "glazewm.exe command wm-exit"
  reload_command: "glazewm.exe command wm-exit && glazewm.exe start"

Status Bar Configuration#

Bar Style#

bars:
  primary-bar:
    style: "adaptive"

The rail height, corner radius, the padding around each group, and whether islands are drawn at all are set from the stylesheet so they reload with your theme. See Adaptive bar style for the available properties.

style_adaptive_exclude lists widgets the island shape does not paint under. The island stops before the widget and starts again after it, so a widget in the middle of a group splits it into two islands. It has nothing to do if islands are turned off from the stylesheet, there is only one surface left to exclude a widget from.

bars:
  primary-bar:
    style: "adaptive"
    style_adaptive_exclude: ["systray", "weather"]

Names come from your widgets section. The widget draws as usual, only the surface under it is gone. Widgets inside a Grouper cannot be named on their own, excluding the grouper leaves the whole group out.

Bar Alignment#

Animation Configuration#

Customize how the status bar transitions when shown or hidden:

Blur Effect Configuration#

Window Flags Configuration#

Layouts Configuration#

Each section (left, center, right) can be configured with the following properties:

Example:

layouts:
  left:
    alignment: "left"
    stretch: true
  center:
    alignment: "center"
    stretch: true
  right:
    alignment: "right"
    stretch: true

Multiple Bars Example#

Screen Assignment Options#

• screens: ['*'] - Show on all unassigned screens (screens not explicitly assigned to other bars)
• screens: ['**'] - Show on all screens (including screens assigned to other bars)
• screens: ['SCREEN_NAME'] - Show on specific screen(s)

bars:
  status-bar:
    screens: ['DELL P2419H (1)']  # Show only on monitor 1
    widgets:
      left: ["clock"]
      center: ["cpu"]
      right: ["memory"]

  status-bar-2:
    screens: ['DELL P2419H (2)']  # Show only on monitor 2
    widgets:
      left: ["active_window"]
      center: ["media"]
      right: ["volume","power_menu"]

  status-bar-3:
    screens: ['*']  # Show on all unassigned screens
    widgets:
      center: ["weather"]

  global-taskbar:
    screens: ['**']  # Show on ALL screens (including monitors 1 and 2)
    widgets:
      left: ["taskbar"]

widgets:
    ...