Darkkal44/qylock — Gitpedia

<img src="./Assets/title.png" alt="qylock" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.5);"/> <a href="#sddm-setup"><img src="https://img.shields.io/badge/SDDM-black?style=for-the-badge&color=7aa2f7&labelColor=1a1b26&logo=linux&logoColor=white"/></a> <a href="#quickshell-setup"><img src="https://img.shields.io/badge/QUICKSHELL-black?style=for-the-badge&color=bb9af7&labelColor=1a1b26&logo=qt&logoColor=white"/></a> <a href="https://github.com/Darkkal44/qylock/stargazers"><img src="https://img.shields.io/github/stars/Darkkal44/qylock?style=for-the-badge&color=9ece6a&labelColor=1a1b26&logo=github&logoColor=white"/></a> <a href="https://github.com/Darkkal44/qylock"><img src="https://img.shields.io/github/repo-size/Darkkal44/qylock?style=for-the-badge&color=e0af68&labelColor=1a1b26&logo=git&logoColor=white"/></a> <div align="center"> <pre> <a href="#sddm-setup">ꜱᴅᴅᴍ</a> • <a href="#quickshell-setup">ǫᴜɪᴄᴋsʜᴇʟʟ</a> • <a href="#nixos-setup">ɴɪxᴏs</a> • <a href="#faq">ꜰᴀǫ</a> • <a href="#gallery">ɢᴀʟʟᴇʀʏ</a> • <a href="#acknowledgements">ᴀᴄᴋɴᴏᴡʟᴇᴅɢᴇᴍᴇɴᴛꜱ</a> • <a href="#credits">ᴄʀᴇᴅɪᴛꜱ</a> </pre> </div> <img src="https://img.shields.io/badge/-HELLO%20THERE!!-e0af68?style=for-the-badge&labelColor=1a1b26&logo=coffeescript&logoColor=white" height="60" /> 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

	Packages
Core	`sddm` `qt6-declarative` `qt6-5compat` `qt6-svg`
Video	`qt6-multimedia` `qt6-multimedia-ffmpeg`
GStreamer	`gst-plugins-base` `gst-plugins-good` `gst-plugins-bad` `gst-plugins-ugly`
Optional	`fzf`

<details> <summary>View Font Requirements</summary>

Some themes rely on fonts that cannot be bundled here (copyright issues). Download the font and drop it into themes/<theme_name>/font/ — it loads automatically.

Theme	Font	Filename
NieR: Automata	FOT-Rodin Pro DB	`FOT-Rodin Pro DB.otf`
Terraria	Andy Bold	`Andy Bold.ttf`
Genshin Impact	HYWenHei-85W	`zhcn.ttf`
Sword	The Last Shuriken	`The Last Shuriken.ttf`
Minecraft	Minecraft Regular	`minecraft.ttf`
Honkai: Star Rail	DIN Next	`font.ttf`
osu!	Torus Regular	`Torus Regular.otf`

</details>

🚀 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.

sh
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

	Packages
Core	`quickshell` `qt6-declarative` `qt6-5compat`
Video	`qt6-multimedia` `qt6-multimedia-ffmpeg`
GStreamer	`gst-plugins-base` `gst-plugins-good` `gst-plugins-bad` `gst-plugins-ugly`
Optional	`fzf`

🚀 INSTALLATION

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

⌨️ SHORTCUT BINDING

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

sh
~/.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:

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

Output	Purpose
`packages.<sys>.qylock-sddm-themes`	SDDM themes under `share/sddm/themes/`
`packages.<sys>.qylock-quickshell`	`qylock-lock` wrapper with Qt6 QML deps wired in
`devShells.<sys>.default`	`quickshell`, qt6, gstreamer, fzf — to run the bash scripts locally
`nixosModules.default`	`programs.qylock.*` options shown above

[!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:

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

ini
[General]
InputMethod=

📺 Low quality background video?

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

Get the original video from the links in the Acknowledgements section.
Rename it to bg.mp4.
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:

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

	Required Packages (Qt5 Legacy Mode)
Core	`sddm` `qt5-declarative` `qt5-graphicaleffects` `qt5-quickcontrols2`
Video	`qt5-multimedia` `gst-plugins-base` `gst-plugins-good` `gst-plugins-bad` `gst-plugins-ugly`
Tools	`perl`

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

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

<img src="https://img.shields.io/badge/-GALLERY-9ece6a?style=for-the-badge&labelColor=1a1b26&logo=unsplash&logoColor=white" height="60" /> <div align="center"> <table style="border-collapse: collapse; border: none;"> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Coffee <img src="./Assets/pixel_coffee.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Dusk City <img src="./Assets/pixel_dusk_city.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Hollow Knight <img src="./Assets/pixel_hollowknight.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Munchlax <img src="./Assets/pixel_munchlax.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Night City <img src="./Assets/pixel_night_city.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Rainy Room <img src="./Assets/pixel_rainyroom.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Skyscrapers <img src="./Assets/pixel_skyscrapers.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Cyberpunk <img src="./Assets/pixel-cyberpunk.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Emerald <img src="./Assets/pixel-emerald.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Sakura <img src="./Assets/pixel-sakura.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Pixel · Waterfall <img src="./Assets/pixel-waterfall.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Enfield <img src="./Assets/enfield.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Sword <img src="./Assets/sword.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Forest <img src="./Assets/forest.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Winter <img src="./Assets/winter.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Dog Samurai <img src="./Assets/dog_samurai.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> The Last of Us <img src="./Assets/the_last_of_us.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Field <img src="./Assets/field.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Girl · Coffee <img src="./Assets/girl_coffee.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Girl · Pillow <img src="./Assets/girl_pillow.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Man · Bicycle <img src="./Assets/man_bicycle.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Women · Umbrella <img src="./Assets/women_umbrella.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Nothing <img src="./Assets/nothing.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Material You <img src="./Assets/material-you.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Honkai: Star Rail <img src="./Assets/star_rail.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Genshin Impact <img src="./Assets/genshin.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Wuthering Waves <img src="./Assets/wuwa.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> osu! <img src="./Assets/osu.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> osu! mania <img src="./Assets/osumania.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Minecraft <img src="./Assets/minecraft.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> NieR: Automata <img src="./Assets/nier_automata.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Reverse: 1999 - I <img src="./Assets/R1999_1.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Reverse: 1999 - II <img src="./Assets/R1999_2.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Clockwork <img src="./Assets/clockwork.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Terraria <img src="./Assets/terraria.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> Ninja Gaiden <img src="./Assets/ninja_gaiden.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> </tr> <tr> <td align="center" width="50%" style="padding: 15px; border: none;"> Windows 7 <img src="./Assets/win7.gif" width="100%" style="border-radius: 12px; box-shadow: 0 4px 15px rgba(0,0,0,0.3);"/> </td> <td align="center" width="50%" style="padding: 15px; border: none;"> </td> </tr> </table> </div> ━━━━━━━ ❖ ━━━━━━━

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

Theme	Wallpaper	Font	Theme	Wallpaper	Font
Pixel · Coffee	MoeWalls	Pixelify Sans	Pixel · Munchlax	MoeWalls	Pixelify Sans
Pixel · Dusk City	WallsFlow	Pixelify Sans	Pixel · Night City	WallsFlow	Pixelify Sans
Pixel · Hollow Knight	MoeWalls	Pixelify Sans	Pixel · Rainy Room	MoeWalls	Pixelify Sans
Pixel · Skyscrapers	WallsFlow	Pixelify Sans	Pixel · Cyberpunk	-	Pixelify Sans
Pixel · Emerald	-	Pixelify Sans	Pixel · Sakura	-	Pixelify Sans
Pixel · Waterfall	-	Pixelify Sans	Enfield	WallsFlow	Orbitron
Sword	WallsFlow	The Last Shuriken	The Last of Us	MoeWalls	Outfit
Field	MoeWalls	-	Girl · Coffee	MoeWalls	-
Girl · Pillow	MoeWalls	Itim	Man · Bicycle	MoeWalls	Itim
Women · Umbrella	MoeWalls	Itim	Forest	MoeWalls	Figtree
Winter	MoeWalls	Orbitron	Dog Samurai	MoeWalls	Orbitron
Honkai: Star Rail	YouTube	DIN Next	Genshin Impact	YouTube	HYWenHei
Wuthering Waves	YouTube	Orbitron	osu!	Official	Torus Regular
osu! mania	Official	Torus Regular	Minecraft	Minecraft Wiki	Minecraft
NieR: Automata	Reddit	FOT-Rodin Pro DB	Reverse: 1999	Taptap	Outfit
Clockwork	WallsFlow	Orbitron	Terraria	Terraria Forums	Andy Bold
Ninja Gaiden	Noisy Pixel	Tektur	Windows 7	WallpaperAccess	Segoe UI

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

💖 SUPPORTERS

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

🛠️ SPECIAL THANKS

Pumphium, kaizky, DragonChicken

</div> ━━━━━━━ ༓ ━━━━━━━ <div align="center"> Make your login your own. <a href="https://ko-fi.com/darkkal"> <img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Support me on Ko-fi"> </a> </div>