Powerful workspace management plugin, packed with features
Powerful workspace management plugin, packed with features
[!Important]
- Supports Hyprland releases
v0.46.2-v0.56.2.
https://github.com/user-attachments/assets/8d6cdfd2-2b17-4240-a117-1dbd2231ed4e
hyprpm add https://github.com/raybbian/hyprtasking
hyprpm enable hyprtaskingHyprland plugins must match the compositor ABI exactly. For tagged Hyprland
releases, Hyprpm uses the compatibility pins in hyprpm.toml to select the
corresponding hyprtasking revision.
Add hyprtasking to your flake inputs
# flake.nix
{
inputs = {
hyprland.url = "github:hyprwm/Hyprland/v0.56.0";
hyprtasking = {
url = "github:raybbian/hyprtasking";
inputs.hyprland.follows = "hyprland";
};
};
# ...
}
Include the plugin in the hyprland home manager options
# home.nix
{ inputs, pkgs, ... }:
{
wayland.windowManager.hyprland = {
plugins = [
inputs.hyprtasking.packages.${pkgs.system}.hyprtasking
];
}
}To build, install Hyprland headers from the exact compositor commit you are running and then:
meson setup build
cd build && meson compileThen use hyprctl plugin load to load the absolute path to the .so file:
hyprctl plugin load "$(realpath libhyprtasking.so)"hyprtasking:toggle, all to a keybind to open/close the overlay on all monitors.hyprtasking:toggle, cursor to a keybind to open the overlay on one monitor and close on all monitors.hyprtasking:move to switch to a workspacejump.enabled enabled, press the label shown over a workspace to jump to it
(1-9, 0, then a-z). Set jump.show_workspace_names to display
workspace names such as A1 instead of the keyboard jump labels.Example below:
…Click here to see the old hyprlang syntax
…hyprtasking:if_active, ARG takes in a dispatch command (one that would be used after hyprctl dispatch ...) that will be dispatched only if the cursor overview is active.
escape to close the overview when it is active. See the example config for more info.hyprtasking:if_not_active, ARG same as above, but if the overview is not active.
hyprtasking:toggle [, ARG] takes 1 optional argument that is either cursor or all
all, thencursor or no argument is given, thenhyprtasking:move, ARG takes in 1 argument that is one of up, down, left, right, in, out
hyprtasking:movewindow, ARG takes in 1 argument that is one of up, down, left, right, in, out
Click here to see the coordinate space
hyprtasking:setlayer, ARG takes in 1 optional argument that specifies the direction of movement across layers.
+ or - to take effect. For example: +1, -3+1grid:loop_layers is enabled, will loop the layers if next requested layer is out of bounds (not in the range form 0 to grid:layers)hyprtasking:setlayerwindow, ARG takes in 1 optional argument that specifies the direction of movement across layers.
hyprtasking:setlayer, ARG and also move the window through layershyprtasking:killhovered behaves similarly to the standard killactive dispatcher with focus on hover
hl.dsp.close(), it will work even when the overview is not active.All options are prefixed with plugin:hyprtasking:.
| Option | Type | Description | Default |
|---|---|---|---|
layout |
string |
The layout to use, either grid or linear |
grid |
bg_color |
int |
The color of the background of the overlay | 0x000000FF |
gap_size |
float |
The width in logical pixels of the gaps between workspaces | 8.f |
border_size |
float |
The width in logical pixels of the borders around workspaces | 4.f |
exit_on_hovered |
int |
If true, hiding the workspace will exit to the hovered workspace instead of the active workspace. | false |
warp_on_move_window |
int |
Works the same as cursor:warp_on_change_workspace (see wiki) but with the hyprtasking:movewindow dispatcher. |
|
cursor:warp_on_change_workspace works only with the hyprtasking:move dispatcher |
1 |
||
close_overview_on_reload |
int |
Whether to close the overview if its layout type did not change after a Hyprland config reload | true |
drag_button |
int |
The mouse button to use to drag windows around | 0x110 |
select_button |
int |
The mouse button to use to select a workspace | 0x111 |
gestures:enabled |
int |
Whether or not to enable gestures | true |
gestures:move_fingers |
int |
The number of fingers to use for the "move" gesture | 3 |
gestures:move_distance |
float |
How large of a swipe on the touchpad corresponds to the width of a workspace | 300.f |
gestures:open_fingers |
int |
The number of fingers to use for the "open" gesture | 4 |
gestures:open_distance |
float |
How large of a swipe on the touchpad is needed for the "open" gesture | 300.f |
gestures:open_positive |
int |
true if swiping up should open the overlay, false otherwise |
true |
grid:rows |
int |
The number of rows to display on the grid overlay | 3 |
grid:cols |
int |
The number of columns to display on the grid overlay | 3 |
grid:loop |
int |
When enabled, moving right at the far right of the grid will wrap around to the leftmost workspace, etc. | false |
grid:layers |
int |
The number of layers for grid layout, the third dimension | 1 |
grid:loop_layers |
int |
When enabled, moving back on the first layer will wrap around to the last layer. The reverse also works | true |
grid:gaps_use_aspect_ratio |
int |
When enabled, vertical gaps will be scaled to match the monitor's aspect ratio | false |
linear:top |
int |
Whether or not to position the overview on top of the screen | false |
linear:blur |
int |
Whether or not to blur the dimmed area | true |
linear:height |
float |
The height of the linear overlay in logical pixels | 300.f |
linear:scroll_speed |
float |
Scroll speed modifier. Set negative to flip direction | 1.f |
FYI, "ARG" does not refer to any minecraft ARG. Why would you even ask that? Eww
No open issues yet, or sync has not completed.