Hyprdm Documentation

Hyprdm, or Hyprland Display Manager, is managed by HyprCommunity and distributed by Azccriminal. It is distributed under the BSL license and offers fully integrated support with Hyprland, while also adopting a minimalist and customizable architecture.

Hyprdm offers various interfaces with various features, such as Hyproman and Narval, as the default interfaces, and provides the infrastructure and support for optional use of these interfaces.

Hyprdm installation varies depending on the intended use. Thanks to its backend system, you can adapt the frontend structure to the backend with QML or other graphic libraries and interfaces. It optionally offers its own greeterd service system and support for a QML-based interface engine.

If using the RUST backend overlay ROB system:

cargo build --release

If using the FFI backend interface:

HDM_API_LIB_TYPE=c cargo build --release --workspace --features c_ffi

You can install the GUI API, the base Hyprdm API, by following these steps.

If installing Hyproman and Narval interfaces:

You need to install the FFI backend and Hyprdmgreeterd.

cd gui-api/greeterd

# If compiling with Makefile:
make
sudo make install

# If compiling with CMakeLists.txt:
mkdir build
cd build
cmake ..

If you want to install with ArchLinux:

yay -S hyprdm

We currently only offer package support for ArchLinux. We will soon offer support for all distributions.

1. While Hyprdm is based on Hyprland, it officially uses the Smithway Wayland API and runs on a wlroot-based Rust backend.
2. Hyprdm offers a fully customizable environment and provides the necessary interface support. You can build a Hyprdm-based interface by following the necessary documentation regarding interface configuration.
3. Hyprdm can work completely without Hyprland. Even if you encounter some integration issues, it's still possible to use it in any way.

The Rust Overlay Backend (ROB) system includes the following features:

• HOTP and TOTP support for user login, PAM, and 2FA.
• Customization based on Qt QuickShell patches or configurations.
• Rust and C++ support for developing graphical interfaces.
• Theme Manager Support: Full support for GTK and Qt themes, including custom theme support.
• Use the Hyprland Screen Manager as a session-based login manager with Sessiondm.
• Manage all window settings with the layout manager.

More advanced features will be added in the future.

You can build your own interface with the ROB system. If you've followed the ROB compilation instructions, you can build your own interface using different graphical libraries and interfaces using QML or your own greeterd system and the ROB backend.

Example interface instructions are posted on GitHub in QuickShell: Hyproman QML Example

If you're planning to build a Greeterd-like interface rendering system and are using an FFI backend, check out these examples: Greeterd Backend Header

If you are not using the FFI backend, you can create an interface compatible with the backend system by following the gui-api and hdm-api codes in the source code: HDM API Source

You can apply changes to the config with:

hyprdmconfigmanager --reload

If it's incorrect, it may give a warning and may not restart hyprdm via systemctl.

Start the greeter:

hyprdmgreeterd

You can use hyprdmgreeterd via systemctl. It reads QML files directly from the:

~/.config/quickshell
.local/share/quickshell