Hyprnix Documentation Options

_module.args Link copied!

Type: lazy attribute set of raw value

Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath.

This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument name which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute.

Some arguments are already passed by default, of which the following cannot be changed with this option:

  • lib: The nixpkgs library.

  • config: The results of all options after merging the values from all modules together.

  • options: The options declared in all modules.

  • specialArgs: The specialArgs argument passed to evalModules.

  • All attributes of specialArgs

    Whereas option values can generally depend on other option values thanks to laziness, this does not apply to imports, which must be computed statically before anything else.

    For this reason, callers of the module system can provide specialArgs which are available during import resolution.

    For NixOS, specialArgs includes modulesPath, which allows you to import extra modules from the nixpkgs package tree without having to somehow make the module aware of the location of the nixpkgs or NixOS directories.

    { modulesPath, ... }: {
      imports = [
        (modulesPath + "/profiles/minimal.nix")
      ];
    }
    

For NixOS, the default value for this option includes at least this argument:

  • pkgs: The nixpkgs package set according to the nixpkgs.pkgs option.
Default: { }
Declared in: lib/modules.nix

hyprnix.enable Link copied!

Type: boolean

Whether to enable hyprnix.

Default: false
Example: true

hyprnix.extraConfig Link copied!

Type: strings concatenated with "\n"

Extra configuration lines to append to the bottom of ~/.config/hypr/hyprland.conf.

Default: ""

hyprnix.package Link copied!

Type: null or package

The hyprland package to use. Set this to null if you use the NixOS module to install Hyprland.

Default: null

hyprnix.plugins Link copied!

Type: list of (package or absolute path)

List of Hyprland plugins to use.

Default: [ ]

hyprnix.portalPackage Link copied!

Type: null or package

The xdg-desktop-portal-hyprland package to use. Set this to null if you use the NixOS module to install Hyprland.

Default: null

hyprnix.settings.animations.animations Link copied!

Type: list of (submodule)

This option has no description.

Default: [ ]

hyprnix.settings.animations.animations.*.curve Link copied!

Type: string

Bezier curve name

Example: "linear"

hyprnix.settings.animations.animations.*.name Link copied!

Type: string

Name of the animation

Example: "workspacesIn"

hyprnix.settings.animations.animations.*.speed Link copied!

Type: positive integer, meaning >0

Amount of ds (1ds = 100ms) the animation will take

Example: 10

hyprnix.settings.animations.animations.*.style Link copied!

Type: null or string

Animation style (optional, depends on animation name)

Default: null

hyprnix.settings.animations.bezier Link copied!

Type: attribute set of list with 4 number values

This option has no description.

Default: { }
Example:
{
  linear = [
    0
    0
    1
    1
  ];
}

hyprnix.settings.animations.enabled Link copied!

Type: null or boolean

enable animations

Default: null

hyprnix.settings.animations.workspace_wraparound Link copied!

Type: null or boolean

enable workspace wraparound, causing directional workspace animations to animate as if the first and last workspaces were adjacent

Default: null

hyprnix.settings.binds.allow_pin_fullscreen Link copied!

Type: null or boolean

If enabled, Allow fullscreen to pinned windows, and restore their pinned status afterwards

Default: null

hyprnix.settings.binds.allow_workspace_cycles Link copied!

Type: null or boolean

If 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.

Default: null

hyprnix.settings.binds.disable_keybind_grabbing Link copied!

Type: null or boolean

If enabled, apps that request keybinds to be disabled (e.g. VMs) will not be able to do so.

Default: null

hyprnix.settings.binds.drag_threshold Link copied!

Type: null or (unsigned integer, meaning >=0)

Movement threshold in pixels for window dragging and c/g bind flags. 0 to disable and grab on mousedown.

Default: null

hyprnix.settings.binds.focus_preferred_method Link copied!

Type: null or one of 0, 1

sets 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)

Default: null

hyprnix.settings.binds.hide_special_on_workspace_change Link copied!

Type: null or boolean

If enabled, changing the active workspace (including to itself) will hide the special workspace on the monitor where the newly active workspace resides.

Default: null

hyprnix.settings.binds.ignore_group_lock Link copied!

Type: null or boolean

If enabled, dispatchers like moveintogroup, moveoutofgroup and movewindoworgroup will ignore lock per group.

Default: null

hyprnix.settings.binds.movefocus_cycles_fullscreen Link copied!

Type: null or boolean

If enabled, when on a fullscreen window, movefocus will cycle fullscreen, if not, it will move the focus in a direction.

Default: null

hyprnix.settings.binds.movefocus_cycles_groupfirst Link copied!

Type: null or boolean

If enabled, when in a grouped window, movefocus will cycle windows in the groups first, then at each ends of tabs, it’ll move on to other windows/groups

Default: null

hyprnix.settings.binds.pass_mouse_when_bound Link copied!

Type: null or boolean

if disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered.

Default: null

hyprnix.settings.binds.scroll_event_delay Link copied!

Type: null or (unsigned integer, meaning >=0)

in ms, how many ms to wait after a scroll event to allow passing another one for the binds.

Default: null

hyprnix.settings.binds.window_direction_monitor_fallback Link copied!

Type: null or boolean

If enabled, moving a window or focus over the edge of a monitor with a direction will move it to the next monitor in that direction.

Default: null

hyprnix.settings.binds.workspace_back_and_forth Link copied!

Type: null or boolean

If 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.

Default: null

hyprnix.settings.binds.workspace_center_on Link copied!

Type: null or one of 0, 1

Whether switching workspaces should center the cursor on the workspace (0) or on the last active window for that workspace (1)

Default: null

hyprnix.settings.cursor.default_monitor Link copied!

Type: null or string

the name of a default monitor for the cursor to be set to on startup (see hyprctl monitors for names)

Default: null

hyprnix.settings.cursor.hide_on_key_press Link copied!

Type: null or boolean

Hides the cursor when you press any key until the mouse is moved.

Default: null

hyprnix.settings.cursor.hide_on_tablet Link copied!

Type: null or boolean

Hides the cursor when the last input was a tablet input until a mouse input is done.

Default: null

hyprnix.settings.cursor.hide_on_touch Link copied!

Type: null or boolean

Hides the cursor when the last input was a touch input until a mouse input is done.

Default: null

hyprnix.settings.cursor.hotspot_padding Link copied!

Type: null or (unsigned integer, meaning >=0)

the padding, in logical px, between screen edges and the cursor

Default: null

hyprnix.settings.cursor.hyprcursor.enable Link copied!

Type: null or boolean

whether to enable hyprcursor support

Default: null

hyprnix.settings.cursor.hyprcursor.name Link copied!

Type: null or string

set cursor's name. Requires Hyprland restart.

Default: null

hyprnix.settings.cursor.hyprcursor.package Link copied!

Type: null or package

set cursor's package to install

Default: null

hyprnix.settings.cursor.hyprcursor.size Link copied!

Type: null or (positive integer, meaning >0)

set cursor's size. Requires Hyprland restart.

Default: null

hyprnix.settings.cursor.inactive_timeout Link copied!

Type: null or unsigned number, meaning >=0

in seconds, after how many seconds of cursor’s inactivity to hide it. Set to 0 for never.

Default: null

hyprnix.settings.cursor.invisible Link copied!

Type: null or boolean

don't render cursors

Default: null

hyprnix.settings.cursor.min_refresh_rate Link copied!

Type: null or (unsigned integer, meaning >=0)

minimum refresh rate for cursor movement when no_break_fs_vrr = 1 Set to minimum supported refresh rate or higher

Default: null

hyprnix.settings.cursor.no_break_fs_vrr Link copied!

Type: null or integer between 0 and 2 (both inclusive)

disables scheduling new frames on cursor movement for fullscreen apps with VRR enabled to avoid framerate spikes (may require no_hardware_cursors = 1) 0 - off, 1 - on, 2 - auto (on with content type ‘game’)

Default: null

hyprnix.settings.cursor.no_hardware_cursors Link copied!

Type: null or integer between 0 and 2 (both inclusive)

disables hardware cursors. 0 - use hw cursors if possible, 1 - don’t use hw cursors, 2 - auto (disable when tearing)

Default: null

hyprnix.settings.cursor.no_warps Link copied!

Type: null or boolean

if true, will not warp the cursor in many cases (focusing, keybinds, etc)

Default: null

hyprnix.settings.cursor.persistent_warps Link copied!

Type: null or boolean

When a window is refocused, the cursor returns to its last position relative to that window, rather than to the centre.

Default: null

hyprnix.settings.cursor.sync_gsettings_theme Link copied!

Type: null or boolean

sync xcursor theme with gsettings, it applies cursor-theme and cursor-size on theme load to gsettings making most CSD gtk based clients use same xcursor theme and size.

Default: null

hyprnix.settings.cursor.use_cpu_buffer Link copied!

Type: null or integer between 0 and 2 (both inclusive)

(NVIDIA Only) Makes HW cursors use a CPU buffer. Required on NVIDIA to have HW cursors. 0 - off, 1 - on, 2 - auto

Default: null

hyprnix.settings.cursor.warp_back_after_non_mouse_input Link copied!

Type: null or boolean

Warp the cursor back to where it was after using a non-mouse input to move it, and then returning back to mouse.

Default: null

hyprnix.settings.cursor.warp_on_change_workspace Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Move the cursor to the last focused window after changing the workspace. Options: 0 (Disabled), 1 (Enabled), 2 (Force - ignores cursor.no_warps option)

Default: null

hyprnix.settings.cursor.warp_on_toggle_special Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Move the cursor to the last focused window when toggling a special workspace. Options: 0 (Disabled), 1 (Enabled), 2 (Force - ignores cursor.no_warps option)

Default: null

hyprnix.settings.cursor.zoom_detached_camera Link copied!

Type: null or boolean

detach the camera from the mouse when zoomed in, only ever moving the camera to keep the mouse in view when it goes past the screen edges

Default: null

hyprnix.settings.cursor.zoom_disable_aa Link copied!

Type: null or boolean

disable antialiasing when zooming, which means things will be pixelated instead of blurry

Default: null

hyprnix.settings.cursor.zoom_factor Link copied!

Type: null or positive number, meaning >0

the factor to zoom by around the cursor. Like a magnifying glass. Minimum 1.0 (meaning no zoom)

Default: null

hyprnix.settings.cursor.zoom_rigid Link copied!

Type: null or boolean

whether the zoom should follow the cursor rigidly (cursor is always centered if it can be) or loosely

Default: null

hyprnix.settings.debug.colored_stdout_logs Link copied!

Type: null or boolean

enables colors in the stdout logs.

Default: null

hyprnix.settings.debug.damage_tracking Link copied!

Type: null or integer between 0 and 2 (both inclusive)

redraw only the needed bits of the display. Do not change. 0 - none, 1 - monitor, 2 - full (default on Hyprland)

Default: null

hyprnix.settings.debug.disable_logs Link copied!

Type: null or boolean

disable logging to a file

Default: null

hyprnix.settings.debug.disable_scale_checks Link copied!

Type: null or boolean

disables verification of the scale factors. Will result in pixel alignment and rounding errors.

Default: null

hyprnix.settings.debug.disable_time Link copied!

Type: null or boolean

disables time logging

Default: null

hyprnix.settings.debug.enable_stdout_logs Link copied!

Type: null or boolean

enables logging to stdout

Default: null

hyprnix.settings.debug.error_limit Link copied!

Type: null or (positive integer, meaning >0)

limits the number of displayed config file parsing errors.

Default: null

hyprnix.settings.debug.error_position Link copied!

Type: null or integer between 0 and 1 (both inclusive)

sets the position of the error bar. top - 0, bottom - 1

Default: null

hyprnix.settings.debug.full_cm_proto Link copied!

Type: null or boolean

claims support for all cm proto features (requires restart)

Default: null

hyprnix.settings.debug.gl_debugging Link copied!

Type: null or boolean

enables OpenGL debugging with glGetError and EGL_KHR_debug, requires a restart after changing.

Default: null

hyprnix.settings.debug.manual_crash Link copied!

Type: null or integer between 0 and 1 (both inclusive)

set to 1 and then back to 0 to crash Hyprland.

Default: null

hyprnix.settings.debug.overlay Link copied!

Type: null or boolean

print the debug performance overlay. Disable VFR for accurate results.

Default: null

hyprnix.settings.debug.pass Link copied!

Type: null or boolean

enables render pass debugging.

Default: null

hyprnix.settings.debug.suppress_errors Link copied!

Type: null or boolean

if true, do not display config file parsing errors.

Default: null

hyprnix.settings.debug.watchdog_timeout Link copied!

Type: null or (unsigned integer, meaning >=0)

sets the timeout in seconds for watchdog to abort processing of a signal of the main thread. Set to 0 to disable.

Default: null

hyprnix.settings.decoration.active_opacity Link copied!

Type: null or number between 0 and 1 (both inclusive)

opacity of active windows

Default: null

hyprnix.settings.decoration.blur.brightness Link copied!

Type: null or number between 0 and 2 (both inclusive)

brightness modulation for blur

Default: null

hyprnix.settings.decoration.blur.contrast Link copied!

Type: null or number between 0 and 2 (both inclusive)

contrast modulation for blur

Default: null

hyprnix.settings.decoration.blur.enabled Link copied!

Type: null or boolean

enable kawase window background blur

Default: null

hyprnix.settings.decoration.blur.ignore_opacity Link copied!

Type: null or boolean

make the blur layer ignore the opacity of the window

Default: null

hyprnix.settings.decoration.blur.input_methods Link copied!

Type: null or boolean

whether to blur input methods (e.g. fcitx5)

Default: null

hyprnix.settings.decoration.blur.input_methods_ignorealpha Link copied!

Type: null or number between 0 and 1 (both inclusive)

works like ignore_alpha in layer rules. If pixel opacity is below set value, will not blur

Default: null

hyprnix.settings.decoration.blur.new_optimizations Link copied!

Type: null or boolean

whether to enable further optimizations to the blur. Recommended to leave on, as it will massively improve performance.

Default: null

hyprnix.settings.decoration.blur.noise Link copied!

Type: null or number between 0 and 1 (both inclusive)

how much noise to apply

Default: null

hyprnix.settings.decoration.blur.passes Link copied!

Type: null or (positive integer, meaning >0)

the amount of passes to perform

Default: null

hyprnix.settings.decoration.blur.popups Link copied!

Type: null or boolean

whether to blur popups (e.g. right-click menus)

Default: null

hyprnix.settings.decoration.blur.popups_ignorealpha Link copied!

Type: null or number between 0 and 1 (both inclusive)

works like ignore_alpha in layer rules. If pixel opacity is below set value, will not blur

Default: null

hyprnix.settings.decoration.blur.size Link copied!

Type: null or (positive integer, meaning >0)

blur size (distance)

Default: null

hyprnix.settings.decoration.blur.special Link copied!

Type: null or boolean

whether to blur behind the special workspace (note: expensive)

Default: null

hyprnix.settings.decoration.blur.vibrancy Link copied!

Type: null or number between 0 and 1 (both inclusive)

Increase saturation of blurred colors

Default: null

hyprnix.settings.decoration.blur.vibrancy_darkness Link copied!

Type: null or number between 0 and 1 (both inclusive)

How strong the effect of vibrancy is on dark areas

Default: null

hyprnix.settings.decoration.blur.xray Link copied!

Type: null or boolean

if enabled, floating windows will ignore tiled windows in their blur. Only available if new_optimizations is true. Will reduce overhead on floating blur significantly.

Default: null

hyprnix.settings.decoration.border_part_of_window Link copied!

Type: null or boolean

whether the window border should be a part of the window

Default: null

hyprnix.settings.decoration.dim_around Link copied!

Type: null or number between 0 and 1 (both inclusive)

how much the dim_around window rule should dim by

Default: null

hyprnix.settings.decoration.dim_inactive Link copied!

Type: null or boolean

enables dimming of inactive windows

Default: null

hyprnix.settings.decoration.dim_modal Link copied!

Type: null or boolean

enables dimming of parents of modal windows

Default: null

hyprnix.settings.decoration.dim_special Link copied!

Type: null or number between 0 and 1 (both inclusive)

how much to dim the rest of the screen by when a special workspace is open

Default: null

hyprnix.settings.decoration.dim_strength Link copied!

Type: null or number between 0 and 1 (both inclusive)

how much inactive windows should be dimmed

Default: null

hyprnix.settings.decoration.fullscreen_opacity Link copied!

Type: null or number between 0 and 1 (both inclusive)

opacity of fullscreen windows

Default: null

hyprnix.settings.decoration.glow.color Link copied!

Type: null or string

glow’s color. Alpha dictates glow’s opacity.

Default: null

hyprnix.settings.decoration.glow.color_inactive Link copied!

Type: null or string

inactive glow color. (if not set, will fall back to color)

Default: null

hyprnix.settings.decoration.glow.enabled Link copied!

Type: null or boolean

enable inner glow on windows

Default: null

hyprnix.settings.decoration.glow.range Link copied!

Type: null or (positive integer, meaning >0)

Glow range ("size") in layout px

Default: null

hyprnix.settings.decoration.glow.render_power Link copied!

Type: null or integer between 1 and 4 (both inclusive)

in what power to render the falloff (more power, the faster the falloff)

Default: null

hyprnix.settings.decoration.inactive_opacity Link copied!

Type: null or number between 0 and 1 (both inclusive)

opacity of inactive windows

Default: null

hyprnix.settings.decoration.rounding Link copied!

Type: null or (unsigned integer, meaning >=0)

rounded corners’ radius (in layout px)

Default: null

hyprnix.settings.decoration.rounding_power Link copied!

Type: null or number between 1 and 10 (both inclusive)

adjusts the curve used for rounding corners, larger is smoother, 2.0 is a circle, 4.0 is a squircle, 1.0 is a triangular corner

Default: null

hyprnix.settings.decoration.screen_shader Link copied!

Type: null or string or absolute path

a path to a custom shader to be applied at the end of rendering. See examples/screenShader.frag for an example.

Default: null

hyprnix.settings.decoration.shadow.color Link copied!

Type: null or string

shadow’s color. Alpha dictates shadow’s opacity.

Default: null

hyprnix.settings.decoration.shadow.color_inactive Link copied!

Type: null or string

inactive shadow color. (if not set, will fall back to color)

Default: null

hyprnix.settings.decoration.shadow.enabled Link copied!

Type: null or boolean

enable drop shadows on windows

Default: null

hyprnix.settings.decoration.shadow.ignore_window Link copied!

Type: null or boolean

if true, the shadow will not be rendered behind the window itself, only around it.

Default: null

hyprnix.settings.decoration.shadow.offset Link copied!

Type: null or (list with 2 number values)

shadow’s rendering offset.

Default: null

hyprnix.settings.decoration.shadow.range Link copied!

Type: null or (positive integer, meaning >0)

Shadow range ("size") in layout px

Default: null

hyprnix.settings.decoration.shadow.render_power Link copied!

Type: null or integer between 1 and 4 (both inclusive)

in what power to render the falloff (more power, the faster the falloff)

Default: null

hyprnix.settings.decoration.shadow.scale Link copied!

Type: null or number between 0 and 1 (both inclusive)

shadow's scale

Default: null

hyprnix.settings.decoration.shadow.sharp Link copied!

Type: null or boolean

if enabled, will make the shadows sharp, akin to an infinite render power

Default: null

hyprnix.settings.dwindle.default_split_ratio Link copied!

Type: null or number between 0.100000 and 1.900000 (both inclusive)

The default split ratio on window open. 1 means even 50/50 split.

Default: null

hyprnix.settings.dwindle.force_split Link copied!

Type: null or integer between 0 and 2 (both inclusive)

0 -> split follows mouse 1 -> always split to the left (new = left or top) 2 -> always split to the right (new = right or bottom)

Default: null

hyprnix.settings.dwindle.permanent_direction_override Link copied!

Type: null or boolean

If enabled, makes the preselect direction persist until either this mode is turned off, another direction is specified, or a non-direction is specified (anything other than l,r,u/t,d/b)

Default: null

hyprnix.settings.dwindle.precise_mouse_move Link copied!

Type: null or boolean

If enabled bindm movewindow will drop the window more precisely depending on where your mouse is.

Default: null

hyprnix.settings.dwindle.preserve_split Link copied!

Type: null or boolean

If enabled, the split (side/top) will not change regardless of what happens to the container.

Default: null

hyprnix.settings.dwindle.pseudotile Link copied!

Type: null or boolean

Pseudotiled windows retain their floating size when tiled.

Default: null

hyprnix.settings.dwindle.smart_resizing Link copied!

Type: null or boolean

If enabled, resizing direction will be determined by the mouse’s position on the window (nearest to which corner). Else, it is based on the window’s tiling position.

Default: null

hyprnix.settings.dwindle.smart_split Link copied!

Type: null or boolean

If enabled, allows a more precise control over the window split direction based on the cursor’s position. The window is conceptually divided into four triangles, and cursor’s triangle determines the split direction. This feature also turns on preserve_split.

Default: null

hyprnix.settings.dwindle.special_scale_factor Link copied!

Type: null or number between 0 and 1 (both inclusive)

Specifies the scale factor of windows on the special workspace

Default: null

hyprnix.settings.dwindle.split_bias Link copied!

Type: null or one of 0, 1

Specifies which window will receive the split ratio. 0 -> directional (the top or left window) 1 -> the current window

Default: null

hyprnix.settings.dwindle.split_width_multiplier Link copied!

Type: null or signed integer or floating point number

Specifies the auto-split width multiplier. Multiplying window size is useful on widescreen monitors where window W > H even after several splits.

Default: null

hyprnix.settings.dwindle.use_active_for_splits Link copied!

Type: null or boolean

Prefer the active window or the mouse position for splits

Default: null

hyprnix.settings.ecosystem.enforce_permissions Link copied!

Type: null or boolean

whether to enable permission control.

Default: null

hyprnix.settings.ecosystem.no_donation_nag Link copied!

Type: null or boolean

disable the popup that shows up twice a year encouraging to donate.

Default: null

hyprnix.settings.ecosystem.no_update_news Link copied!

Type: null or boolean

disable the popup that shows up when you update hyprland to a new version.

Default: null

hyprnix.settings.env Link copied!

Type: null or (attribute set of (string or signed integer or floating point number))

Environment variables to set, as name-value pairs.

Default: null
Example:
{
  HYPRLAND_TRACE = 1;
  QT_QPA_PLATFORM = "wayland;xcb";
  XDG_CURRENT_DESKTOP = "Hyprland";
}

hyprnix.settings.exec Link copied!

Type: list of string

Shell scripts that will execute on each reload

Default: [ ]

hyprnix.settings.exec-once Link copied!

Type: list of string

Shell scripts that will execute only on launch

Default: [ ]

hyprnix.settings.exec-shutdown Link copied!

Type: list of string

Shell scripts that will execute only on shutdown

Default: [ ]

hyprnix.settings.execr Link copied!

Type: list of string

Raw shell scripts that will execute on each reload

Default: [ ]

hyprnix.settings.execr-once Link copied!

Type: list of string

Raw shell scripts that will execute only on launch

Default: [ ]

hyprnix.settings.general.allow_tearing Link copied!

Type: null or boolean

master switch for allowing tearing to occur. See the Tearing page.

Default: null

hyprnix.settings.general.border_size Link copied!

Type: null or (positive integer, meaning >0)

size of the border around windows

Default: null

hyprnix.settings.general.col.active_border Link copied!

Type: null or string

border color for the active window

Default: null

hyprnix.settings.general.col.inactive_border Link copied!

Type: null or string

border color for inactive windows

Default: null

hyprnix.settings.general.col.nogroup_border Link copied!

Type: null or string

inactive border color for window that cannot be added to a group (see denywindowfromgroup dispatcher)

Default: null

hyprnix.settings.general.col.nogroup_border_active Link copied!

Type: null or string

active border color for window that cannot be added to a group

Default: null

hyprnix.settings.general.extend_border_grab_area Link copied!

Type: null or (positive integer, meaning >0)

extends the area around the border where you can click and drag on, only used when general:resize_on_border is on.

Default: null

hyprnix.settings.general.float_gaps Link copied!

Type: null or signed integer

gaps between windows and monitor edges for floating windows, also supports css style gaps (top, right, bottom, left -> 5 10 15 20). -1 means default

Default: null

hyprnix.settings.general.gaps_in Link copied!

Type: null or (unsigned integer, meaning >=0)

gaps between windows, also supports css style gaps (top, right, bottom, left -> 5,10,15,20)

Default: null

hyprnix.settings.general.gaps_out Link copied!

Type: null or (unsigned integer, meaning >=0)

gaps between windows and monitor edges, also supports css style gaps (top, right, bottom, left -> 5,10,15,20)

Default: null

hyprnix.settings.general.gaps_workspaces Link copied!

Type: null or (unsigned integer, meaning >=0)

gaps between workspaces. Stacks with gaps_out.

Default: null

hyprnix.settings.general.hover_icon_on_border Link copied!

Type: null or boolean

show a cursor icon when hovering over borders, only used when general:resize_on_border is on.

Default: null

hyprnix.settings.general.layout Link copied!

Type: null or one of "dwindle", "master", "scrolling", "monocle"

which layout to use

Default: null

hyprnix.settings.general.locale Link copied!

Type: null or string

overrides the system locale (e.g. en_US, es)

Default: null

hyprnix.settings.general.modal_parent_blocking Link copied!

Type: null or boolean

whether parent windows of modals will be interactive

Default: null

hyprnix.settings.general.no_focus_fallback Link copied!

Type: null or boolean

if true, will not fall back to the next available window when moving focus in a direction where no window was found

Default: null

hyprnix.settings.general.resize_corner Link copied!

Type: null or integer between 0 and 4 (both inclusive)

force floating windows to use a specific corner when being resized (1-4 going clockwise from top left, 0 to disable)

Default: null

hyprnix.settings.general.resize_on_border Link copied!

Type: null or boolean

enables resizing windows by clicking and dragging on borders and gaps

Default: null

hyprnix.settings.general.snap.border_overlap Link copied!

Type: null or boolean

if true, windows snap such that only one border’s worth of space is between them

Default: null

hyprnix.settings.general.snap.enabled Link copied!

Type: null or boolean

enable snapping for floating windows

Default: null

hyprnix.settings.general.snap.monitor_gap Link copied!

Type: null or (unsigned integer, meaning >=0)

minimum gap in pixels between window and monitor edges before snapping

Default: null

hyprnix.settings.general.snap.respect_gaps Link copied!

Type: null or boolean

if true, snapping will respect gaps between windows(set in general:gaps_in)

Default: null

hyprnix.settings.general.snap.window_gap Link copied!

Type: null or (unsigned integer, meaning >=0)

minimum gap in pixels between windows before snapping

Default: null

hyprnix.settings.gesture.close_max_timeout Link copied!

Type: null or (unsigned integer, meaning >=0)

the timeout for a window to close when using a 1:1 gesture, in ms

Default: null

hyprnix.settings.gesture.gestures Link copied!

Type: null or (list of (string or (submodule)))

list of gestures

Default: [ ]
Example:
[
  {
    action = "close";
    direction = "pinchOut";
    fingers = 2;
  }
  "3, up, mod: SUPER, scale: 1.5, fullscreen"
]

hyprnix.settings.gesture.workspace_swipe_cancel_ratio Link copied!

Type: null or number between 0 and 1 (both inclusive)

how much the swipe has to proceed in order to commence it. (0.7 -> if > 0.7 * distance, switch, if less, revert)

Default: null

hyprnix.settings.gesture.workspace_swipe_create_new Link copied!

Type: null or boolean

whether a swipe right on the last workspace should create a new one.

Default: null

hyprnix.settings.gesture.workspace_swipe_direction_lock Link copied!

Type: null or boolean

if enabled, switching direction will be locked when you swipe past the direction_lock_threshold (touchpad only).

Default: null

hyprnix.settings.gesture.workspace_swipe_direction_lock_threshold Link copied!

Type: null or (unsigned integer, meaning >=0)

in px, the distance to swipe before direction lock activates (touchpad only).

Default: null

hyprnix.settings.gesture.workspace_swipe_distance Link copied!

Type: null or (unsigned integer, meaning >=0)

in px, the distance of the touchpad gesture

Default: null

hyprnix.settings.gesture.workspace_swipe_forever Link copied!

Type: null or boolean

if enabled, swiping will not clamp at the neighboring workspaces but continue to the further ones.

Default: null

hyprnix.settings.gesture.workspace_swipe_invert Link copied!

Type: null or boolean

invert the direction (touchpad only)

Default: null

hyprnix.settings.gesture.workspace_swipe_min_speed_to_force Link copied!

Type: null or (unsigned integer, meaning >=0)

minimum speed in px per timepoint to force the change ignoring cancel_ratio. Setting to 0 will disable this mechanic.

Default: null

hyprnix.settings.gesture.workspace_swipe_touch Link copied!

Type: null or boolean

enable workspace swiping from the edge of a touchscreen

Default: null

hyprnix.settings.gesture.workspace_swipe_touch_invert Link copied!

Type: null or boolean

invert the direction (touchscreen only)

Default: null

hyprnix.settings.gesture.workspace_swipe_use_r Link copied!

Type: null or boolean

if enabled, swiping will use the r prefix instead of the m prefix for finding workspaces.

Default: null

hyprnix.settings.group.auto_group Link copied!

Type: null or boolean

whether new windows will be automatically grouped into the focused unlocked group. Note: if you want to disable auto_group only for specific windows, use the "group barred" window rule instead.

Default: null

hyprnix.settings.group.col.border_active Link copied!

Type: null or string

active group border color

Default: null

hyprnix.settings.group.col.border_inactive Link copied!

Type: null or string

inactive (out of focus) group border color

Default: null

hyprnix.settings.group.col.border_locked_active Link copied!

Type: null or string

active locked group border color

Default: null

hyprnix.settings.group.col.border_locked_inactive Link copied!

Type: null or string

inactive locked group border color

Default: null

hyprnix.settings.group.drag_into_group Link copied!

Type: null or integer between 0 and 2 (both inclusive)

whether dragging a window into a unlocked group will merge them. 0 -> disabled. 1 -> enabled. 2 -> only when dragging into the groupbar.

Default: null

hyprnix.settings.group.focus_removed_window Link copied!

Type: null or boolean

whether Hyprland should focus on the window that has just been moved out of the group

Default: null

hyprnix.settings.group.group_on_movetoworkspace Link copied!

Type: null or boolean

whether using movetoworkspace[silent] will merge the window into the workspace’s solitary unlocked group

Default: null

hyprnix.settings.group.groupbar.blur Link copied!

Type: null or boolean

applies blur to the groupbar indicators and gradients

Default: null

hyprnix.settings.group.groupbar.col.active Link copied!

Type: null or string

active group bar background color

Default: null

hyprnix.settings.group.groupbar.col.inactive Link copied!

Type: null or string

inactive (out of focus) group bar background color

Default: null

hyprnix.settings.group.groupbar.col.locked_active Link copied!

Type: null or string

active locked group bar background color

Default: null

hyprnix.settings.group.groupbar.col.locked_inactive Link copied!

Type: null or string

inactive locked group bar background color

Default: null

hyprnix.settings.group.groupbar.enabled Link copied!

Type: null or boolean

enables groupbars

Default: null

hyprnix.settings.group.groupbar.font_family Link copied!

Type: null or string

font used to display groupbar titles, use misc:font_family if not specified

Default: null

hyprnix.settings.group.groupbar.font_size Link copied!

Type: null or (positive integer, meaning >0)

font size of groupbar title

Default: null

hyprnix.settings.group.groupbar.font_weight_active Link copied!

Type: null or integer between 100 and 1000 (both inclusive) or one of "thin", "ultralight", "light", "semilight", "book", "normal", "medium", "semibold", "bold", "ultrabold", "heavy", "ultraheavy"

font weight of active groupbar title

Default: null

hyprnix.settings.group.groupbar.font_weight_inactive Link copied!

Type: null or integer between 100 and 1000 (both inclusive) or one of "thin", "ultralight", "light", "semilight", "book", "normal", "medium", "semibold", "bold", "ultrabold", "heavy", "ultraheavy"

font weight of inactive groupbar title

Default: null

hyprnix.settings.group.groupbar.gaps_in Link copied!

Type: null or (unsigned integer, meaning >=0)

gap size between gradients

Default: null

hyprnix.settings.group.groupbar.gaps_out Link copied!

Type: null or (unsigned integer, meaning >=0)

gap size between gradients and window

Default: null

hyprnix.settings.group.groupbar.gradient_round_only_edges Link copied!

Type: null or boolean

round only the gradient edges of the entire groupbar

Default: null

hyprnix.settings.group.groupbar.gradient_rounding Link copied!

Type: null or (unsigned integer, meaning >=0)

how much to round the gradients

Default: null

hyprnix.settings.group.groupbar.gradient_rounding_power Link copied!

Type: null or number between 1 and 10 (both inclusive)

adjusts the curve used for rounding gradient corners, larger is smoother, 2.0 is a circle, 4.0 is a squircle, 1.0 is a triangular corner

Default: null

hyprnix.settings.group.groupbar.gradients Link copied!

Type: null or boolean

enables gradients

Default: null

hyprnix.settings.group.groupbar.height Link copied!

Type: null or (positive integer, meaning >0)

height of the groupbar

Default: null

hyprnix.settings.group.groupbar.indicator_gap Link copied!

Type: null or (unsigned integer, meaning >=0)

height of gap between groupbar indicator and title

Default: null

hyprnix.settings.group.groupbar.indicator_height Link copied!

Type: null or (positive integer, meaning >0)

height of the groupbar indicator

Default: null

hyprnix.settings.group.groupbar.keep_upper_gap Link copied!

Type: null or boolean

add or remove upper gap

Default: null

hyprnix.settings.group.groupbar.priority Link copied!

Type: null or signed integer

sets the decoration priority for groupbars

Default: null

hyprnix.settings.group.groupbar.render_titles Link copied!

Type: null or boolean

whether to render titles in the group bar decoration

Default: null

hyprnix.settings.group.groupbar.round_only_edges Link copied!

Type: null or boolean

round only the indicator edges of the entire groupbar

Default: null

hyprnix.settings.group.groupbar.rounding Link copied!

Type: null or (unsigned integer, meaning >=0)

how much to round the indicator

Default: null

hyprnix.settings.group.groupbar.rounding_power Link copied!

Type: null or number between 1 and 10 (both inclusive)

adjusts the curve used for rounding groupbar corners, larger is smoother, 2.0 is a circle, 4.0 is a squircle, 1.0 is a triangular corner

Default: null

hyprnix.settings.group.groupbar.scrolling Link copied!

Type: null or boolean

whether scrolling in the groupbar changes group active window

Default: null

hyprnix.settings.group.groupbar.stacked Link copied!

Type: null or boolean

render the groupbar as a vertical stack

Default: null

hyprnix.settings.group.groupbar.text_color Link copied!

Type: null or string

color for window titles in the groupbar

Default: null

hyprnix.settings.group.groupbar.text_color_inactive Link copied!

Type: null or string

color for inactive windows’ titles in the groupbar (if unset, defaults to text_color)

Default: null

hyprnix.settings.group.groupbar.text_color_locked_active Link copied!

Type: null or string

color for the active window’s title in a locked group (if unset, defaults to text_color)

Default: null

hyprnix.settings.group.groupbar.text_color_locked_inactive Link copied!

Type: null or string

color for inactive windows’ titles in locked groups (if unset, defaults to text_color_inactive)

Default: null

hyprnix.settings.group.groupbar.text_offset Link copied!

Type: null or signed integer

adjust vertical position for titles

Default: null

hyprnix.settings.group.groupbar.text_padding Link copied!

Type: null or (unsigned integer, meaning >=0)

set horizontal padding for titles

Default: null

hyprnix.settings.group.insert_after_current Link copied!

Type: null or boolean

whether new windows in a group spawn after current or at group tail

Default: null

hyprnix.settings.group.merge_floated_into_tiled_on_groupbar Link copied!

Type: null or boolean

whether dragging a floating window into a tiled window groupbar will merge them

Default: null

hyprnix.settings.group.merge_groups_on_drag Link copied!

Type: null or boolean

whether window groups can be dragged into other groups

Default: null

hyprnix.settings.group.merge_groups_on_groupbar Link copied!

Type: null or boolean

whether one group will be merged with another when dragged into its groupbar

Default: null

hyprnix.settings.input.accel_profile Link copied!

Type: null or one of "adaptive", "flat", "custom"

Sets the cursor acceleration profile. Leave empty to use libinput’s default mode for your input device.

Default: null

hyprnix.settings.input.emulate_discrete_scroll Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Emulates discrete scrolling from high resolution scrolling events. 0 disables it. 1 enables handling of non-standard events only. 2 force enables all scroll wheel events to be handled.

Default: null

hyprnix.settings.input.float_switch_override_focus Link copied!

Type: null or integer between 1 and 2 (both inclusive)

If enabled, 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.

Default: null

hyprnix.settings.input.focus_on_close Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Controls the window focus behavior when a window is closed. When set to 0, focus will shift to the next window candidate. When set to 1, focus will shift to the window under the cursor. When set to 2, focus will shift to the most recently used/active window.

Default: null

hyprnix.settings.input.follow_mouse Link copied!

Type: null or integer between 0 and 3 (both inclusive)

Specify if and how cursor movement should affect window focus. 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.

Default: null

hyprnix.settings.input.follow_mouse_threshold Link copied!

Type: null or unsigned number, meaning >=0

The smallest distance in logical pixels the mouse needs to travel for the window under it to get focused. Works only with follow_mouse = 1.

Default: null

hyprnix.settings.input.force_no_accel Link copied!

Type: null or boolean

Force 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.

Default: null

hyprnix.settings.input.kb_file Link copied!

Type: null or string or absolute path

If you prefer, you can use a path to your custom .xkb file.

Default: null

hyprnix.settings.input.kb_layout Link copied!

Type: null or string

Appropriate XKB keymap parameter

Default: null

hyprnix.settings.input.kb_model Link copied!

Type: null or string

Appropriate XKB keymap parameter

Default: null

hyprnix.settings.input.kb_options Link copied!

Type: null or string

Appropriate XKB keymap parameter

Default: null

hyprnix.settings.input.kb_rules Link copied!

Type: null or string

Appropriate XKB keymap parameter

Default: null

hyprnix.settings.input.kb_variant Link copied!

Type: null or string

Appropriate XKB keymap parameter

Default: null

hyprnix.settings.input.left_handed Link copied!

Type: null or boolean

Switches RMB and LMB

Default: null

hyprnix.settings.input.mouse_refocus Link copied!

Type: null or boolean

If disabled, mouse focus won’t switch to the hovered window unless the mouse crosses a window boundary when follow_mouse=1.

Default: null

hyprnix.settings.input.natural_scroll Link copied!

Type: null or boolean

Inverts scrolling direction. When enabled, scrolling moves content directly, rather than manipulating a scrollbar.

Default: null

hyprnix.settings.input.numlock_by_default Link copied!

Type: null or boolean

Engage numlock by default.

Default: null

hyprnix.settings.input.off_window_axis_events Link copied!

Type: null or integer between 0 and 3 (both inclusive)

Handles 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 window.

Default: null

hyprnix.settings.input.repeat_delay Link copied!

Type: null or (unsigned integer, meaning >=0)

Delay before a held-down key is repeated, in milliseconds.

Default: null

hyprnix.settings.input.repeat_rate Link copied!

Type: null or (positive integer, meaning >0)

The repeat rate for held-down keys, in repeats per second.

Default: null

hyprnix.settings.input.resolve_binds_by_sym Link copied!

Type: null or boolean

Determines 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.

Default: null

hyprnix.settings.input.rotation Link copied!

Type: null or integer between 0 and 359 (both inclusive)

Sets the rotation of a device in degrees clockwise off the logical neutral position.

Default: null

hyprnix.settings.input.scroll_button Link copied!

Type: null or (unsigned integer, meaning >=0)

Sets the scroll button. Check wev if you have any doubts regarding the ID. 0 means default.

Default: null

hyprnix.settings.input.scroll_button_lock Link copied!

Type: null or boolean

If 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.

Default: null

hyprnix.settings.input.scroll_factor Link copied!

Type: null or signed integer or floating point number

Multiplier added to scroll movement for external mice. Note that there is a separate setting for touchpad scroll_factor.

Default: null

hyprnix.settings.input.scroll_method Link copied!

Type: null or one of "2fg", "edge", "on_button_down", "no_scroll"

Sets the scroll method.

Default: null

hyprnix.settings.input.scroll_points Link copied!

Type: null or string

Sets 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.

Default: null

hyprnix.settings.input.sensitivity Link copied!

Type: null or number between -1 and 1 (both inclusive)

Sets the mouse input sensitivity.

Default: null

hyprnix.settings.input.special_fallthrough Link copied!

Type: null or boolean

if enabled, having only floating windows in the special workspace will not block focusing windows in the regular workspace.

Default: null

hyprnix.settings.input.tablet.absolute_region_position Link copied!

Type: null or boolean

whether to treat the region_position as an absolute position in monitor layout. Only applies when output is empty.

Default: null

hyprnix.settings.input.tablet.active_area_position Link copied!

Type: null or (list with 2 number values)

position of the active area in mm

Default: null

hyprnix.settings.input.tablet.active_area_size Link copied!

Type: null or (list with 2 number values)

size of tablet’s active area in mm

Default: null

hyprnix.settings.input.tablet.left_handed Link copied!

Type: null or boolean

if enabled, the tablet will be rotated 180 degrees

Default: null

hyprnix.settings.input.tablet.output Link copied!

Type: null or string

the monitor to bind tablets. Can be current or a monitor name. Leave empty to map across all monitors.

Default: null

hyprnix.settings.input.tablet.region_position Link copied!

Type: null or (list with 2 number values)

position of the mapped region in monitor layout relative to the top left corner of the bound monitor or all monitors.

Default: null

hyprnix.settings.input.tablet.region_size Link copied!

Type: null or (list with 2 number values)

size of the mapped region. When this variable is set, tablet input will be mapped to the region. [0, 0] or invalid size means unset.

Default: null

hyprnix.settings.input.tablet.relative_input Link copied!

Type: null or boolean

whether the input should be relative

Default: null

hyprnix.settings.input.tablet.transform Link copied!

Type: null or integer between -1 and 7 (both inclusive)

transform the input from tablets. The possible transformations are the same as those of the monitors. -1 means it’s unset.

Default: null

hyprnix.settings.input.touchdevice.enabled Link copied!

Type: null or boolean

Whether input is enabled for touch devices.

Default: null

hyprnix.settings.input.touchdevice.output Link copied!

Type: null or string

The monitor to bind touch devices. The default is auto-detection. To stop auto-detection, use an empty string or the “[[Empty]]” value.

Default: null

hyprnix.settings.input.touchdevice.transform Link copied!

Type: null or integer between -1 and 7 (both inclusive)

Transform the input from touchdevices. The possible transformations are the same as those of the monitors. -1 means it’s unset.

Default: null

hyprnix.settings.input.touchpad.clickfinger_behavior Link copied!

Type: null or boolean

Button 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.

Default: null

hyprnix.settings.input.touchpad.disable_while_typing Link copied!

Type: null or boolean

Disable the touchpad while typing.

Default: null

hyprnix.settings.input.touchpad.drag_3fd Link copied!

Type: null or integer between 0 and 2 (both inclusive)

enables three finger drag. 0 -> disabled. 1 -> 3 fingers. 2 -> 4 fingers.

Default: null

hyprnix.settings.input.touchpad.drag_lock Link copied!

Type: null or integer between 0 and 2 (both inclusive)

When enabled, lifting the finger off while dragging will not drop the dragged item. 0 -> disabled. 1 -> enabled with timeout. 2 -> enabled sticky.

Default: null

hyprnix.settings.input.touchpad.flip_x Link copied!

Type: null or boolean

inverts the horizontal movement of the touchpad

Default: null

hyprnix.settings.input.touchpad.flip_y Link copied!

Type: null or boolean

inverts the vertical movement of the touchpad

Default: null

hyprnix.settings.input.touchpad.middle_button_emulation Link copied!

Type: null or boolean

Sending 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.

Default: null

hyprnix.settings.input.touchpad.natural_scroll Link copied!

Type: null or boolean

Inverts scrolling direction. When enabled, scrolling moves content directly, rather than manipulating a scrollbar.

Default: null

hyprnix.settings.input.touchpad.scroll_factor Link copied!

Type: null or signed integer or floating point number

Multiplier applied to the amount of scroll movement.

Default: null

hyprnix.settings.input.touchpad.tap-and-drag Link copied!

Type: null or boolean

Sets the tap and drag mode for the touchpad

Default: null

hyprnix.settings.input.touchpad.tap-to-click Link copied!

Type: null or boolean

Tapping on the touchpad with 1, 2, or 3 fingers will send LMB, RMB, and MMB respectively.

Default: null

hyprnix.settings.input.touchpad.tap_button_map Link copied!

Type: null or one of "lrm", "lmr"

Sets the tap button mapping for touchpad button emulation. Can be one of lrm (default) or lmr (Left, Middle, Right Buttons)

Default: null

hyprnix.settings.input.virtualkeyboard.release_pressed_on_close Link copied!

Type: null or boolean

Release all pressed keys by virtual keyboard on close.

Default: null

hyprnix.settings.input.virtualkeyboard.share_states Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Unify key down states and modifier states with other keyboards. 0 -> no. 1 -> yes. 2 -> yes unless IME client.

Default: null

hyprnix.settings.keybinds Link copied!

Type: attribute set of (attribute set)

This option has no description.

Default: { }
Example:
{
  bind = {
    "SUPER, Q" = "exit";
  };
  bindel = {
    XF86AudioRaiseVolume = "exec, pamixer -i 5";
  };
}

hyprnix.settings.layout.single_window_aspect_ratio Link copied!

Type: null or (list with 2 int values)

whenever only a single window is shown on a screen, add padding so that it conforms to the specified aspect ratio. A value like 4 3 on a 16:9 screen will make it a 4:3 window in the middle with padding to the sides.

Default: null

hyprnix.settings.layout.single_window_aspect_ratio_tolerance Link copied!

Type: null or number between 0 and 1 (both inclusive)

sets a tolerance for single_window_aspect_ratio, so that if the padding that would have been added is smaller than the specified fraction of the height or width of the screen, it will not attempt to adjust the window size

Default: null

hyprnix.settings.master.allow_small_split Link copied!

Type: null or boolean

enable adding additional master windows in a horizontal split style

Default: null

hyprnix.settings.master.always_keep_position Link copied!

Type: null or boolean

whether to keep the master window in its configured position when there are no slave windows

Default: null

hyprnix.settings.master.center_master_fallback Link copied!

Type: null or one of "left", "right", "top", "bottom"

Set fallback for center master when slaves are less than slave_count_for_center_master

Default: null

hyprnix.settings.master.drop_at_cursor Link copied!

Type: null or boolean

when enabled, dragging and dropping windows will put them at the cursor position. Otherwise, when dropped at the stack side, they will go to the top/bottom of the stack depending on new_on_top.

Default: null

hyprnix.settings.master.mfact Link copied!

Type: null or number between 0 and 1 (both inclusive)

the size as a percentage of the master window, for example mfact = 0.70 would mean 70% of the screen will be the master window, and 30% the slave

Default: null

hyprnix.settings.master.new_on_active Link copied!

Type: null or one of "before", "after", "none"

before, after: place new window relative to the focused window; none: place new window according to the value of new_on_top.

Default: null

hyprnix.settings.master.new_on_top Link copied!

Type: null or boolean

whether a newly open window should be on the top of the stack

Default: null

hyprnix.settings.master.new_status Link copied!

Type: null or one of "master", "slave", "inherit"

master: new window becomes master; slave: new windows are added to slave stack; inherit: inherit from focused window

Default: null

hyprnix.settings.master.orientation Link copied!

Type: null or one of "left", "right", "top", "bottom", "center"

default placement of the master area

Default: null

hyprnix.settings.master.slave_count_for_center_master Link copied!

Type: null or (unsigned integer, meaning >=0)

when using orientation=center, make the master window centered only when at least this many slave windows are open. Set 0 to always center master.

Default: null

hyprnix.settings.master.smart_resizing Link copied!

Type: null or boolean

if enabled, resizing direction will be determined by the mouse’s position on the window (nearest to which corner). Else, it is based on the window’s tiling position.

Default: null

hyprnix.settings.master.special_scale_factor Link copied!

Type: null or number between 0 and 1 (both inclusive)

the scale of the special workspace windows.

Default: null

hyprnix.settings.misc.allow_session_lock_restore Link copied!

Type: null or boolean

if true, will allow you to restart a lockscreen app in case it crashes

Default: null

hyprnix.settings.misc.always_follow_on_dnd Link copied!

Type: null or boolean

Will make mouse focus follow the mouse when drag and dropping. Recommended to leave it enabled, especially for people using focus follows mouse at 0.

Default: null

hyprnix.settings.misc.animate_manual_resizes Link copied!

Type: null or boolean

If true, will animate manual window resizes/moves

Default: null

hyprnix.settings.misc.animate_mouse_windowdragging Link copied!

Type: null or boolean

If true, will animate windows being dragged by mouse, note that this can cause weird behavior on some curves

Default: null

hyprnix.settings.misc.anr_missed_pings Link copied!

Type: null or (positive integer, meaning >0)

number of missed pings before showing the ANR dialog

Default: null

hyprnix.settings.misc.background_color Link copied!

Type: null or string

change the background color. (requires enabled disable_hyprland_logo)

Default: null

hyprnix.settings.misc.close_special_on_empty Link copied!

Type: null or boolean

close the special workspace if the last window is removed

Default: null

hyprnix.settings.misc.col.splash Link copied!

Type: null or string

Changes the color of the splash text (requires a monitor reload to take effect).

Default: null

hyprnix.settings.misc.disable_autoreload Link copied!

Type: null or boolean

If true, the config will not reload automatically on save, and instead needs to be reloaded with hyprctl reload. Might save on battery.

Default: null

hyprnix.settings.misc.disable_hyprland_qtutils_check Link copied!

Type: null or boolean

disable the warning if hyprland-qtutils is not installed

Default: null

hyprnix.settings.misc.disable_scale_notification Link copied!

Type: null or boolean

disables notification popup when a monitor fails to set a suitable scale

Default: null

hyprnix.settings.misc.disable_splash_rendering Link copied!

Type: null or boolean

disables the Hyprland splash rendering. (requires a monitor reload to take effect)

Default: null

hyprnix.settings.misc.disable_watchdog_warning Link copied!

Type: null or boolean

whether to disable the warning about not using start-hyprland

Default: null

hyprnix.settings.misc.disable_xdg_env_checks Link copied!

Type: null or boolean

disable the warning if XDG environment is externally managed

Default: null

hyprnix.settings.misc.enable_anr_dialog Link copied!

Type: null or boolean

whether to enable the ANR (app not responding) dialog when your apps hang

Default: null

hyprnix.settings.misc.enable_swallow Link copied!

Type: null or boolean

Enable window swallowing

Default: null

hyprnix.settings.misc.exit_window_retains_fullscreen Link copied!

Type: null or boolean

if true, closing a fullscreen window makes the next focused window fullscreen

Default: null

hyprnix.settings.misc.focus_on_activate Link copied!

Type: null or boolean

Whether Hyprland should focus an app that requests to be focused (an activate request)

Default: null

hyprnix.settings.misc.font_family Link copied!

Type: null or string

Set the global default font to render the text including debug fps/notification, config error messages and etc., selected from system fonts.

Default: null

hyprnix.settings.misc.force_default_wallpaper Link copied!

Type: null or integer between -1 and 2 (both inclusive)

Enforce any of the 3 default wallpapers. Setting this to 0 or 1 disables the anime background. -1 means “random”.

Default: null

hyprnix.settings.misc.initial_workspace_tracking Link copied!

Type: null or integer between 0 and 2 (both inclusive)

if enabled, windows will open on the workspace they were invoked on. 0 - disabled, 1 - single-shot, 2 - persistent (all children too)

Default: null

hyprnix.settings.misc.key_press_enables_dpms Link copied!

Type: null or boolean

If DPMS is set to off, wake up the monitors if a key is pressed.

Default: null

hyprnix.settings.misc.layers_hog_keyboard_focus Link copied!

Type: null or boolean

If true, will make keyboard-interactive layers keep their focus on mouse move (e.g. wofi, bemenu)

Default: null

hyprnix.settings.misc.lockdead_screen_delay Link copied!

Type: null or integer between 100 and 5000 (both inclusive)

delay after which the "lockdead" screen will appear in case a lockscreen app fails to cover all the outputs (5 seconds max)

Default: null

hyprnix.settings.misc.middle_click_paste Link copied!

Type: null or boolean

whether to enable middle-click-paste (aka primary selection)

Default: null

hyprnix.settings.misc.mouse_move_enables_dpms Link copied!

Type: null or boolean

If DPMS is set to off, wake up the monitors if the mouse moves.

Default: null

hyprnix.settings.misc.mouse_move_focuses_monitor Link copied!

Type: null or boolean

Whether mouse moving into a different monitor should focus it

Default: null

hyprnix.settings.misc.name_vk_after_proc Link copied!

Type: null or boolean

Name virtual keyboards after the processes that create them. E.g. /usr/bin/fcitx5 will have hl-virtual-keyboard-fcitx5.

Default: null

hyprnix.settings.misc.on_focus_under_fullscreen Link copied!

Type: null or integer between 0 and 2 (both inclusive)

if there is a fullscreen or maximized window, decide whether a tiled window requested to focus should replace it, stay behind or disable the fullscreen/maximized state. 0 - ignore focus request (keep focus on fullscreen window), 1 - takes over, 2 - unfullscreen/unmaximize

Default: null

hyprnix.settings.misc.render_unfocused_fps Link copied!

Type: null or (positive integer, meaning >0)

the maximum limit for render_unfocused windows’ fps in the background (see also Window-Rules - render_unfocused)

Default: null

hyprnix.settings.misc.session_lock_xray Link copied!

Type: null or boolean

if true, keep rendering workspaces below your lockscreen

Default: null

hyprnix.settings.misc.size_limits_tiled Link copied!

Type: null or boolean

whether to apply min_size and max_size rules to tiled windows

Default: null

hyprnix.settings.misc.splash_font_family Link copied!

Type: null or string

Changes the font used to render the splash text, selected from system fonts (requires a monitor reload to take effect).

Default: null

hyprnix.settings.misc.swallow_exception_regex Link copied!

Type: null or string

The 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.

Default: null

hyprnix.settings.misc.swallow_regex Link copied!

Type: null or string

The class regex to be used for windows that should be swallowed (usually, a terminal).

Default: null

hyprnix.settings.misc.vfr Link copied!

Type: null or boolean

controls the VFR status of Hyprland. Heavily recommended to leave enabled to conserve resources.

Default: null

hyprnix.settings.misc.vrr Link copied!

Type: null or integer between 0 and 3 (both inclusive)

controls the VRR (Adaptive Sync) of your monitors. 0 - off, 1 - on, 2 - fullscreen only, 3 - fullscreen with video or game content type.

Default: null

hyprnix.settings.monitors Link copied!

Type: null or (list of (submodule))

Hyprland monitors configuration (monitorv2)

Default: [ ]
Example:
{
  mode = "1920x1080@100";
  output = "DP-1";
  position = "auto";
  scale = 1;
}

hyprnix.settings.monitors.*.bitdepth Link copied!

Type: null or one of 8, 10

Color bit depth

Default: null

hyprnix.settings.monitors.*.disabled Link copied!

Type: null or boolean

Whether to disable the monitor

Default: null

hyprnix.settings.monitors.*.max_avg_luminance Link copied!

Type: null or signed integer or floating point number

Maximum average luminance of the monitor (nits)

Default: null

hyprnix.settings.monitors.*.max_luminance Link copied!

Type: null or signed integer or floating point number

Peak luminance of the monitor (nits)

Default: null

hyprnix.settings.monitors.*.min_luminance Link copied!

Type: null or signed integer or floating point number

Minimum luminance of the monitor (nits)

Default: null

hyprnix.settings.monitors.*.mirror Link copied!

Type: null or string

Mirror another monitor output

Default: null
Example: "DP-1"

hyprnix.settings.monitors.*.mode Link copied!

Type: string

Resolution and refresh rate

Example: "1920x1080@60"

hyprnix.settings.monitors.*.output Link copied!

Type: string

Monitor output name

Example: "DP-1"

hyprnix.settings.monitors.*.position Link copied!

Type: string

Monitor position

Example: "0x0"

hyprnix.settings.monitors.*.scale Link copied!

Type: positive number, meaning >0

Monitor scale factor

Default: 1

hyprnix.settings.monitors.*.sdr_max_luminance Link copied!

Type: null or signed integer or floating point number

SDR maximum luminance for SDR→HDR mapping (nits)

Default: null

hyprnix.settings.monitors.*.sdr_min_luminance Link copied!

Type: null or signed integer or floating point number

SDR minimum luminance for SDR→HDR mapping (0.005 for true black matching HDR black)

Default: null

hyprnix.settings.monitors.*.supports_hdr Link copied!

Type: null or integer between -1 and 1 (both inclusive)

Force HDR support, requires wide color (0=auto, 1=force on, -1=force off)

Default: null

hyprnix.settings.monitors.*.supports_wide_color Link copied!

Type: null or integer between -1 and 1 (both inclusive)

Force wide color gamut support (0=auto, 1=force on, -1=force off)

Default: null

hyprnix.settings.monitors.*.transform Link copied!

Type: null or integer between 0 and 7 (both inclusive)

Rotation/flip (0=normal, 1=90°, 2=180°, 3=270°, 4=flipped, 5=flipped+90°, 6=flipped+180°, 7=flipped+270°)

Default: null

hyprnix.settings.monitors.*.vrr Link copied!

Type: null or integer between 0 and 3 (both inclusive)

Variable Refresh Rate (0=off, 1=on, 2=fullscreen only, 3=fullscreen with video or game content type)

Default: null

hyprnix.settings.opengl.nvidia_anti_flicker Link copied!

Type: null or boolean

reduces flickering on nvidia at the cost of possible frame drops on lower-end GPUs. On non-nvidia, this is ignored.

Default: null

hyprnix.settings.permissions Link copied!

Type: null or (list of (submodule))

Hyprland permissions configuration

Default: [ ]
Example:
[
  {
    executable = "lib.getExe pkgs.grim";
    mode = "allow";
    permission = "screencopy";
  }
]

hyprnix.settings.permissions.*.executable Link copied!

Type: string or absolute path

path to executable

Example: "lib.getExe pkgs.grim"

hyprnix.settings.permissions.*.mode Link copied!

Type: one of "allow", "ask", "deny"

permission mode

Example: "allow"

hyprnix.settings.permissions.*.permission Link copied!

Type: one of "screencopy", "plugin", "keyboard"

permission assigned to the executable

Example: "screencopy"

hyprnix.settings.quirks.prefer_hdr Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Report HDR mode as preferred. 0 - off, 1 - always, 2 - gamescope only

Default: null

hyprnix.settings.render.cm_auto_hdr Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Auto-switch to HDR in fullscreen when needed. 0 - off, 1 - switch to "cm, hdr," 2 - switch to "cm, hdredid"

Default: null

hyprnix.settings.render.cm_enabled Link copied!

Type: null or boolean

Whether the color management pipeline should be enabled or not (requires a restart of Hyprland to fully take effect)

Default: null

hyprnix.settings.render.cm_fs_passthrough Link copied!

Type: null or integer between 0 and 2 (both inclusive)

Passthrough color settings for fullscreen apps when possible. 0 - off, 1 - always, 2 - hdr only

Default: null

hyprnix.settings.render.cm_sdr_eotf Link copied!

Type: null or string

Default transfer function for displaying SDR apps. default - Use default value (Gamma 2.2), gamma22 - Treat unspecified as Gamma 2.2, gamma22force - Treat unspecified and sRGB as Gamma 2.2, srgb - Treat unspecified as sRGB

Default: null

hyprnix.settings.render.commit_timing_enabled Link copied!

Type: null or boolean

Enable commit timing proto. Requires restart

Default: null

hyprnix.settings.render.ctm_animation Link copied!

Type: null or (unsigned integer, meaning >=0)

Whether to enable a fade animation for CTM changes (hyprsunset). 2 means “auto” which disables them on Nvidia.

Default: null

hyprnix.settings.render.direct_scanout Link copied!

Type: null or one of 0, 1, 2

Enables 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 0 if the fullscreen application shows graphical glitches. 0 - off, 1 - on, 2 - auto (on with content type ‘game’)

Default: null

hyprnix.settings.render.expand_undersized_textures Link copied!

Type: null or boolean

Whether to expand undersized textures along the edge, or rather stretch the entire texture.

Default: null

hyprnix.settings.render.new_render_scheduling Link copied!

Type: null or boolean

Automatically uses triple buffering when needed, improves FPS on underpowered devices.

Default: null

hyprnix.settings.render.non_shader_cm Link copied!

Type: null or integer between 0 and 3 (both inclusive)

Enable CM without shader. 0 - disable, 1 - whenever possible, 2 - DS and passthrough only, 3 - disable and ignore CM issues

Default: null

hyprnix.settings.render.send_content_type Link copied!

Type: null or boolean

Report content type to allow monitor profile autoswitch (may result in a black screen during the switch)

Default: null

hyprnix.settings.render.xp_mode Link copied!

Type: null or boolean

Disables back buffer and bottom layer rendering.

Default: null

hyprnix.settings.scrolling.column_width Link copied!

Type: null or number between 0.100000 and 1 (both inclusive)

the default width of a column

Default: null

hyprnix.settings.scrolling.direction Link copied!

Type: null or one of "left", "right", "down", "up"

Direction in which new windows appear and the layout scrolls.

Default: null

hyprnix.settings.scrolling.explicit_column_widths Link copied!

Type: null or (list of (signed integer or floating point number))

A list of preconfigured widths for colresize +conf/-conf

Default: null

hyprnix.settings.scrolling.focus_fit_method Link copied!

Type: null or integer between 0 and 1 (both inclusive)

When a column is focused, what method should be used to bring it into view. 0 = center, 1 = fit

Default: null

hyprnix.settings.scrolling.follow_focus Link copied!

Type: null or boolean

when a window is focused, should the layout move to bring it into view automatically

Default: null

hyprnix.settings.scrolling.follow_min_visible Link copied!

Type: null or number between 0 and 1 (both inclusive)

when a window is focused, require that at least a given fraction of it is visible for focus to follow. Hard input (e.g. binds, clicks) will always follow.

Default: null

hyprnix.settings.scrolling.fullscreen_on_one_column Link copied!

Type: null or boolean

when enabled, a single column on a workspace will always span the entire screen.

Default: null

hyprnix.settings.scrolling.wrap_focus Link copied!

Type: null or boolean

When enabled, causes layoutmsg focus l/r to wrap around at the beginning and end.

Default: null

hyprnix.settings.scrolling.wrap_swapcol Link copied!

Type: null or boolean

When enabled, causes layoutmsg swapcol l/r to wrap around at the beginning and end.

Default: null

hyprnix.settings.windowrules Link copied!

Type: list of (submodule)

Hyprland windowrules configuration.

Default: [ ]
Example:
[
  {
    center = true;
    float = true;
    match = {
      class = "mpv";
    };
    name = "floating-mpv";
    size = [
      1280
      720
    ];
  }
  {
    match = {
      class = "kitty";
    };
    opacity = [
      0.9
      0.75
    ];
  }
]

hyprnix.settings.windowrules.*.allows_input Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.animation Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.border_color Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.border_size Link copied!

Type: null or (unsigned integer, meaning >=0)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.center Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.content Link copied!

Type: null or one of "none", "photo", "video", "game"

This option has no description.

Default: null

hyprnix.settings.windowrules.*.decorate Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.dim_around Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.float Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.focus_on_activate Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.force_rgbx Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.fullscreen Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.fullscreen_state Link copied!

Type: null or integer between 0 and 3 (both inclusive)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.idle_inhibit Link copied!

Type: null or one of "none", "always", "focus", "fullscreen"

This option has no description.

Default: null

hyprnix.settings.windowrules.*.immediate Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.keep_aspect_ratio Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match Link copied!

Type: submodule

Match conditions.

Default: { }

hyprnix.settings.windowrules.*.match.class Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.content Link copied!

Type: null or integer between 0 and 3 (both inclusive)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.float Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.focus Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.fullscreen Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.fullscreen_state_client Link copied!

Type: null or integer between 0 and 3 (both inclusive)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.fullscreen_state_internal Link copied!

Type: null or integer between 0 and 3 (both inclusive)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.group Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.initial_class Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.initial_title Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.modal Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.pin Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.tag Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.title Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.workspace Link copied!

Type: null or unsigned integer, meaning >=0, or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.xdg_tag Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.match.xwayland Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.max_size Link copied!

Type: null or (list of (unsigned integer, meaning >=0))

This option has no description.

Default: null

hyprnix.settings.windowrules.*.maximize Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.min_size Link copied!

Type: null or (list of (unsigned integer, meaning >=0))

This option has no description.

Default: null

hyprnix.settings.windowrules.*.monitor Link copied!

Type: null or unsigned integer, meaning >=0, or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.move Link copied!

Type: null or string or list of (unsigned integer, meaning >=0)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.name Link copied!

Type: null or string

Name of the windowrule

Default: null

hyprnix.settings.windowrules.*.nearest_neighbor Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_anim Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_blur Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_close_for Link copied!

Type: null or (unsigned integer, meaning >=0)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_dim Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_focus Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_follow_mouse Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_initial_focus Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_max_size Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_screen_share Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_shadow Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_shortcuts_inhibit Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.no_vrr Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.opacity Link copied!

Type: null or (Additional opacity multiplier. One value -> sets an overall opacity Two values -> sets active_opacity and inactive_opacity respectively Three values -> sets active_opacity, inactive_opacity and fullscreen_opacity respectively. )

This option has no description.

Default: null

hyprnix.settings.windowrules.*.opaque Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.persistent_size Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.pin Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.pseudo Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.render_unfocused Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.rounding Link copied!

Type: null or (unsigned integer, meaning >=0)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.rounding_power Link copied!

Type: null or unsigned number, meaning >=0

This option has no description.

Default: null

hyprnix.settings.windowrules.*.scroll_mouse Link copied!

Type: null or unsigned number, meaning >=0

This option has no description.

Default: null

hyprnix.settings.windowrules.*.scroll_touchpad Link copied!

Type: null or unsigned number, meaning >=0

This option has no description.

Default: null

hyprnix.settings.windowrules.*.scrolling_width Link copied!

Type: null or unsigned number, meaning >=0

This option has no description.

Default: null

hyprnix.settings.windowrules.*.size Link copied!

Type: null or string or list of (unsigned integer, meaning >=0)

This option has no description.

Default: null

hyprnix.settings.windowrules.*.stay_focused Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.suppress_event Link copied!

Type: null or one of "fullscreen", "maximize", "activate", "activatefocus", "fullscreenoutput"

This option has no description.

Default: null

hyprnix.settings.windowrules.*.sync_fullscreen Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.tag Link copied!

Type: null or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.tile Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.windowrules.*.workspace Link copied!

Type: null or unsigned integer, meaning >=0, or string

This option has no description.

Default: null

hyprnix.settings.windowrules.*.xray Link copied!

Type: null or boolean

This option has no description.

Default: null

hyprnix.settings.workspaces Link copied!

Type: list of (submodule)

Hyprland workspace rules configuration.

Default: [ ]
Example:
[
  {
    id = 1;
    rules = {
      default = true;
      persistent = true;
    };
  }
]

hyprnix.settings.workspaces.*.id Link copied!

Type: integer between 1 and 9 (both inclusive)

The workspace's id.

hyprnix.settings.workspaces.*.rules Link copied!

Type: submodule

Rules for this workspace. At least one must be set.

Default: { }

hyprnix.settings.workspaces.*.rules.animations Link copied!

Type: null or string

The animation style to use for this workspace.

Default: null

hyprnix.settings.workspaces.*.rules.border Link copied!

Type: null or boolean

Whether to draw borders or not

Default: null

hyprnix.settings.workspaces.*.rules.bordersize Link copied!

Type: null or (positive integer, meaning >0)

Set the border size around windows (equivalent to General->border_size)

Default: null

hyprnix.settings.workspaces.*.rules.decorate Link copied!

Type: null or boolean

Whether to draw window decorations or not

Default: null

hyprnix.settings.workspaces.*.rules.default Link copied!

Type: null or boolean

Whether this workspace should be the default workspace for the given monitor

Default: null

hyprnix.settings.workspaces.*.rules.defaultName Link copied!

Type: null or string

A default name for the workspace.

Default: null

hyprnix.settings.workspaces.*.rules.gapsin Link copied!

Type: null or (unsigned integer, meaning >=0)

Set the gaps between windows (equivalent to General->gaps_in)

Default: null

hyprnix.settings.workspaces.*.rules.gapsout Link copied!

Type: null or (unsigned integer, meaning >=0)

Set the gaps between windows and monitor edges (equivalent to General->gaps_out)

Default: null

hyprnix.settings.workspaces.*.rules.layout Link copied!

Type: null or string

The layout to use for this workspace.

Default: null

hyprnix.settings.workspaces.*.rules.monitor Link copied!

Type: null or string

Binds a workspace to a monitor.

Default: null

hyprnix.settings.workspaces.*.rules.persistent Link copied!

Type: null or boolean

Keep this workspace alive even if empty and inactive

Default: null

hyprnix.settings.workspaces.*.rules.rounding Link copied!

Type: null or boolean

Whether to draw rounded windows or not

Default: null

hyprnix.settings.workspaces.*.rules.shadow Link copied!

Type: null or boolean

Whether to draw shadows or not

Default: null

hyprnix.systemd.enable Link copied!

Type: boolean

Whether to enable systemd integration.

Default: false
Example: true

hyprnix.xwayland.create_abstract_socket Link copied!

Type: null or boolean

Create the abstract Unix domain socket for XWayland connections. XWayland restart is required for changes to take effect.

Default: null

hyprnix.xwayland.enable Link copied!

Type: boolean

Whether to enable allow running applications using X11.

Default: false
Example: true

hyprnix.xwayland.force_zero_scaling Link copied!

Type: null or boolean

forces a scale of 1 on xwayland windows on scaled displays.

Default: null

hyprnix.xwayland.use_nearest_neighbor Link copied!

Type: null or boolean

uses the nearest neighbor filtering for xwayland apps, making them pixelated rather than blurry

Default: null