-
- 
Content:
-
- - This is just a basic config documentation, for a more detailed one, visit our github page - .
-Welcome to Hyprland, now that you've done completing the install, hop onto Hyprland by selecting "Hyprland" on your desired display manager.
-On your first launch, Hyprland should automatically make a config file for you, and you should see something like this -
-
- If it doesn't, you've probly messed up,
-Make sure the default config hyprland.conf exists at ~/.config/hypr.
-If it doesn't, follow along -
-mkdir ~/.config/hypr
-Then copy the code linked below to ~/.config/hypr/hyprland.conf.
-If it still does not work, something must be wrong with your install, try installing Hyprland again or asking our community in our discord server.
-Change the autogenerated=1to 0.
-autogenerated=0
-exec = the TERMINAL command used to start in up.
-exec-once = the TERMINAL command used to start in up.
-Where execwill execute the command on every startup as-well-as every reload whereas-in exec-oncewill only execute the command on startup, avoiding to run during reload(s).
-Eg.
-exec = swaybg -i ~/.config/hypr/wallpapers/wall-1.png
-exec-once = waybar
-Install Hyprpaper* on your system then type the following command-
-Hyprpaper is controlled by the config, like this:
-~/.config/hypr/hyprpaper.conf
-preload = /path/to/image.png
-
-# .. more preloads
-
-wallpaper = monitor,/path/to/image.png
-
-# .. more monitors
Preload will tell Hyprland to load a particular image (supported formats: png, jpg, jpeg). Wallpaper will apply the wallpaper to the selected output (monitor is the monitor's name, easily can be retrieved with hyprctl monitors)
-You may add contain: before the file path in wallpaper= to set the mode to contain instead of cover:
-wallpaper = monitor,contain:/path/to/image.jpg
- -A Wallpaper cannot be applied without preloading. The config is not reloaded dynamically.
- -*NOTE: Legacy X11 wallpaper managers like feh and nitrogen may not work on Wayland Compositor(s) such as Hyprland.
-Your monitor can be configured by changing the monitor = line on top of your hyprland.conffile.
-monitor = name,res,offset,scale
-eg.
-monitor = DP-1,1920x1080@240,0x0,1
-will tell Hyprland to make the monitor on DP-1with resolution 1920x1080capped at 240 hz, 0x0off from the beginning at a scale of 1.
-Increasing the scale will make everything large.
-Please use the offset for its intended purpose before asking stupid questions about "fixing" monitors being mirrored.
-Please remember the offset is calculated with the scaled resolution, meaning if you want your 4K monitor with scale 2 to the left of your 1080p one, you'd use the offset 1920x0 for the second screen. (3840 / 2)
-To disable a monitor,
-monitor = NAME, disable
-If your workflow requires custom reserved area, you can add it with
-monitor = NAME, ADDRESERVED, TOP, BOTTOM, LEFT, RIGHT
-Where Top BOTTOM LEFT and RIGHT are integers in pixels of the reserved area to add. This does stack on top of the calculated one, (e.g. bars) but you may only use one of these rules per monitor in the config.
-workspace = NAME, NUMBER
-Will tell Hyprland where to make the default workspace of a specific monitor
-If you want to rotate a monitor,
-monitor= NAME,transform,TRANSFORM
-where NAME is the name, and TRANSFORM is an integer, from 0 to 7, corresponding to your transform of choice.
-WL_OUTPUT_TRANSFORM_NORMAL = 0
-WL_OUTPUT_TRANSFORM_90 = 1
-WL_OUTPUT_TRANSFORM_180 = 2
-WL_OUTPUT_TRANSFORM_270 = 3
-WL_OUTPUT_TRANSFORM_FLIPPED = 4
-WL_OUTPUT_TRANSFORM_FLIPPED_90 = 5
-WL_OUTPUT_TRANSFORM_FLIPPED_180 = 6
-WL_OUTPUT_TRANSFORM_FLIPPED_270 = 7
-- bind = SUPER, key, dispatcher, params -
SUPER (or MOD) = Win/Alt Key
-SUPERSHIFT = Win/Alt + Shift*
-SUPERCTRL = Win/Alt + Ctrl*
-ALT = Alt key (independent of the mod key)
-You can even use functional keys
-fx= function key where x is your 1st-12th key
eg. f5
Introduction Flags!
-l -> locked, aka. works also when an input inhibitor is active
-r -> release, will trigger on release of a key
-e -> repeat, will repeat when held.
How to use flags?
-bind[Flag] = ...
Eg.
-bindrl=MOD,KEY,exec,amongus
For a full list of dispacters, click here.
-workspace args are unified. You have six choices:
- ID: e.g. 1, 2, or 3
- Relative ID: e.g. +1, -3 or +100
- Relative workspace on monitor: e.g. m+1, m-1 or m+3
- Relative open workspace: e.g. e+1 or e-10
- Name: e.g. name:Web, name:Anime or name:Better anime
- Special Workspace: special Warning: special is supported ONLY on movetoworkspace. Any other dispatcher will result in undocumented behavior.
You can set window rules for various actions. These are applied on window open!
-windowrule=RULE,WINDOW
-RULE is a rule (and a param if applicable)
-WINDOW is a RegEx, either:
-You can get both by typing hyprctl clientsin your terminal.
-A full list of rules can be found here.
-Eg.
-windowrule=float,kitty
-windowrule=monitor 0,Firefox
-windowrule=opacity 0.8,Discord
Animations are declared with the animation keyword
-animation=NAME,ONOFF,SPEED,CURVE,STYLE
-NAME can be either 0 or 1, 0 to disable, 1 to enable.
-ONOFF is the amount of ds (1ds = 100ms) the animation will take
-CURVE is the bezier curve name, see curves above.
-STYLE (optional) is the animation style
-Eg.
-animation=workspaces,1,8,default
-animation=windows,1,10,myepiccurve,slide
-The animations are a tree. If an animation is unset, it will inherit its' parent's values.
-You can define your own custom variables like this:
-$VAR = value
Then, to use them, simply use them. For example:
-col.active_border=$MyColor
Use the source keyword to source another file.
-For example, in your hyprland.conf you can:
-source=~/.config/hypr/myColors.conf
Please note it's LINEAR. Meaning lines above the source= will be parsed first, then lines inside ~/.config/hypr/myColors.conf, then lines below.
-If you want keybind submaps, for example if you press ALT+R, you can enter a "resize" mode, resize with arrow keys, and leave with escape, do it like this:
-bind=ALT,R,submap,resize # will switch to a submap called resize
-submap=resize # will start a submap called "resize"
-bind=,right,resizeactive,10 0
-bind=,left,resizeactive,-10 0
-bind=,up,resizeactive,0 -10
-bind=,down,resizeactive,0 10
-bind=,escape,submap,reset # use reset to go back to the global submap
-submap=reset # will reset the submap, meaning end the current one and return to the global one. -
--# keybinds further down will be global again...
IMPORTANT: do not forget a keybind to reset the keymap while inside it! (In this case, escape)
-If you get stuck inside a keymap, you can use hyprctl dispatch submap reset to go back. If you do not have a terminal open, tough luck buddy. I warned you.
-Warning: Some configs, notably touchpad ones, require a Hyprland restart.
-Per-device config options will overwrite your options set in the input section. It's worth noting that ONLY values explicitly changed will be overwritten.
-In order to apply per-device config options, make a new category like this:
-
- device:name {
-
-}
the name can be easily obtained by doing hyprctl devices.
-Inside of it, put your config options. All options from the input category (and all subcategories, e.g. input:touchpad) can be put inside, EXCEPT:
-For example:
-
- device:ROYUAN Akko Multi-modes Keyboard-B {
- repeat_rate=50
- repeat_delay=500
- middle_button_emulation=0
- }
remember about the space after the end of the device's name (before the {)!
-LayerSurfaces are not windows. These are for example: Your wallpapers, notification overlays, bars, etc.
-If you really want to blur them, use blurls=
-blurls=NAMESPACE
where NAMESPACE is the namespace of the layerSurface. (You can get it from hyprctl layers )
-to remove a namespace from being blurred (useful in dynamic situations) use:
-blurls=remove,NAMESPACE
-
+
+ Github
+
++ A dynamic tiling + Wayland + compositor based on + wlroots + that doesn't sacrifice on its looks. +
+Install Hyprland
+ 
+ 
+ 
+ 
+ 
+ Hyprland offers super smooth and responsive animations, be it when + switching between windows or workspaces, resizing windows or + simply moving them around, plus you can easily customize it!
+Tiling in Hyprland is "dynamic" meaning it handles the placement + of windows automatically acquiring the position of your cursor. + Hyprland also supports a variety of other layouts including + floating, pseudotiling and even fullscreen!
+Editing the config file for Hyprland is as easy as editing a word + document, if you need any assist in configuring it, be sure to + check the + Wiki Page or feel + free to ask us + @Discord.
+
-
- 
- - NVIDIA GPUs in ANY capacity are NOT supported, but you may ask - for some help around on the - Discord server, - people have been running Hyprland on NVIDIA with success.* -
-Requirements -
-Content:
-hyprland-git - compiles from latest source
-hyprland - compiles from latest release source
-hyprland-bin - compiled latest release
-- Make sure to check out the options of the - - Nix module. -
-
- # flake.nix
-
- {
- inputs = {
- nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
- hyprland = {
- url = "github:hyprwm/Hyprland";
- # build with your own instance of nixpkgs
- inputs.nixpkgs.follows = "nixpkgs";
- };
- };
-
- outputs = { self, nixpkgs, hyprland }: {
- nixosConfigurations.HOSTNAME =
- nixpkgs.lib.nixosSystem {
- # ...
- modules = [
- hyprland.nixosModules.default
- { programs.hyprland.enable = true; }
- # ...
- ];
- };
- };
-
- Don't forget to replace HOSTNAME with your - hostname! -
-- NOTE: If you're using Hyprland through an overlay, set - programs.hyprland.package = pkgs.hyprland; -
-
- # configuration.nix
- {config, pkgs, ...}: let
- flake-compat = builtins.fetchTarball
- "https://github.com/edolstra/flake-compat/archive/master.tar.gz";
-
- hyprland = (import flake-compat {
- src = builtins.fetchTarball
- "https://github.com/hyprwm/Hyprland/archive/master.tar.gz";
- }).defaultNix;
- in {
- imports = [
- hyprland.nixosModules.default
- ];
-
- nixpkgs.overlays = [ hyprland.overlays.default ];
-
- programs.hyprland = {
- enable = true;
- package = pkgs.hyprland;
- };
- }
-
- You can use the Home Manager module by adding it to your configuration: -
-
- { config, pkgs, inputs, ... }: {
- imports = [
- inputs.hyprland.homeManagerModules.default
- ];
-
- wayland.windowManager.hyprland.enable = true;
- # ...
- }
-
- For a list of available options, check the - - module file. -
-- If you plan on using the HM module alongside the NixOS module, set the - NixOS programs.hyprland.package = null; -
-- If you don't plan on using the NixOS module, but want to use the HM - module, you will have to enable all the options the NixOS module - enables. -
-- If you don't plan on using any module, manually enable whatever - options the modules set. -
-- The steps to build Hyprland on Fedora are relatively simple and very - similar to the steps described in the wiki. The main difference is in - the package names between Arch and Fedora. These steps were tested on - Fedora 35 and Fedora 36 Workstation. -
-Step 1 - Install all the Dependencies
-- sudo dnf install git ninja-build cmake meson gcc-c++ libxcb-devel - libX11-devel pixman-devel wayland-protocols-devel cairo-devel - pango-devel -
-Step 2 - Download the Hyprland Source Code
-- git clone - --recursive - https://github.com/hyprwm/Hyprland -
-- The - --recursive - argument is important - it will clone the required branch of wlroots - into the subprojects directory. Note that compiling with the master - branch of wlroots will cause compiler errors - you need the branch of - wlroots with the modified structures. -
-Now you're ready to build Hyprland.
-
- cd Hyprland
- meson _build
- ninja -C _build
- sudo ninja -C _build install
-
Finally, Copy the sample config into place
-
- mkdir -p ~/.config/hypr
- cp example/hyprland.conf ~/.config/hypr
-
- NOTE FOR GDM USERS: Hyprland may not show if gdm is - running in a X session instead of Wayland, check - /etc/gdm/custom.conf to make sure Wayland is - enabled -
-Step 1 - Install these Dependencies* -
-- gdb ninja gcc cmake libxcb xcb-proto xcb-util xcb-util-keysyms - libxfixes libx11 libxcomposite xorg-xinput libxrender pixman - wayland-protocols cairo pango -
-- *Please note Hyprland builds - wlroots. Make sure you - have the dependencies of wlroots installed, you can make sure you have - them by installing wlroots separately (Hyprland doesn't mind). -
-- Also note that Hyprland uses the C++23 standard, so your compiler has to - support gcc>=12.1.0 or - clang>=15. -
-Step 2 - Download Hyprland source code
-
- cd ~
- git clone
- --recursive
- https://github.com/hyprwm/Hyprland
-
- The - --recursive - argument is important - it will clone the required branch of wlroots - into the subprojects directory. Note that compiling with the master - branch of wlroots will cause compiler errors - you need the branch of - wlroots with the modified structures. -
-
- cd Hyprland
- sudo make install
-
- meson _build
- ninja -C _build
- sudo ninja -C _build install
-
Finally, Step 4 - Copy the config
-
- mkdir -p ~/.config/hypr
- cp example/hyprland.conf ~/.config/hypr
-
- If you have any doubt(s) or are getting any error(s), please- -
-