Variables

Variables

For basic syntax info, see Configuring Hyprland.

This page documents all the “options” of Hyprland. For binds, monitors, animations, etc. see the sidebar. For anything else, see Keywords.

Please keep in mind some options that are layout-specific will be documented in the layout pages and not here. (See the Sidebar for Dwindle and Master layouts)

Variable types

typedescription
intinteger
boolboolean, true or false (yes or no, on or off, 0 or 1) - any numerical value that is not 0 or 1 will cause undefined behavior.
floatfloating point number
colorcolor (see hint below for color info)
vec2vector with 2 float values, separated by a space (e.g. 0 0 or -10.9 99.1)
MODa string modmask (e.g. SUPER or SUPERSHIFT or SUPER + SHIFT or SUPER and SHIFT or CTRL_SHIFT or empty for none. You are allowed to put any separators you please except for a ,)
stra string
gradienta gradient, in the form of color color ... [angle] where color is a color (see above) and angle is an angle in degrees, in the format of 123deg e.g. 45deg (e.g. rgba(11ee11ff) rgba(1111eeff) 45deg) Angle is optional and will default to 0deg
ℹ️

Colors:

You have 3 options:

rgba(), e.g. rgba(b3ff1aee)

rgb(), e.g. rgb(b3ff1a)

legacy, e.g. 0xeeb3ff1a -> ARGB order

Mod list:

SHIFT CAPS CTRL/CONTROL ALT MOD2 MOD3 SUPER/WIN/LOGO/MOD4 MOD5

Sections

General

namedescriptiontypedefault
sensitivitymouse sensitivity (legacy, may cause bugs if not 1, prefer input:sensitivity)float1.0
border_sizesize of the border around windowsint1
no_border_on_floatingdisable borders for floating windowsboolfalse
gaps_ingaps between windows, also supports css style gaps (top, right, bottom, left -> 5,10,15,20)int5
gaps_outgaps between windows and monitor edges, also supports css style gaps (top, right, bottom, left -> 5,10,15,20)int20
gaps_workspacesgaps between workspaces. Stacks with gaps_out.int0
col.inactive_borderborder color for inactive windowsgradient0xff444444
col.active_borderborder color for the active windowgradient0xffffffff
col.nogroup_borderinactive border color for window that cannot be added to a group (see denywindowfromgroup dispatcher)gradient0xffffaaff
col.nogroup_border_activeactive border color for window that cannot be added to a groupgradient0xffff00ff
cursor_inactive_timeoutin seconds, after how many seconds of cursor’s inactivity to hide it. Set to 0 for never.int0
layoutwhich layout to use. [dwindle/master]strdwindle
no_cursor_warpsif true, will not warp the cursor in many cases (focusing, keybinds, etc)boolfalse
no_focus_fallbackif true, will not fall back to the next available window when moving focus in a direction where no window was foundboolfalse
apply_sens_to_rawif on, will also apply the sensitivity to raw mouse output (e.g. sensitivity in games) NOTICE: really not recommended.boolfalse
resize_on_borderenables resizing windows by clicking and dragging on borders and gapsboolfalse
extend_border_grab_areaextends the area around the border where you can click and drag on, only used when general:resize_on_border is on.int15
hover_icon_on_bordershow a cursor icon when hovering over borders, only used when general:resize_on_border is on.booltrue
allow_tearingmaster switch for allowing tearing to occur. See the Tearing page.boolfalse
resize_cornerforce floating windows to use a specific corner when being resized (1-4 going clockwise from top left, 0 to disable)int0
⚠️
Prefer using input:sensitivity over general:sensitivity to avoid bugs, especially with Wine/Proton apps.

Decoration

namedescriptiontypedefault
roundingrounded corners’ radius (in layout px)int0
active_opacityopacity of active windows. [0.0 - 1.0]float1.0
inactive_opacityopacity of inactive windows. [0.0 - 1.0]float1.0
fullscreen_opacityopacity of fullscreen windows. [0.0 - 1.0]float1.0
drop_shadowenable drop shadows on windowsbooltrue
shadow_rangeShadow range (“size”) in layout pxint4
shadow_render_powerin what power to render the falloff (more power, the faster the falloff) [1 - 4]int3
shadow_ignore_windowif true, the shadow will not be rendered behind the window itself, only around it.booltrue
col.shadowshadow’s color. Alpha dictates shadow’s opacity.color0xee1a1a1a
col.shadow_inactiveinactive shadow color. (if not set, will fall back to col.shadow)colorunset
shadow_offsetshadow’s rendering offset.vec2[0, 0]
shadow_scaleshadow’s scale. [0.0 - 1.0]float1.0
dim_inactiveenables dimming of inactive windowsboolfalse
dim_strengthhow much inactive windows should be dimmed [0.0 - 1.0]float0.5
dim_specialhow much to dim the rest of the screen by when a special workspace is open. [0.0 - 1.0]float0.2
dim_aroundhow much the dimaround window rule should dim by. [0.0 - 1.0]float0.4
screen_shadera path to a custom shader to be applied at the end of rendering. See examples/screenShader.frag for an example.str[[Empty]]

Blur

Subcategory decoration:blur:

namedescriptiontypedefault
enabledenable kawase window background blurbooltrue
sizeblur size (distance)int8
passesthe amount of passes to performint1
ignore_opacitymake the blur layer ignore the opacity of the windowboolfalse
new_optimizationswhether to enable further optimizations to the blur. Recommended to leave on, as it will massively improve performance.booltrue
xrayif enabled, floating windows will ignore tiled windows in their blur. Only available if blur_new_optimizations is true. Will reduce overhead on floating blur significantly.boolfalse
noisehow much noise to apply. [0.0 - 1.0]float0.0117
contrastcontrast modulation for blur. [0.0 - 2.0]float0.8916
brightnessbrightness modulation for blur. [0.0 - 2.0]float0.8172
vibrancyIncrease saturation of blurred colors. [0.0 - 1.0]float0.1696
vibrancy_darknessHow strong the effect of vibrancy is on dark areas . [0.0 - 1.0]float0.0
specialwhether to blur behind the special workspace (note: expensive)boolfalse
popupswhether to blur popups (e.g. right-click menus)boolfalse
popups_ignorealphaworks like ignorealpha in layer rules. If pixel opacity is below set value, will not blur. [0.0 - 1.0]float0.2

A subcategory is a nested category:

decoration {
    # ...
    # ...

    blur {
        # ...
        # ...
    }
}

Doing decoration:blur { is invalid!

ℹ️

blur:size and blur:passes have to be at least 1.

Increasing blur:passes is necessary to prevent blur looking wrong on higher blur:size values, but remember that higher blur:passes will require more strain on the GPU.

Animations

namedescriptiontypedefault
enabledenable animationsbooltrue
first_launch_animationenable first launch animationbooltrue

Input

namedescriptiontypedefault
kb_modelAppropriate XKB keymap parameter. See the note below.str[[Empty]]
kb_layoutAppropriate XKB keymap parameterstrus
kb_variantAppropriate XKB keymap parameterstr[[Empty]]
kb_optionsAppropriate XKB keymap parameterstr[[Empty]]
kb_rulesAppropriate XKB keymap parameterstr[[Empty]]
kb_fileIf you prefer, you can use a path to your custom .xkb file.str[[Empty]]
numlock_by_defaultEngage numlock by default.boolfalse
resolve_binds_by_symDetermines how keybinds act when multiple layouts are used. If false, keybinds will always act as if the first specified layout is active. If true, keybinds specified by symbols are activated when you type the respective symbol with the current layout.boolfalse
repeat_rateThe repeat rate for held-down keys, in repeats per second.int25
repeat_delayDelay before a held-down key is repeated, in milliseconds.int600
sensitivitySets the mouse input sensitivity. Value is clamped to the range -1.0 to 1.0. libinput#pointer-accelerationfloat0.0
accel_profileSets the cursor acceleration profile. Can be one of adaptive, flat. Can also be custom, see below. Leave empty to use libinput’s default mode for your input device. libinput#pointer-acceleration [adaptive/flat/custom]str[[Empty]]
force_no_accelForce no cursor acceleration. This bypasses most of your pointer settings to get as raw of a signal as possible. Enabling this is not recommended due to potential cursor desynchronization.boolfalse
left_handedSwitches RMB and LMBboolfalse
scroll_pointsSets the scroll acceleration profile, when accel_profile is set to custom. Has to be in the form <step> <points>. Leave empty to have a flat scroll curve.str[[Empty]]
scroll_methodSets the scroll method. Can be one of 2fg (2 fingers), edge, on_button_down, no_scroll. libinput#scrolling [2fg/edge/on_button_down/no_scroll]str[[Empty]]
scroll_buttonSets the scroll button. Has to be an int, cannot be a string. Check wev if you have any doubts regarding the ID. 0 means default.int0
scroll_button_lockIf the scroll button lock is enabled, the button does not need to be held down. Pressing and releasing the button toggles the button lock, which logically holds the button down or releases it. While the button is logically held down, motion events are converted to scroll events.bool0
scroll_factorMultiplier added to scroll movement for external mice. Note that there is a separate setting for touchpad scroll_factor.float1.0
natural_scrollInverts scrolling direction. When enabled, scrolling moves content directly, rather than manipulating a scrollbar.boolfalse
follow_mouseSpecify if and how cursor movement should affect window focus. See the note below. [0/1/2/3]int1
mouse_refocusIf disabled, mouse focus won’t switch to the hovered window unless the mouse crosses a window boundary when follow_mouse=1.booltrue
float_switch_override_focusIf enabled (1 or 2), focus will change to the window under the cursor when changing from tiled-to-floating and vice versa. If 2, focus will also follow mouse on float-to-float switches.int1
special_fallthroughif enabled, having only floating windows in the special workspace will not block focusing windows in the regular workspace.boolfalse
off_window_axis_eventsHandles axis events around (gaps/border for tiled, dragarea/border for floated) a focused window. 0 ignores axis events 1 sends out-of-bound coordinates 2 fakes pointer coordinates to the closest point inside the window 3 warps the cursor to the closest point inside the windowint1
ℹ️

XKB Settings

You can find a list of models, layouts, variants and options in /usr/share/X11/xkb/rules/base.lst. Alternatively, you can use the localectl command to discover what is available on your system.

For switchable keyboard configurations, take a look at the uncommon tips & tricks page entry.

ℹ️

Follow Mouse Cursor

  • 0 - Cursor movement will not change focus.
  • 1 - Cursor movement will always change focus to the window under the cursor.
  • 2 - Cursor focus will be detached from keyboard focus. Clicking on a window will move keyboard focus to that window.
  • 3 - Cursor focus will be completely separate from keyboard focus. Clicking on a window will not change keyboard focus.

Custom accel profiles

accel_profile

custom <step> <points...>

Example: custom 200 0.0 0.5

scroll_points

NOTE: Only works when accel_profile is set to custom.

<step> <points...>

Example: 0.2 0.0 0.5 1 1.2 1.5

To mimic the Windows acceleration curves, take a look at this script.

See the libinput doc for more insights on how it works.

Touchpad

Subcategory input:touchpad:

namedescriptiontypedefault
disable_while_typingDisable the touchpad while typing.booltrue
natural_scrollInverts scrolling direction. When enabled, scrolling moves content directly, rather than manipulating a scrollbar.boolfalse
scroll_factorMultiplier applied to the amount of scroll movement.float1.0
middle_button_emulationSending LMB and RMB simultaneously will be interpreted as a middle click. This disables any touchpad area that would normally send a middle click based on location. libinput#middle-button-emulationboolfalse
tap_button_mapSets the tap button mapping for touchpad button emulation. Can be one of lrm (default) or lmr (Left, Middle, Right Buttons). [lrm/lmr]str[[Empty]]
clickfinger_behaviorButton presses with 1, 2, or 3 fingers will be mapped to LMB, RMB, and MMB respectively. This disables interpretation of clicks based on location on the touchpad. libinput#clickfinger-behaviorboolfalse
tap-to-clickTapping on the touchpad with 1, 2, or 3 fingers will send LMB, RMB, and MMB respectively.booltrue
drag_lockWhen enabled, lifting the finger off for a short time while dragging will not drop the dragged item. libinput#tap-and-dragboolfalse
tap-and-dragSets the tap and drag mode for the touchpadboolfalse

Touchdevice

Subcategory input:touchdevice:

namedescriptiontypedefault
transformTransform the input from touchdevices. The possible transformations are the same as those of the monitorsint0
outputThe monitor to bind touch devices. The default is auto-detection. To stop auto-detection, use an empty string or the “[[Empty]]” value.string[[Auto]]
enabledWhether input is enabled for touch devices.booltrue

Tablet

Subcategory input:tablet:

namedescriptiontypedefault
transformtransform the input from tablets. The possible transformations are the same as those of the monitorsint0
outputthe monitor to bind tablets. Empty means unbound.string[[Empty]]
region_positionposition of the mapped region in monitor layout.vec2[0, 0]
region_sizesize of the mapped region. When this variable is set, tablet input will be mapped to the region. [0, 0] or invalid size means unset.vec2[0, 0]
relative_inputwhether the input should be relativeboolfalse
left_handedif enabled, the tablet will be rotated 180 degreesboolfalse
active_area_sizesize of tablet’s active area in mmvec2[0, 0]
active_area_positionposition of the active area in mmvec2[0, 0]

Per-device input config

Described here.

Gestures

namedescriptiontypedefault
workspace_swipeenable workspace swipe gesture on touchpadboolfalse
workspace_swipe_fingershow many fingers for the touchpad gestureint3
workspace_swipe_distancein px, the distance of the touchpad gestureint300
workspace_swipe_touchenable workspace swiping from the edge of a touchscreenboolfalse
workspace_swipe_invertinvert the directionbooltrue
workspace_swipe_min_speed_to_forceminimum speed in px per timepoint to force the change ignoring cancel_ratio. Setting to 0 will disable this mechanic.int30
workspace_swipe_cancel_ratiohow much the swipe has to proceed in order to commence it. (0.7 -> if > 0.7 * distance, switch, if less, revert) [0.0 - 1.0]float0.5
workspace_swipe_create_newwhether a swipe right on the last workspace should create a new one.booltrue
workspace_swipe_direction_lockif enabled, switching direction will be locked when you swipe past the direction_lock_threshold (touchpad only).booltrue
workspace_swipe_direction_lock_thresholdin px, the distance to swipe before direction lock activates (touchpad only).int10
workspace_swipe_foreverif enabled, swiping will not clamp at the neighboring workspaces but continue to the further ones.boolfalse
workspace_swipe_use_rif enabled, swiping will use the r prefix instead of the m prefix for finding workspaces.boolfalse

Group

namedescriptiontypedefault
insert_after_currentwhether new windows in a group spawn after current or at group tailbooltrue
focus_removed_windowwhether Hyprland should focus on the window that has just been moved out of the groupbooltrue
col.border_activeactive group border colorgradient0x66ffff00
col.border_inactiveinactive (out of focus) group border colorgradient0x66777700
col.border_locked_activeactive locked group border colorgradient0x66ff5500
col.border_locked_inactiveinactive locked group border colorgradient0x66775500

Groupbar

Subcategory group:groupbar:

namedescriptiontypedefault
enabledenables groupbarsbooltrue
font_familyfont used to display groupbar titlesstringSans
font_sizefont size of groupbar titleint8
gradientsenables gradientsbooltrue
heightheight of the groupbarint14
prioritysets the decoration priority for groupbarsint3
render_titleswhether to render titles in the group bar decorationbooltrue
scrollingwhether scrolling in the groupbar changes group active windowbooltrue
text_colorcontrols the group bar text colorcolor0xffffffff
col.activeactive group border colorgradient0x66ffff00
col.inactiveinactive (out of focus) group border colorgradient0x66777700
col.locked_activeactive locked group border colorgradient0x66ff5500
col.locked_inactiveinactive locked group border colorgradient0x66775500

Misc

namedescriptiontypedefault
disable_hyprland_logodisables the random Hyprland logo / anime girl background. :(boolfalse
disable_splash_renderingdisables the Hyprland splash rendering. (requires a monitor reload to take effect)boolfalse
col.splashChanges the color of the splash text (requires a monitor reload to take effect).color0xffffffff
splash_font_familyChanges the font used to render the splash text, selected from system fonts (requires a monitor reload to take effect).stringSans
force_default_wallpaperEnforce any of the 3 default wallpapers. Setting this to 0 or 1 disables the anime background. -1 means “random”. [-1/0/1/2]int-1
vfrcontrols the VFR status of Hyprland. Heavily recommended to leave enabled to conserve resources.booltrue
vrrcontrols the VRR (Adaptive Sync) of your monitors. 0 - off, 1 - on, 2 - fullscreen only [0/1/2]int0
mouse_move_enables_dpmsIf DPMS is set to off, wake up the monitors if the mouse moves.boolfalse
key_press_enables_dpmsIf DPMS is set to off, wake up the monitors if a key is pressed.boolfalse
always_follow_on_dndWill make mouse focus follow the mouse when drag and dropping. Recommended to leave it enabled, especially for people using focus follows mouse at 0.booltrue
layers_hog_keyboard_focusIf true, will make keyboard-interactive layers keep their focus on mouse move (e.g. wofi, bemenu)booltrue
animate_manual_resizesIf true, will animate manual window resizes/movesboolfalse
animate_mouse_windowdraggingIf true, will animate windows being dragged by mouse, note that this can cause weird behavior on some curvesboolfalse
disable_autoreloadIf true, the config will not reload automatically on save, and instead needs to be reloaded with hyprctl reload. Might save on battery.boolfalse
enable_swallowEnable window swallowingboolfalse
swallow_regexThe class regex to be used for windows that should be swallowed (usually, a terminal). To know more about the list of regex which can be used use this cheatsheet.str[[Empty]]
swallow_exception_regexThe title regex to be used for windows that should not be swallowed by the windows specified in swallow_regex (e.g. wev). The regex is matched against the parent (e.g. Kitty) window’s title on the assumption that it changes to whatever process it’s running.str[[Empty]]
focus_on_activateWhether Hyprland should focus an app that requests to be focused (an activate request)boolfalse
no_direct_scanoutDisables direct scanout. Direct scanout attempts to reduce lag when there is only one fullscreen application on a screen (e.g. game). It is also recommended to set this to true if the fullscreen application shows graphical glitches.booltrue
hide_cursor_on_touchHides the cursor when the last input was a touch input until a mouse input is done.boolfalse
hide_cursor_on_key_pressHides the cursor when you press any key until the mouse is moved.booltrue
mouse_move_focuses_monitorWhether mouse moving into a different monitor should focus itbooltrue
suppress_portal_warningsdisables warnings about incompatible portal implementations.boolfalse
render_ahead_of_time[Warning: buggy] starts rendering before your monitor displays a frame in order to lower latencyboolfalse
render_ahead_safezonehow many ms of safezone to add to rendering ahead of time. Recommended 1-2.int1
cursor_zoom_factorthe factor to zoom by around the cursor. Like a magnifying glass. Minimum 1.0 (meaning no zoom)float1.0
cursor_zoom_rigidwhether the zoom should follow the cursor rigidly (cursor is always centered if it can be) or looselyboolfalse
allow_session_lock_restoreif true, will allow you to restart a lockscreen app in case it crashes (red screen of death)boolfalse
background_colorchange the background color. (requires enabled disable_hyprland_logo)color0x111111
close_special_on_emptyclose the special workspace if the last window is removedbooltrue
new_window_takes_over_fullscreenif there is a fullscreen window, whether a new tiled window opened should replace the fullscreen one or stay behind. 0 - behind, 1 - takes over, 2 - unfullscreen the current fullscreen window [0/1/2]int0
enable_hyprcursorwhether to enable hyprcursor supportbooltrue
initial_workspace_trackingif enabled, windows will open on the workspace they were invoked on. 0 - disabled, 1 - single-shot, 2 - persistent (all children too)int1

Binds

namedescriptiontypedefault
pass_mouse_when_boundif disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered.boolfalse
scroll_event_delayin ms, how many ms to wait after a scroll event to allow passing another one for the binds.int300
workspace_back_and_forthIf enabled, an attempt to switch to the currently focused workspace will instead switch to the previous workspace. Akin to i3’s auto_back_and_forth.boolfalse
allow_workspace_cyclesIf enabled, workspaces don’t forget their previous workspace, so cycles can be created by switching to the first workspace in a sequence, then endlessly going to the previous workspace.boolfalse
workspace_center_onWhether switching workspaces should center the cursor on the workspace (0) or on the last active window for that workspace (1)int0
focus_preferred_methodsets the preferred focus finding method when using focuswindow/movewindow/etc with a direction. 0 - history (recent have priority), 1 - length (longer shared edges have priority)int0
ignore_group_lockIf enabled, dispatchers like moveintogroup, moveoutofgroup and movewindoworgroup will ignore lock per group.boolfalse
movefocus_cycles_fullscreenIf enabled, when on a fullscreen window, movefocus will cycle fullscreen, if not, it will move the focus in a direction.booltrue
disable_keybind_grabbingIf enabled, apps that request keybinds to be disabled (e.g. VMs) will not be able to do so.boolfalse

XWayland

namedescriptiontypedefault
use_nearest_neighboruses the nearest neigbor filtering for xwayland apps, making them pixelated rather than blurrybooltrue
force_zero_scalingforces a scale of 1 on xwayland windows on scaled displays.boolfalse

OpenGL

namedescriptiontypedefault
nvidia_anti_flickerreduces flickering on nvidia at the cost of possible frame drops on lower-end GPUs. On non-nvidia, this is ignored.booltrue
force_introspectionforces introspection at all times. Introspection is aimed at reducing GPU usage in certain cases, but might cause graphical glitches on nvidia. 0 - nothing, 1 - force always on, 2 - force always on if nvidiaint2

Debug

⚠️
Only for developers.
namedescriptiontypedefault
overlayprint the debug performance overlay. Disable VFR for accurate results.boolfalse
damage_blink(epilepsy warning!) flash areas updated with damage trackingboolfalse
disable_logsdisable logging to a filebooltrue
disable_timedisables time loggingbooltrue
damage_trackingredraw only the needed bits of the display. Do not change. (default: full - 2) monitor - 1, none - 0int2
enable_stdout_logsenables logging to stdoutboolfalse
manual_crashset to 1 and then back to 0 to crash Hyprland.int0
suppress_errorsif true, do not display config file parsing errors.boolfalse
watchdog_timeoutsets the timeout in seconds for watchdog to abort processing of a signal of the main thread. Set to 0 to disable.int5
disable_scale_checksdisables verification of the scale factors. Will result in pixel alignment and rounding errors.boolfalse
error_limitlimits the number of displayed config file parsing errors.int5

More

There are more config options described in other pages, which are layout- or circumstance-specific. See the sidebar for more pages.