DOCSEARCHbyAlgolia
Submit Docs

Hyprland Wiki

repository·main·Indexed 19 days ago

https://github.com/hyprwm/hyprland-wiki

Official documentation for Hyprland, a Wayland compositor. Includes guides on Lua-based configuration (since version 0.55), animation tree hierarchy using hl.animation(), custom Bezier and Spring curves, environment variable management via hl.env(), and event callback scripting with hl.on(). Provides details on Wayland vs Xorg, NVIDIA support, and troubleshooting steps.

Tokens
99K
Snippets
310
Records
451
Agent score
65%

What's inside Hyprland Wiki

  2. Overview of wallpaper utilities for Hyprland

    main

    There are several ways to manage wallpapers on Hyprland depending on your needs:

    Static Wallpapers

    • hyprpaper: The official wallpaper utility from the Hypr development team. Highly integrated with the ecosystem.
    • swaybg: A lightweight, simple utility ideal if you only need a single static wallpaper.

    Animated and Video Wallpapers

    • wpaperd: A daemon that supports automatic wallpaper changing and advanced features.
    • mpvpaper: A wrapper for mpv that allows you to play video files as your desktop wallpaper.
      • Tip: Use mpvpaper-stop to pause the video when the application is in the background to save battery and resources.
    • awww: An efficient animated wallpaper daemon that can be controlled at runtime, allowing wallpaper changes without restarting the daemon.

    Wallpaper Managers (GUI/TUI)

    • waypaper (GUI): A graphical manager to visually select static or animated wallpapers. It supports swaybg and awww as backends.
    • wallrizz (TUI): A terminal user interface manager for visually choosing and applying wallpapers. It supports awww, hyprpaper, and other backends.

  3. Overview of Wayland Status Bar Options

    main

    When choosing a status bar for Hyprland, options range from simple pre-configured bars to complex widget systems requiring code:

    Simple Status Bars

    • Waybar: GTK-based, highly configurable via JSON/CSS, industry standard for wlroots.
    • ashell: Rust-based (iced), ready-to-use out of the box with essential modules (workspaces, battery, etc.), but has limited configuration depth.
    • Noctalia: A minimal desktop shell built on Quickshell with extensive theming and plugin support.

    Widget Systems (Custom Layouts)

    Use these when you need fully custom menus and layouts. These require programming knowledge.

    SystemUI ToolkitConfig LanguageNotes
    AGS/AstalGTK 3/4JS(X)/TSHigh flexibility via GObject Introspection; includes Network/Bluetooth libraries.
    EwwGTK 3Yuck (Lisp)Rust-based; supports SCSS; relies heavily on external scripts.
    QuickshellQtQMLQt-based; advanced Hyprland integration (live window previews); auto-reloads config.

  5. Explore the Hypr Ecosystem apps and libraries

    main

    The Hypr Ecosystem consists of various user-facing applications, utilities, and developer libraries designed to work with Hyprland.

    Note: Documentation for these projects typically targets the latest _-git branch of the respective applications.

    User Apps and Utilities

    These are standalone tools for desktop management, such as wallpaper management (hyprpaper), color picking (hyprpicker), idle management (hypridle), and screen locking (hyprlock).

    Dev Libraries and Toolkits

    These are low-level libraries and toolkits used for building Hyprland-compatible software, including configuration language parsing (hyprlang), cursor handling (hyprcursor), and Wayland protocol scanning (hyprwayland-scanner).

  8. Use HyprTile (Mega-Launcher for Hyprland)

    main

    HyprTile is a lightweight, feature-rich Mega-Launcher for Hyprland. It includes several integrated features:

    • App grid and flexible per-app configuration
    • Integrated music search and notes system
    • Screenshot and screen recording (full screen or selected area)
    • System monitor and volume control
    • Visual effects like starfield backgrounds

  9. Explore external Hyprland utilities and ecosystem tools

    main

    The following third-party projects provide specialized functionality for Hyprland users:

    Workspace & Window Management

    • split-monitor-workspaces: Provides Awesome-like workspaces.
    • snappy-switcher: A fast, animated Alt+Tab window switcher written in C.

    Input & Keybinds

    • hyprland-per-window-layout: Enables per-window keyboard layouts.
    • hyprKCS: A fast, minimal keybind manager written in Rust/GTK4.

    Development & IPC

    • hyprland-rs: A Rust wrapper for Hyprland's IPC.

    Monitor Configuration

    • Monique: A graphical monitor configurator with drag-and-drop layouts, a profile system, and a hotplug daemon for automatic configuration.

    General Wayland Resources

    • We Are Wayland Now: A website detailing useful Wayland applications (docks, email clients, etc.) and compatibility information.

  10. Use hyprpolkitagent for GUI privilege escalation

    main

    What is hyprpolkitagent?

    hyprpolkitagent is a polkit authentication daemon. It is required for GUI applications to request elevated privileges (e.g., when a program needs root access via a graphical prompt).

    Installation

    If hyprpolkitagent is not available in your distribution's repositories, you can:

    1. Build it from source.
    2. Use a different polkit agent (for example, polkit-kde-agent-1).