How to know whether I am in row/column mode

[Chen-Yulin]

Hi, I really appreciate this awesome plugin!!
I was wondering how can I get the current mode of hyprscroller, so that I can display the mode in waybar or somewhere else.
Also, it's quite helpful if I can see whether I am in overview (since for workspace with only two windows, the overview looks the same as normal view).

THANKS!!!

[dawsers]

Thank you, I am glad you find it useful.

I added two IPC messages to do what you want in af6bd79

There is some documentation in the README to explain how to use them, subsection IPC. For a quick example, you can use this script:

#!/usr/bin/env bash

function handle {
  if [[ ${1:0:8} == "scroller" ]]; then
    if [[ ${1:10:11} == "overview, 0" ]]; then
        hyprctl notify -1 3000 "rgb(ff1ea3)" "Normal mode!"
    elif [[ ${1:10:11} == "overview, 1" ]]; then
        hyprctl notify -1 3000 "rgb(ff1ea3)" "Overview mode!"
    elif [[ ${1:10:9} == "mode, row" ]]; then
        hyprctl notify -1 3000 "rgb(ff1ea3)" "Row mode!"
    elif [[ ${1:10:12} == "mode, column" ]]; then
        hyprctl notify -1 3000 "rgb(ff1ea3)" "Column mode!"
    elif [[ ${1:10:11} == "admitwindow" ]]; then
        hyprctl notify -1 3000 "rgb(ff1ea3)" "Admit Window!"
    elif [[ ${1:10:11} == "expelwindow" ]]; then
        hyprctl notify -1 3000 "rgb(ff1ea3)" "Expel Window!"
    fi
  fi
}

socat - "UNIX-CONNECT:$XDG_RUNTIME_DIR/hypr/$HYPRLAND_INSTANCE_SIGNATURE/.socket2.sock" | while read -r line; do handle "$line"; done

You can adapt it to the way your bar works.

For the particular case of overview, the way I know I am in that mode is because I use a special submap for it. That way I can disable certain "dangerous" keys while I am in overview. I use ags, which provides a submap module for hyprland.

# overview keys
# bind key to toggle overview (normal)
bind = $mainMod, tab, scroller:toggleoverview
# bind mouse button to toggle overview
bind = ,mouse:275, scroller:toggleoverview
# overview submap
# will switch to a submap called overview
bind = $mainMod, tab, submap, overview
# will start a submap called "overview"
submap = overview
bind = , right, scroller:movefocus, right
bind = , left, scroller:movefocus, left
bind = , up, scroller:movefocus, up
bind = , down, scroller:movefocus, down
bind = CTRL, left, scroller:movewindow, l
bind = CTRL, right, scroller:movewindow, r
bind = CTRL, up, scroller:movewindow, u
bind = CTRL, down, scroller:movewindow, d
bind = CTRL, home, scroller:movewindow, begin
bind = CTRL, end, scroller:movewindow, end
# use reset to go back to the global submap
bind = , escape, scroller:toggleoverview,
bind = , escape, submap, reset
bind = , return, scroller:toggleoverview,
bind = , return, submap, reset
bind = $mainMod, tab, scroller:toggleoverview,
bind = $mainMod, tab, submap, reset
# will reset the submap, meaning end the current one and return to the global one
submap = reset

Let me know if you need anything else.

[Chen-Yulin]

Amazing, I would try it ASAP!

[dawsers]

I added a small fix in 17fac7f

[Chen-Yulin]

Works well on my machine.
Thank you very much!

[Chen-Yulin]

Here is how I use the IPC msg to complete the scroll mode module in waybar!

I wrote two shell script under ~/.config/waybar/

• scroller_mode_listener.sh, responsible for listening the IPC message of hyprscroller and store that information in a tmp file. This script can be executed in hyprland config file using exec-once.

#!/bin/bash

MODE_FILE="/tmp/hyprland_scroller_mode"

function handle {
  if [[ ${1:0:8} == "scroller" ]]; then
    if [[ ${1:10:9} == "mode, row" ]]; then
        echo "Row" > "$MODE_FILE"
    elif [[ ${1:10:12} == "mode, column" ]]; then
        echo "Column" > "$MODE_FILE"
    #else
        #echo "" > "$MODE_FILE"
    fi
    hyprctl dispatch submap reset && pkill -SIGRTMIN+8 waybar # update the widget on waybar
  fi
}

# Initialize the mode file
echo "" > "$MODE_FILE"

socat - "UNIX-CONNECT:$XDG_RUNTIME_DIR/hypr/$HYPRLAND_INSTANCE_SIGNATURE/.socket2.sock" | while read -r line; do handle "$line"; done

• scroller_mode_reader.sh, responsible for reading the tmp file and return the json value to waybar to change the shown icon.

#!/bin/bash

MODE_FILE="/tmp/hyprland_scroller_mode"

current_mode=$(cat "$MODE_FILE")

if [[ "$current_mode" == "Row" ]]; then
    icon="Row"
    percent=0
    class="mode-row"
elif [[ "$current_mode" == "Column" ]]; then
    icon="Column"
    percent=100
    class="mode-column"
else
    icon="Row"
    percent=0
    class=""
fi

echo "{\"text\":\"$icon\", \"tooltip\":\"Scroller Mode: $current_mode\", \"class\":\"$class\",\"percentage\": $percent}"

Then add the custom module to waybar in config file (we use signal to update the module):

    "custom/scroller-mode": {
        "exec": "~/.config/waybar/scroller_mode_reader.sh",
        "return-type": "json",
        "interval": "once",
        "signal": 8,
        "on-click": "hyprctl dispatch submap reset && pkill -SIGRTMIN+8 waybar",
        "format": "{icon}",
        "format-icons": ["", ""],
    }

Also remember to add the module to the bar:

    "modules-right": ["custom/scroller-mode", "cpu", "memory", "temperature","battery","clock","custom/power"],

Then everything is done.

[dawsers]

Very cool! I'll make a link to your comment from the README. Thank you!

[dovbaeb]

Cannot get it to work at launch, I have to manually start the listener, despite waybar/ being in my path.. I've tried multiple things to no avail...

[dawsers]

I cannot help much because I use ags, but try to use the full path of the script in your configuration and see if that works. Depending on how you start Hyprland, your PATH may not be set yet. So try something like:

exec-once = /home/dovbaeb/.config/waybar/scripts/scroller_mode_listener.sh

Edit: Sorry, I think you need to exec-once the listener only, the reader is launched from waybar, I guess.

[dovbaeb]

you need to run reader o listener at launch ? do they have to be in /scripts folder ? I've just put em in /waybar and only start listener on startup maybe thats my issue ?

[dovbaeb]

oh no wow now it works thank you idk what i changed but it's all good, thanks !

[shackra]

I'm unable to make the listener work unless I run it on a shell. Portion of my configuration which I manage with home-manager:

  88   │ exec-once=systemctl --user start hyprpolkitagent
  89   │ exec-once=dex --autostart --search-paths "$HOME/.config/autostart"
  90   │ exec-once=hyprwall -r
  91   │ exec-once=swaync
  92   │ exec-once=sleep 1 && waybar
  93   │ exec-once=/nix/store/4x3wr09qr80rdsanwy5y9rrw5bxfg854-scroller_mode_listener

the script in question:

➜  bat /nix/store/4x3wr09qr80rdsanwy5y9rrw5bxfg854-scroller_mode_listener
───────┬───────────────────────────────────────────────────────────────────────────────────────────────
       │ File: /nix/store/4x3wr09qr80rdsanwy5y9rrw5bxfg854-scroller_mode_listener
───────┼───────────────────────────────────────────────────────────────────────────────────────────────
   1   │ #!/nix/store/p6k7xp1lsfmbdd731mlglrdj2d66mr82-bash-5.2p37/bin/bash
   2   │ MODE_FILE="/tmp/hyprland_scroller_mode"
   3   │
   4   │ function handle {
   5   │   if [[ ${1:0:8} == "scroller" ]]; then
   6   │     if [[ ${1:10:9} == "mode, row" ]]; then
   7   │         echo "Row" > "$MODE_FILE"
   8   │     elif [[ ${1:10:12} == "mode, column" ]]; then
   9   │         echo "Column" > "$MODE_FILE"
  10   │     #else
  11   │         #echo "" > "$MODE_FILE"
  12   │     fi
  13   │     hyprctl dispatch submap reset && pkill -SIGRTMIN+8 waybar # update the widget on waybar
  14   │   fi
  15   │ }
  16   │
  17   │ # Initialize the mode file
  18   │ echo "" > "$MODE_FILE"
  19   │
  20   │ socat - "UNIX-CONNECT:$XDG_RUNTIME_DIR/hypr/$HYPRLAND_INSTANCE_SIGNATURE/.socket2.sock" | while read -r line; do handle "$line"; done
───────┴───────────────────────────────────────────────────────────────────────────────────────────────

[dawsers]

It may be related to the previous post, some environment variables are not set when Hyprland is launched. If you start Hyprland from a session manager or .bash_profile, your whole environment is not set yet. Instead, when you run your script from the shell, anything you set in .bashrc is available (modifications to your path or other environment variables you may have set there).

So I can only suggest you try to get a log or run Hyprland from the tty to see what the error looks like. Depending on how you start Hyprland, you may need to set more environment variables for the script to work.

I am sorry I cannot be of much more help. I don't use NixOS or waybar.

[Chen-Yulin]

I'm unable to make the listener work unless I run it on a shell. Portion of my configuration which I manage with home-manager:

  88   │ exec-once=systemctl --user start hyprpolkitagent
  89   │ exec-once=dex --autostart --search-paths "$HOME/.config/autostart"
  90   │ exec-once=hyprwall -r
  91   │ exec-once=swaync
  92   │ exec-once=sleep 1 && waybar
  93   │ exec-once=/nix/store/4x3wr09qr80rdsanwy5y9rrw5bxfg854-scroller_mode_listener

try to use a terminal emulator to launch the script like exec-once=alacritty -e /nix/store/4x3wr09qr80rdsanwy5y9rrw5bxfg854-scroller_mode_listener, idk why, but it's the recent feature of hyprland i think.