Files
omarchycn/default/agents/skills/omarchy/hyprland.md
T
6ee243cc37 Split the end-user omarchy skill into topic guides (#6602)
* Split the end-user omarchy skill into topic guides

Move default/omarchy-skill to default/agents/skills/omarchy and break the
monolithic SKILL.md into on-demand topic files for Hyprland config, shell
plugins, theming, and hooks. Update the skill symlink wiring, relink
existing installs through a migration, and correct claims that had drifted
from the implementation: plugin hot-reload, terminal reload, menu
customization, refresh scopes, theme overlays, background locations, hook
timing, and the packaged (not git-managed) system directory.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Add capture and contributing guides to the omarchy skill

Cover screenshots, screen recording, OCR text capture, and LocalSend or
Taildrop sharing, plus how to route bug reports, suggestions, and support
questions upstream with diagnostics and captures of the problem attached.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Scope Hyprland reload guidance to the Lua config files

hyprsunset.conf and xdph.conf are read by separate processes, so hyprctl
neither applies nor validates them. Document restarting hyprsunset after
editing its config, including in the night light example.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-07 14:36:42 +02:00

3.3 KiB

Hyprland Configuration

Read this before changing keybindings, monitors, window rules, or any other Hyprland (window manager) configuration.

Omarchy configures Hyprland in Lua. User files are loaded after Omarchy's defaults, so overrides go here:

~/.config/hypr/
├── hyprland.lua       # Main config (loads Omarchy defaults, then user files)
├── bindings.lua       # Keybindings
├── monitors.lua       # Display configuration
├── input.lua          # Keyboard/mouse settings
├── looknfeel.lua      # Appearance (gaps, borders, animations)
├── autostart.lua      # Startup applications
├── hyprsunset.conf    # Night light / blue light filter
└── xdph.conf          # Screen sharing / desktop portal

Key behaviors (the .lua files):

  • Hyprland auto-reloads on config save (no restart needed for most changes)
  • Use hyprctl reload to force reload
  • After ANY Hyprland Lua config change, validate with hyprctl reload followed by hyprctl configerrors
  • If hyprctl configerrors reports errors, address them and rerun validation until clean or until a real blocker is identified
  • Use omarchy refresh hyprland to reset the Lua config files to defaults

The two .conf files are read by separate processes, so hyprctl neither applies nor validates them:

  • hyprsunset.conf (night light): apply changes with omarchy restart hyprsunset; reset with omarchy refresh hyprsunset
  • xdph.conf (screen-sharing portal): applies when the portal restarts, e.g. on next login

Keybindings

Edit ~/.config/hypr/bindings.lua. Format:

o.bind("SUPER + SHIFT + R", "SSH", "alacritty -e ssh your-server")
o.bind("SUPER + B", "Browser", { launch = "chromium" })  -- launch wraps with uwsm-app

View current bindings: omarchy menu keybindings --print

IMPORTANT: When re-binding an existing key:

  1. First check existing bindings: omarchy menu keybindings --print
  2. If the key is already bound, you MUST call hl.unbind(...) BEFORE the new o.bind(...)
  3. Inform the user what the key was previously bound to

Example - rebinding SUPER+F (which is bound to fullscreen by default):

-- Unbind existing SUPER+F (was: fullscreen)
hl.unbind("SUPER + F")
-- New binding for file manager
o.bind("SUPER + F", "File manager", { launch = "nautilus" })

Always tell the user: "Note: SUPER+F was previously bound to fullscreen. I've added an unbind to override it."

Display/Monitors

Edit ~/.config/hypr/monitors.lua. Format:

hl.monitor({ output = "eDP-1", mode = "1920x1080@60", position = "0x0", scale = 1 })
hl.monitor({ output = "HDMI-A-1", mode = "2560x1440@144", position = "1920x0", scale = 1 })

List monitors and supported modes: hyprctl monitors all

Window Rules

CRITICAL: Hyprland window rules syntax changes frequently between versions.

Before writing ANY window rules, you MUST fetch the current documentation from the official Hyprland wiki:

DO NOT rely on cached or memorized window rule syntax. The format has changed multiple times and using outdated syntax will cause errors or unexpected behavior.

Window rules go in ~/.config/hypr/hyprland.lua or a required Lua module. Prefer Omarchy's o.window(match, rules) helper — see examples in $OMARCHY_PATH/default/hypr/windows.lua.