diff --git a/pages/Configuring/Master-Layout.md b/pages/Configuring/Master-Layout.md index 10980c0..38ac049 100644 --- a/pages/Configuring/Master-Layout.md +++ b/pages/Configuring/Master-Layout.md @@ -16,24 +16,27 @@ However, you can resize the master window. _category name `master`_ -| name | description | type | default | -| -------------------- | ------------------------------------------------------------------------------------ | ----- | ------- | -| special_scale_factor | (0.0 - 1.0) the scale of the special workspace windows | float | 0.8 | -| new_is_master | whether a newly open window should replace the master or join the slaves. | bool | false | -| new_on_top | whether a newly open window should be on the top of the stack | bool | false | -| no_gaps_when_only | whether to apply gaps when there is only one window on a workspace, aka. smart gaps. | bool | false | +| name | description | type | default | +|---|---|---|---|---| +| pseudotile | enable pseudotiling. Pseudotiled windows retain their floating size when tiled. | bool | false | +| col.group_border | inactive (out of focus) group border color | color | 0x66777700 | +| col.group_border_active | active group border color | color | 0x66ffff00 | +| force_split | 0 -> split follows mouse, 1 -> always split to the left (new = left or top) 2 -> always split to the right (new = right or bottom) | int | 0 | +| preserve_split | if enabled, the split (side/top) will not change regardless of what happens to the container. | bool | false | +| special_scale_factor | 0 - 1 -> specifies the scale factor of windows on the special workspace | float | 0.8 | +| split_width_multiplier | specifies the auto-split width multiplier | float | 1.0 | +| no_gaps_when_only | whether to apply gaps when there is only one window on a workspace, aka. smart gaps. | bool | false | +| use_active_for_splits | whether to prefer the active window or the mouse position for splits | bool | true | ## Dispatchers `layoutmsg` params: -| param | description | -| -------------- | ----------------------------------------------------------------------- | -| swapwithmaster | swaps the current window with master | -| cyclenext | focuses the next window respecting the layout | -| cycleprev | focuses the previous window respecting the layout | -| swapnext | swaps the focused window with the next window respecting the layout | -| swapprev | swaps the focused window with the previous window respecting the layout | +| dispatcher | description | params | +|---|---|---| +| togglegroup | toggles the current window and its siblings (recursively) into a group | none | +| changegroupactive | switches to the next window in a group. | b - back, f - forward. | +| togglesplit | toggles the split (top/side) of the current window | none | {{< hint type=info >}} example usage: diff --git a/pages/Configuring/Variables.md b/pages/Configuring/Variables.md index be6e0a7..e130a6a 100644 --- a/pages/Configuring/Variables.md +++ b/pages/Configuring/Variables.md @@ -8,15 +8,15 @@ the layout pages and not here. (See the Sidebar for Dwindle and Master layouts) ## Variable types -| type | description | -| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| int | integer | -| bool | boolean, `true` or `false` (`yes` or `no`, `0` or `1`) - any numerical value that is not `0` or `1` will cause undefined behaviour. | -| float | floating point number | -| color | color (see hint below for color info) | -| vec2 | vector with 2 values (float), separated by a space (e.g. `0 0` or `-10.9 99.1`) | -| MOD | a 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 `,`) | -| str | a string | +| type | description | +|---|---| +| int | integer | +| bool | boolean, `true` or `false` (`yes` or `no`, `0` or `1`) - any numerical value that is not `0` or `1` will cause undefined behaviour. | +| float | floating point number | +| color | color (see hint below for color info) | +| vec2 | vector with 2 values (float), separated by a space (e.g. `0 0` or `-10.9 99.1`) | +| MOD | a 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 `,`) | +| str | a string | {{< hint type=info >}} @@ -42,20 +42,20 @@ SHIFT CAPS CTRL/CONTROL ALT MOD2 MOD3 SUPER/WIN/LOGO/MOD4 MOD5 ### General -| name | description | type | default | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | ---------- | -| sensitivity | mouse sensitivity (legacy, may cause bugs if not 1, prefer `input:sensitivity`) | float | 1.0 | -| border_size | self-explanatory | int | 1 | -| no_border_on_floating | disable borders for floating windows | bool | false | -| gaps_in | gaps between windows | int | 5 | -| gaps_out | gaps between windows and monitor edges | int | 20 | -| col.inactive_border | self-explanatory | color | 0xffffffff | -| col.active_border | self-explanatory | color | 0xff444444 | -| cursor_inactive_timeout | in seconds, after how many seconds of cursor's inactivity to hide it. Set to `0` for never. | int | 0 | -| damage_tracking | Makes the compositor redraw only the needed bits of the display. Saves on resources by not redrawing when not needed. Available modes: `none, monitor, full`. You don't need to know what different modes do, just always use `full`. | str | full | -| layout | which layout to use. (Available: `dwindle`, `master`) | str | dwindle | -| no_cursor_warps | if true, will not warp the cursor in many cases (focusing, keybinds, etc) | bool | false | -| apply_sens_to_raw | if on, will also apply the sensitivity to raw mouse output (e.g. sensitivity in games) **NOTICE:** **_really_** not recommended. | bool | false | +| name | description | type | default | +|---|---|---|---|---| +| sensitivity | mouse sensitivity (legacy, may cause bugs if not 1, prefer `input:sensitivity`) | float | 1.0 | +| border_size | self-explanatory | int | 1 | +| no_border_on_floating | disable borders for floating windows | bool | false | +| gaps_in | gaps between windows | int | 5 | +| gaps_out | gaps between windows and monitor edges | int | 20 | +| col.inactive_border | self-explanatory | color | 0xffffffff | +| col.active_border | self-explanatory | color | 0xff444444 | +| cursor_inactive_timeout | in seconds, after how many seconds of cursor's inactivity to hide it. Set to `0` for never. | int | 0 | +| damage_tracking | Makes the compositor redraw only the needed bits of the display. Saves on resources by not redrawing when not needed. Available modes: `none, monitor, full`. You don't need to know what different modes do, just always use `full`. | str | full | +| layout | which layout to use. (Available: `dwindle`, `master`) | str | dwindle | +| no_cursor_warps | if true, will not warp the cursor in many cases (focusing, keybinds, etc) | bool | false | +| apply_sens_to_raw | if on, will also apply the sensitivity to raw mouse output (e.g. sensitivity in games) **NOTICE:** ***really*** not recommended. | bool | false | {{< hint type=warning >}} Prefer using `input:sensitivity` over `general:sensitivity` to avoid bugs, especially with Wine/Proton apps. @@ -63,27 +63,27 @@ Prefer using `input:sensitivity` over `general:sensitivity` to avoid bugs, espec ### Decoration -| name | description | type | default | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ---------- | -| rounding | rounded corners' radius (in layout px) | int | 0 | -| multisample_edges | enable antialiasing (no-jaggies) for rounded corners | bool | true | -| active_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | -| inactive_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | -| fullscreen_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | -| blur | enable kawase window background blur | bool | true | -| blur_size | blur size (distance) | int | 8 | -| blur_passes | the amount of passes to perform | int | 1 | -| blur_ignore_opacity | make the blur layer ignore the opacity of the window | bool | false | -| blur_new_optimizations | whether to enable further optimizations to the blur. Recommended to turn on, as it will massively improve performance, but some people have experienced graphical issues | bool | false | -| drop_shadow | enable drop shadows on windows | bool | true | -| shadow_range | Shadow range ("size") in layout px | int | 4 | -| shadow_render_power | (1 - 4), in what power to render the falloff (more power, the faster the falloff) | int | 3 | -| shadow_ignore_window | if true, the shadow will not be rendered behind the window itself, only around it. | bool | true | -| col.shadow | shadow's color. Alpha dictates shadow's opacity. | color | 0xee1a1a1a | -| col.shadow_inactive | inactive shadow color. (if not set, will fall back to col.shadow) | color | unset | -| shadow_offset | shadow's rendering offset. | vec2 | [0, 0] | -| dim_inactive | enables dimming of inactive windows | bool | false | -| dim_strength | how much inactive windows should be dimmed, 0.0 - 1.0 | float | 0.5 | +| name | description | type | default | +|---|---|---|---|---| +| rounding | rounded corners' radius (in layout px) | int | 0 | +| multisample_edges | enable antialiasing (no-jaggies) for rounded corners | bool | true | +| active_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | +| inactive_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | +| fullscreen_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | +| blur | enable kawase window background blur | bool | true | +| blur_size | blur size (distance) | int | 8 | +| blur_passes | the amount of passes to perform | int | 1 | +| blur_ignore_opacity | make the blur layer ignore the opacity of the window | bool | false | +| blur_new_optimizations | whether to enable further optimizations to the blur. Recommended to turn on, as it will massively improve performance, but some people have experienced graphical issues | bool | false | +| drop_shadow | enable drop shadows on windows | bool | true | +| shadow_range | Shadow range ("size") in layout px | int | 4 | +| shadow_render_power | (1 - 4), in what power to render the falloff (more power, the faster the falloff) | int | 3 | +| shadow_ignore_window | if true, the shadow will not be rendered behind the window itself, only around it. | bool | true | +| col.shadow | shadow's color. Alpha dictates shadow's opacity. | color | 0xee1a1a1a | +| col.shadow_inactive | inactive shadow color. (if not set, will fall back to col.shadow) | color | unset | +| shadow_offset | shadow's rendering offset. | vec2 | [0, 0] | +| dim_inactive | enables dimming of inactive windows | bool | false | +| dim_strength | how much inactive windows should be dimmed, 0.0 - 1.0 | float | 0.5 | {{< hint type=info >}} @@ -116,25 +116,28 @@ _[More about Animations](../Animations)._ ### Input -| name | description | type | default | -| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | --------- | -| kb_layout | Appropriate XKB keymap parameter | str | us | -| kb_variant | Appropriate XKB keymap parameter | str | \[EMPTY\] | -| kb_model | Appropriate XKB keymap parameter | str | \[EMPTY\] | -| kb_options | Appropriate XKB keymap parameter | str | \[EMPTY\] | -| kb_rules | Appropriate XKB keymap parameter | str | \[EMPTY\] | -| kb_file | If you prefer, you can use a path to an .xkb file. | str | \[EMPTY\] | -| follow_mouse | (0/1/2/3) enable mouse following (focus on enter new window) - See the note below for more info | int | 1 | -| float_switch_override_focus | if enabled (1 or 2), focus will follow mouse if changing from tiled to floating and vice versa. 2 will also follow mouse on float -> float switches | int | 1 | -| repeat_rate | in repeats per second, the repeat rate for held keys | int | 25 | -| repeat_delay | in ms, the repeat delay (grace period) before the spam | int | 600 | -| natural_scroll | enable natural scroll | bool | false | -| numlock_by_default | lock numlock by default | bool | false | -| force_no_accel | force no mouse acceleration, bypasses most of your pointer settings to get as raw of a signal as possible. | bool | false | -| sensitivity | set the libinput sensitivity. This **HAS** to be from -1 to 1, or else it will be clamped. | float | 0.0 | -| left_handed | switches RMB and LMB | bool | false | -| accel_profile | set the libinput acceleration profile. Can be one of `adaptive`, `flat`. | str | \[EMPTY\] | -| scroll_method | set the libinput scroll method. Can be one of `2fg` (2 fingers), `edge`, `on_button_down`, `no_scroll`. | str | \[EMPTY\] | +## Input + +| name | description | type | default | +|---|---|---|---|---| +| kb_layout | Appropriate XKB keymap parameter | str | us | +| kb_variant | Appropriate XKB keymap parameter | str | \[EMPTY\] | +| kb_model | Appropriate XKB keymap parameter | str | \[EMPTY\] | +| kb_options | Appropriate XKB keymap parameter | str | \[EMPTY\] | +| kb_rules | Appropriate XKB keymap parameter | str | \[EMPTY\] | +| kb_file | If you prefer, you can use a path to an .xkb file. | str | \[EMPTY\] | +| follow_mouse | (0/1/2/3) enable mouse following (focus on enter new window) - See the note below for more info | int | 1 | +| float_switch_override_focus | if enabled (1 or 2), focus will follow mouse if changing from tiled to floating and vice versa. 2 will also follow mouse on float -> float switches | int | 1 | +| repeat_rate | in repeats per second, the repeat rate for held keys | int | 25 | +| repeat_delay | in ms, the repeat delay (grace period) before the spam | int | 600 | +| natural_scroll | enable natural scroll | bool | false | +| numlock_by_default | lock numlock by default | bool | false | +| force_no_accel | force no mouse acceleration, bypasses most of your pointer settings to get as raw of a signal as possible. | bool | false | +| sensitivity | set the libinput sensitivity. This **HAS** to be from -1 to 1, or else it will be clamped. | float | 0.0 | +| left_handed | switches RMB and LMB | bool | false | +| accel_profile | set the libinput acceleration profile. Can be one of `adaptive`, `flat`. | str | \[EMPTY\] +| scroll_method | set the libinput scroll method. Can be one of `2fg` (2 fingers), `edge`, `on_button_down`, `no_scroll`. | str | \[EMPTY\] + {{< hint type=info >}} @@ -155,15 +158,15 @@ For switchable keyboard configs, take a look at [the uncommon tips & tricks page _Subcategory `input:touchpad:`_ -| name | description | type | default | -| ----------------------- | ------------------------------------ | ----- | ------- | -| disable_while_typing | disables the touchpad while typing | bool | true | -| natural_scroll | self-explanatory | bool | false | -| clickfinger_behavior | self-explanatory | bool | false | -| middle_button_emulation | self-explanatory | bool | false | -| tap-to-click | self-explanatory | bool | true | -| drag_lock | enable dragging with drag lock | bool | false | -| scroll_factor | control the amount of scroll applied | float | 1.0 | +| name | description | type | default | +|---|---|---|---|---| +| disable_while_typing | disables the touchpad while typing | bool | true | +| natural_scroll | self-explanatory | bool | false | +| clickfinger_behavior | self-explanatory | bool | false | +| middle_button_emulation | self-explanatory | bool | false | +| tap-to-click | self-explanatory | bool | true | +| drag_lock | enable dragging with drag lock | bool | false | +| scroll_factor | control the amount of scroll applied | float | 1.0 {{< hint type=important >}} A subcategory is a nested category: @@ -187,10 +190,10 @@ Doing `input:touchpad {` is **invalid**! _Subcategory `input:touchdevice:`_ -| name | description | type | default | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | --------- | -| transform | transform the input from touchdevices. The possible transformations are the same as [those of the monitors](../Monitors/#rotating-and-the-default-workspace) | int | 0 | -| output | the output to bind touch devices. Empty means unset and will use the current / autodetected. | string | \[EMPTY\] | +| name | description | type | default | +|---|---|---|---|---| +| transform | transform the input from touchdevices. The possible transformations are the same as [those of the monitors](../Monitors/#rotating-and-the-default-workspace) | int | 0 | +| output | the output to bind touch devices. Empty means unset and will use the current / autodetected. | string | \[EMPTY\] | ### Per-device input config @@ -198,39 +201,40 @@ Described [here](../Keywords#per-device-input-configs). ## Gestures -| name | description | type | default | -| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----- | ------- | -| workspace_swipe | enable workspace swipe gesture | bool | false | -| workspace_swipe_fingers | how many fingers for the gesture | int | 3 | -| workspace_swipe_distance | in px, the distance of the gesture | int | 300 | -| workspace_swipe_invert | invert the direction | bool | true | -| workspace_swipe_min_speed_to_force | minimum speed in px per timepoint to force the change ignoring `cancel_ratio`. Setting to `0` will disable this mechanic. | int | 30 | -| workspace_swipe_cancel_ratio | (0.0 - 1.0) how much the swipe has to proceed in order to commence it. (0.7 -> if > 0.7 \* distance, switch, if less, revert) | float | 0.5 | +| name | description | type | default | +|---|---|---|---|---| +| workspace_swipe | enable workspace swipe gesture | bool | false | +| workspace_swipe_fingers | how many fingers for the gesture | int | 3 | +| workspace_swipe_distance | in px, the distance of the gesture | int | 300 | +| workspace_swipe_invert | invert the direction | bool | true | +| workspace_swipe_min_speed_to_force | minimum speed in px per timepoint to force the change ignoring `cancel_ratio`. Setting to `0` will disable this mechanic. | int | 30 | +| workspace_swipe_cancel_ratio | (0.0 - 1.0) how much the swipe has to proceed in order to commence it. (0.7 -> if > 0.7 * distance, switch, if less, revert) | float | 0.5 | +| workspace_swipe_create_new | whether a swipe right on the last workspace should create a new one. | bool | true | ## Misc -| name | description | type | default | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | --------- | -| disable_hyprland_logo | disables the hyprland logo background. :( | bool | false | -| disable_splash_rendering | disables the hyprland splash rendering. (requires a monitor reload to take effect) | bool | false | -| no_vfr | disables VFR (variable frame rate) - VFR increases battery life at the expense of possible issues on a few monitors. | bool | true | -| damage_entire_on_snapshot | (deprecated: do not enable) Damage the entire monitor when rendering snapshots. Recommended with transformed displays. Do not use without transformed displays. | bool | false | -| mouse_move_enables_dpms | If DPMS is set to off, wake up the monitors if the mouse moves. | bool | false | -| always_follow_on_dnd | 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. | bool | true | -| layers_hog_keyboard_focus | If true, will make keyboard-interactive layers keep their focus on mouse move (e.g. wofi, bemenu) | bool | true | -| animate_manual_resizes | If true, will animate manual window resizes/moves | bool | false | -| disable_autoreload | If true, the config will not reload automatically on save, and instead needs to be reloaded with `hyprctl reload`. Might save on battery. | bool | false | -| enable_swallow | Enable window swallowing | bool | false | -| swallow_regex | The _class_ regex to be used for windows that should be swallowed (usually, a terminal) | str | \[EMPTY\] | +| name | description | type | default | +|---|---|---|---|---| +| disable_hyprland_logo | disables the hyprland logo background. :( | bool | false | +| disable_splash_rendering | disables the hyprland splash rendering. (requires a monitor reload to take effect) | bool | false | +| no_vfr | disables VFR (variable frame rate) - VFR increases battery life at the expense of possible issues on a few monitors. | bool | true | +| damage_entire_on_snapshot | (deprecated: do not enable) Damage the entire monitor when rendering snapshots. Recommended with transformed displays. Do not use without transformed displays. | bool | false | +| mouse_move_enables_dpms | If DPMS is set to off, wake up the monitors if the mouse moves. | bool | false | +| always_follow_on_dnd | 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. | bool | true | +| layers_hog_keyboard_focus | If true, will make keyboard-interactive layers keep their focus on mouse move (e.g. wofi, bemenu) | bool | true | +| animate_manual_resizes | If true, will animate manual window resizes/moves | bool | false | +| disable_autoreload | If true, the config will not reload automatically on save, and instead needs to be reloaded with `hyprctl reload`. Might save on battery. | bool | false | +| enable_swallow | Enable window swallowing | bool | false | +| swallow_regex | The *class* regex to be used for windows that should be swallowed (usually, a terminal) | str | \[EMPTY\] | ## Binds -| name | description | type | default | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | ------- | -| pass_mouse_when_bound | if disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered. | bool | false | -| scroll_event_delay | in ms, how many ms to wait after a scroll event to allow to pass another one for the binds. | int | 300 | -| workspace_back_and_forth | 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_. | bool | false | -| allow_workspace_cycles | 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. | bool | false | +| name | description | type | default | +|---|---|---|---|---| +| pass_mouse_when_bound | if disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered. | bool | false | +| scroll_event_delay | in ms, how many ms to wait after a scroll event to allow to pass another one for the binds. | int | 300 | +| workspace_back_and_forth | 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*. | bool | false | +| allow_workspace_cycles | 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. | bool | false | ## Debug @@ -240,12 +244,12 @@ Only for developers. {{< /hint >}} -| name | description | type | default | -| ------------ | ---------------------------------------------------------------------- | ---- | ------- | -| overlay | print the debug performance overlay. Disable VFR for accurate results. | bool | false | -| damage_blink | (epilepsy warning!) flash areas updated with damage tracking | bool | false | -| disable_logs | self-explanatory | bool | false | -| disable_time | disables time logging | bool | true | +| name | description | type | default | +|---|---|---|---|---| +| overlay | print the debug performance overlay. Disable VFR for accurate results. | bool | false | +| damage_blink | (epilepsy warning!) flash areas updated with damage tracking | bool | false | +| disable_logs | self-explanatory | bool | false | +| disable_time | disables time logging | bool | true | ## More diff --git a/pages/Configuring/Window-Rules.md b/pages/Configuring/Window-Rules.md index 05990cc..f7828a5 100644 --- a/pages/Configuring/Window-Rules.md +++ b/pages/Configuring/Window-Rules.md @@ -58,28 +58,31 @@ you can use `hyprctl clients`. ## Rules -| Rule | Description | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| float | floats a window | -| tile | tiles a window | -| fullscreen | fullscreens a window | -| move \[x\] \[y\] | moves a floating window (x,y -> int or %, e.g. 20% or 100) | -| size \[x\] \[y\] | resizes a floating window (x,y -> int or %, e.g. 20% or 100) | -| minsize \[x\] \[y\] | sets the minimum size on creation (x,y -> int) | -| maxsize \[x\] \[y\] | sets the maximum size on creation (x,y -> int) | -| center | if the window is floating, will center it on the monitor | -| pseudo | pseudotiles a window | -| monitor \[id\] | sets the monitor on which a window should open | -| workspace \[w\] | sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../Dispatchers#workspaces)). You can also make \[w\] to `unset`, will unset all previous workspace rules applied to this window. You can also add `silent` after the workspace to make the window open silently. | -| opacity \[a\] | additional opacity multiplier. Options for a: `float` -> sets an opacity OR `float float` -> sets activeopacity and inactiveopacity respectively | -| opaque | forces the window to be opaque (can be toggled with the toggleopaque dispatcher) | -| animation \[style\] (\[opt\]) | forces an animation onto a window, with a selected opt. Opt is optional. | -| rounding \[x\] | forces the application to have X pixels of rounding, ignoring the set default (in `decoration:rounding`). Has to be an int. | -| noblur | disables blur for the window | -| nofocus | disables focus to the window | -| forceinput | forces an XWayland window to receive input, even if it requests not to do so. (Might fix issues like e.g. Game Launchers not receiving focus for some reason) | -| pin | pins the window _note: floating only_ | -| noanim | disables the animations for the window | +======= +| Rule | Description | +| ---- | ----------- | +| float | floats a window | +| tile | tiles a window | +| fullscreen | fullscreens a window | +| move \[x\] \[y\] | moves a floating window (x,y -> int or %, e.g. 20% or 100) | +| size \[x\] \[y\] | resizes a floating window (x,y -> int or %, e.g. 20% or 100) | +| minsize \[x\] \[y\] | sets the minimum size on creation (x,y -> int) | +| maxsize \[x\] \[y\] | sets the maximum size on creation (x,y -> int) | +| center | if the window is floating, will center it on the monitor | +| pseudo | pseudotiles a window | +| monitor \[id\] | sets the monitor on which a window should open | +| workspace \[w\] | sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../Dispatchers#workspaces)). You can also make \[w\] to `unset`, will unset all previous workspace rules applied to this window. You can also add `silent` after the workspace to make the window open silently. | +| opacity \[a\] | additional opacity multiplier. Options for a: `float` -> sets an opacity OR `float float` -> sets activeopacity and inactiveopacity respectively | +| opaque | forces the window to be opaque (can be toggled with the toggleopaque dispatcher) | +| animation \[style\] (\[opt\]) | forces an animation onto a window, with a selected opt. Opt is optional. | +| rounding \[x\] | forces the application to have X pixels of rounding, ignoring the set default (in `decoration:rounding`). Has to be an int. | +| noblur | disables blur for the window | +| nofocus | disables focus to the window | +| noborder | disables borders for the window | +| noshadow | disables shadows for the window | +| forceinput | forces an XWayland window to receive input, even if it requests not to do so. (Might fix issues like e.g. Game Launchers not receiving focus for some reason) | +| pin | pins the window *note: floating only* | +| noanim | disables the animations for the window | ### Example Rules diff --git a/pages/IPC/_index.md b/pages/IPC/_index.md index db38056..165d8f8 100644 --- a/pages/IPC/_index.md +++ b/pages/IPC/_index.md @@ -26,24 +26,24 @@ e.g.: `workspace>>2` ### Events list -| name | description | data | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| workspace | emitted on workspace change. Is emitted ONLY when a user requests a workspace change, and is not emitted on mouse movements (see `activemon`) | `WORKSPACENAME` | -| focusedmon | emitted on the active monitor being changed. | `MONNAME,WORKSPACENAME` | -| activewindow | emitted on the active window being changed. | `WINDOWCLASS,WINDOWTITLE` | -| fullscreen | emitted when a fullscreen status of a window changes. | `0/1` (exit fullscreen / enter fullscreen) | -| monitorremoved | emitted when a monitor is removed (disconnected) | `MONITORNAME` | -| monitoradded | emitted when a monitor is added (connected) | `MONITORNAME` | -| createworkspace | emitted when a workspace is created | `WORKSPACENAME` | -| destroyworkspace | emitted when a workspace is destroyed | `WORKSPACENAME` | -| moveworkspace | emitted when a workspace is moved to a different monitor | `WORKSPACENAME,MONNAME` | -| activelayout | emitted on a layout change of the active keyboard | `KEYBOARDNAME,LAYOUTNAME` | -| openwindow | emitted when a window is opened | `WINDOWADDRESS`,`WORKSPACENAME`,`WINDOWCLASS`,`WINDOWTITLE` | -| closewindow | emitted when a window is closed | `WINDOWADDRESS` | -| movewindow | emitted when a window is moved to a workspace | `WINDOWADDRESS`,`WORKSPACENAME` | -| openlayer | emitted when a layerSurface is mapped | `NAMESPACE` | -| closelayer | emitted when a layerSurface is unmapped | `NAMESPACE` | -| submap | emitted when a keybind submap changes. Empty means default. | `SUBMAPNAME` | +| name | description | data | +| --- | --- | --- | +| workspace | emitted on workspace change. Is emitted ONLY when a user requests a workspace change, and is not emitted on mouse movements (see `activemon`) | `WORKSPACENAME` | +| focusedmon | emitted on the active monitor being changed. | `MONNAME,WORKSPACENAME` | +| activewindow | emitted on the active window being changed. | `WINDOWCLASS,WINDOWTITLE` | +| fullscreen | emitted when a fullscreen status of a window changes. | `0/1` (exit fullscreen / enter fullscreen) | +| monitorremoved | emitted when a monitor is removed (disconnected) | `MONITORNAME` | +| monitoradded | emitted when a monitor is added (connected) | `MONITORNAME` | +| createworkspace | emitted when a workspace is created | `WORKSPACENAME` | +| destroyworkspace | emitted when a workspace is destroyed | `WORKSPACENAME` | +| moveworkspace | emitted when a workspace is moved to a different monitor | `WORKSPACENAME,MONNAME` | +| activelayout | emitted on a layout change of the active keyboard | `KEYBOARDNAME,LAYOUTNAME` | +| openwindow | emitted when a window is opened | `WINDOWADDRESS`,`WORKSPACENAME`,`WINDOWCLASS`,`WINDOWTITLE` | +| closewindow | emitted when a window is closed | `WINDOWADDRESS` | +| movewindow | emitted when a window is moved to a workspace | `WINDOWADDRESS`,`WORKSPACENAME` | +| openlayer | emitted when a layerSurface is mapped | `NAMESPACE` | +| closelayer | emitted when a layerSurface is unmapped | `NAMESPACE` | +| submap | emitted when a keybind submap changes. Empty means default. |`SUBMAPNAME` | {{< hint type=warning >}} A fullscreen event is not guaranteed to fire on/off once in succession.