6.6 KiB
hy3
i3 / sway like layout for hyprland.
Features
- i3 like tiling
- Window splits
- Window movement
- Window resizing
- Selecting a group of windows at once (and related movement)
- Tabbed groups
- Some convenience dispatchers not found in i3 or sway
Demo
Stability
As of now hy3 is stable enough to use normally. If you encounter any crashes or bugs please report them in the issue tracker.
When reporting bugs, please include:
- Commit hash of the version you are running.
- Steps to reproduce (if you can figure them out)
- backtrace of the crash
If you don't know how to reproduce it or can't, or you can't take a backtrace please still report the issue.
Configuration
Set your general:layout
to hy3
in hyprland.conf.
hy3 requires using a few custom dispatchers for normal operation. In your hyprland config replace the following dispatchers:
movefocus
->hy3:movefocus
movewindow
->hy3:movewindow
You can use hy3:makegroup
to create a new split.
Config fields
plugin {
hy3 {
# disable gaps when only one window is onscreen
no_gaps_when_only = <bool>
# offset from group split direction when only one window is in a group
group_inset = <int>
# tab group settings
tabs {
# height of the tab bar
height = <int>
# padding between the tab bar and its focused node
padding = <int>
# the tab bar should animate in/out from the top instead of below the window
from_top = <bool>
# render the window title on the bar
render_text = <bool>
# rounding of tab bar corners
rounding = <int>
# font to render the window title with
text_font = <string>
# height of the window title
text_height = <int>
# left padding of the window title
text_padding = <int>
# active tab bar segment color
col.active = <color>
# urgent tab bar segment color
col.urgent = <color>
# inactive tab bar segment color
col.inactive = <color>
# active tab bar text color
col.text.active = <color>
# urgent tab bar text color
col.text.urgent = <color>
# inactive tab bar text color
col.text.inactive = <color>
}
}
}
Dispatcher list
hy3:makegroup, <h | v | opposite | tab>, [ephemeral | force_ephemeral]
- make a vertical / horizontal split or tab groupephemeral
- the group will be removed once it contains only one node. does not affect existing groups.force_ephemeral
- same as ephemeral, but converts existing single windows groups.
hy3:movefocus, <l | u | d | r | left | down | up | right>, [visible]
- move the focus left, up, down, or rightvisible
- only move between visible nodes, not hidden tabs
hy3:movewindow, <l | u | d | r | left | down | up | right>, [once]
- move a window left, up, down, or rightonce
- only move directly to the neighboring group, without moving into any of its subgroups
hy3:killactive
- close all windows in the focused nodehy3:changefocus, <top | bottom | raise | lower | tab | tabnode>
top
- focus all nodes in the workspacebottom
- focus the single root selection windowraise
- raise focus one levellower
- lower focus one leveltab
- raise focus to the nearest tabtabnode
- raise focus to the nearest node under the tab
hy3:focustab <mouse | [l | r | left | right | index, <index>], [prioritize_hovered | require_hovered], [wrap]>
mouse
- focus the tab under the mouse, works well with a non consuming bind, e.g.# binds hy3:focustab to lmb and still allows windows to receive clicks bindn = , mouse:272, hy3:focustab, mouse
l | r | left | right
- direction to change focus towardsindex, <index>
- select theindex
th tabprioritize_hovered
- prioritize the tab group under the mouse when multiple are stacked. use the lowest group if none is under the mouse.require_hovered
- affect the tab group under the mouse. do nothing if none are hovered.wrap
- wrap to the opposite size of the tab bar if moving off the end
hy3:setswallow, <true | false | toggle>
- set the containing node's window swallow statehy3:debugnodes
- print the node tree into the hyprland log
Installing
Nix
Hyprland home manager module
Assuming you use hyprland's home manager module, you can easily integrate hy3 by adding it to the plugins array.
# flake.nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
home-manager = {
url = "github:nix-community/home-manager";
inputs.nixpkgs.follows = "nixpkgs";
};
hyprland.url = "github:hyprwm/Hyprland";
hy3 = {
url = "github:outfoxxed/hy3";
inputs.hyprland.follows = "hyprland";
};
};
outputs = { nixpkgs, home-manager, hyprland, hy3, ... }: {
homeConfigurations."user@hostname" = home-manager.lib.homeManagerConfiguration {
pkgs = nixpkgs.legacyPackages.x86_64-linux;
modules = [
hyprland.homeManagerModules.default
{
wayland.windowManager.hyprland = {
enable = true;
plugins = [ hy3.packages.x86_64-linux.hy3 ];
};
}
];
};
};
}
Manual (Nix)
hy3's binary is availible as ${hy3.packages.<system>.hy3}/lib/libhy3.so
, so you can also
directly use it in your hyprland config like so:
# ...
wayland.windowManager.hyprland = {
# ...
extraConfig = ''
plugin = ${hy3.packages.x86_64-linux.hy3}/lib/libhy3.so
'';
};
Arch (AUR)
There is an unofficial hy3-git package,
usable with the hyprland-git
package.
Manual
Install hyprland, including its headers and pkg-config file, then run the following commands:
cmake -DCMAKE_BUILD_TYPE=Debug -B build
cmake --build build
The plugin will be located at build/libhy3.so
, and you can load it normally
(See the hyprland wiki for details.)
Note that the hyprland headers and pkg-config file MUST be installed correctly, for the target version of hyprland.