Darkkal44/qylock

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

Welcome to Qylock! Pretty much a bunch of lockscreen themes I've put together for SDDM and Quickshell. Enjoyyyyyyy!!!!

Hope ya find something that fits your setup~

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

━━━━━━━ ❖ ━━━━━━━

Start by installing these dependencies using the package manager of your distro. (Note: Names might vary depending on your distribution.)

📦 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

━━━━━━━ ❖ ━━━━━━━

Start by installing these dependencies using the package manager of your distro. (Note: Names might vary depending on your distribution.)

📦 DEPENDENCIES

🚀 INSTALLATION

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

⌨️ SHORTCUT BINDING

Point your Window Manager keybind (e.g., in Hyprland, Qtile, Sway, or i3) directly to:

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

━━━━━━━ ❖ ━━━━━━━

A flake is provided for NixOS users — no sddm.sh / quickshell.sh needed. Themes live in the Nix store and the active theme is chosen declaratively.

🚀 USAGE

Add the input and import the module in your flake.nix:

{
  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
            };
          };
        })
      ];
    };
  };
}

For the Quickshell lockscreen, bind your WM keybind to qylock-lock (instead of ~/.local/share/quickshell-lockscreen/lock.sh). Pass a theme name as $1 to override on the fly: qylock-lock clockwork/tape.

📦 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?

If the virtual keyboard keeps opening on its own at startup, you can disable it in your SDDM config:

1. Open /etc/sddm.conf.d/virtualkeyboard.conf as root.
2. Under the [General] section, set InputMethod to empty:

[General]
InputMethod=

📺 Low quality background video?

To keep the download size small, some videos are compressed. For the full 4K/HD version:

1. Get the original video from the links in the Acknowledgements section.
2. Rename it to bg.mp4.
3. Replace the bg.mp4 inside your current theme's folder.

🛠️ 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.

If you encounter library errors at the login screen:

1. Re-run the installation script: ./sddm.sh.
2. When prompted, select the Qt5 (Legacy) option.
3. The script will automatically convert the themes and install the compatible versions for you.

❄️ 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.

━━━━━━━ ❖ ━━━━━━━

Pixel · Coffee	Pixel · Dusk City
Pixel · Hollow Knight	Pixel · Munchlax
Pixel · Night City	Pixel · Rainy Room
Pixel · Skyscrapers	Pixel · Cyberpunk
Pixel · Emerald	Pixel · Sakura
Pixel · Waterfall	Enfield
Sword	Forest
Winter	Dog Samurai
The Last of Us	Field
Girl · Coffee	Girl · Pillow
Man · Bicycle	Women · Umbrella
Nothing	Material You
Honkai: Star Rail	Genshin Impact
Wuthering Waves	osu!
osu! mania	Minecraft
NieR: Automata	Reverse: 1999 - I
Reverse: 1999 - II	Clockwork
Terraria	Ninja Gaiden
Windows 7

━━━━━━━ ❖ ━━━━━━━

Huge thanks to all the amazing artists for these wallpapers and fonts! Here's where everything comes from:

━━━━━━━ ❖ ━━━━━━━

━━━━━━━ ༓ ━━━━━━━

Make your login your own.