Darkkal44/qylock

ꜱᴅᴅᴍ  •  ǫᴜɪᴄᴋsʜᴇʟʟ  •  ɴɪxᴏs  •  ꜰᴀǫ  •  ɢᴀʟʟᴇʀʏ  •  ᴀᴄᴋɴᴏᴡʟᴇᴅɢᴇᴍᴇɴᴛꜱ  •  ᴄʀᴇᴅɪᴛꜱ

Important

Have a problem? Please check the FAQ before opening a new issue. Most common setup errors are already documented there!

📦 DEPENDENCIES

🚀 INSTALLATION

Note

These themes are made and tested only on arch linux, but the script will work in most of the distro's out there, so all you gotta do is get the dependencies right as its different for all the distros.

chmod +x sddm.sh && ./sddm.sh

📦 DEPENDENCIES

🚀 INSTALLATION

chmod +x quickshell.sh && ./quickshell.sh

⌨️ SHORTCUT BINDING

~/.local/share/quickshell-lockscreen/lock.sh

🚀 USAGE

{
  inputs.qylock.url = "github:Darkkal44/qylock";

  outputs = { self, nixpkgs, qylock, ... }: {
    nixosConfigurations.my-host = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        qylock.nixosModules.default
        ({ pkgs, ... }: {
          services.displayManager.sddm.enable = true;
          services.displayManager.sddm.wayland.enable = true;

          programs.qylock = {
            enable = true;
            theme = "nier-automata";          # any directory name under themes/
            # sddm.enable = true;             # installs theme + sets it active (default)
            # quickshell.enable = true;       # adds `qylock-lock` to PATH (default)

            # Optional per-theme tweaks (replaces the interactive prompts):
            themeOptions = {
              terraria.backgroundMode = "time";              # time | random | static
              Genshin.backgroundMode = "time";
              clockwork.orbital = { themeMode = "dark"; enableWindup = true; };
              osu.gameMode = "menu";                         # menu | game
            };
          };
        })
      ];
    };
  };
}

Important

To display Quickshell-based wallpapers on NixOS, make sure the following GStreamer packages are installed system-wide. Without these, background videos will fail to render.

{ config, pkgs, ... }: {
  environment.systemPackages = with pkgs; [
    gst_all_1.gstreamer
    gst_all_1.gst-plugins-base
    gst_all_1.gst-plugins-good
    gst_all_1.gst-plugins-bad
    gst_all_1.gst-plugins-ugly
  ];
}

Note

qt6.qtmultimedia is not required here — the qylock-lock wrapper already wires the QML import path. It is only needed if you invoke quickshell directly.

📦 OUTPUTS

Note

The flake pins nixos-unstable because quickshell isn't in stable nixpkgs yet. If your system tracks a stable channel, override the flake's nixpkgs input to your unstable channel.

Tip

Can't find your issue here? Feel free to open a discussion or an issue, but please double-check the sections below first!

⌨️ Virtual Keyboard popping up?

[General]
InputMethod=

📺 Low quality background video?

🛠️ Themes not loading (library import version error)?

Note

This error typically occurs because many stable distributions (like Debian or older Fedora versions) still use the Qt5-based version of SDDM. Since these themes are written in native Qt6 for modern systems, they require a specific transpilation step to work on legacy backends.

❄️ Quickshell not working on KDE Plasma?

Note

This is a known limitation of KWin. You can still use the SDDM portion of the themes for your login screen, but the Quickshell lockscreen itself is a no-go on Plasma because it lacks support for the ext-session-lock-v1 protocol.

Max • Awkward • Chương Kính • MerhawiGhebrekal • Silenett • wawzi • franchecol • MerhawiGhebrekal • Trench Martyr

Pumphium, kaizky, DragonChicken

Make your login your own.