thyx - GitLite

KO | EN

gitlite — search

#javascript #go #linux #docker #macos #nodejs #awesome #kubernetes #vue #security #pytorch #ios #openai #open-source

thyx

(★ 339)

Exquisite SDDM greeter for Linux (infinitely customizable + safe atomic install/uninstall)

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
  - on-workflow-call-check-changes.yml
  - on-workflow-call-distro-smoke.yml
  - on-workflow-call-format.yml
  - on-workflow-call-lint.yml
  - on-workflow-call-nix.yml
  - on-workflow-call-shell-check.yml
  - on-workflow-dispatch-gentoo-smoke.yml
- CODEOWNERS
- ISSUES.md
- blush.jpg
- cinder.mp4
- gilded.jpg
- malachite.jpg
- README.md
- sakura.jpg
- guide.md
- OFL.txt
- PlusJakartaSans-Italic-VariableFont_wght.ttf
- PlusJakartaSans-VariableFont_wght.ttf
- restart.svg
- shutdown.svg
- sleep.svg
- blush.conf
- cinder.conf
- gilded.conf
- malachite.conf
- sakura.conf
- - _dev.deps.deb
  - deps.alpine-edge
  - deps.arch
  - deps.debian-bookworm
  - deps.debian-forky
  - deps.debian-sid
  - deps.debian-trixie
  - deps.fedora
  - deps.generic
  - deps.gentoo
  - deps.gentoo.use
  - deps.map
  - deps.opensuse-tumbleweed
  - deps.ubuntu-jammy
  - deps.ubuntu-noble
  - deps.ubuntu-resolute
  - install.commands
  - uninstall.commands
- - _common.sh
  - _constants.sh
  - _deps.sh
  - _repo.sh
  - _sddm.sh
  - _theme.sh
- install
- preview
- uninstall
- - Background.qml
  - BlurEffect.qml
- - SystemButtonsLayout.qml
- - qmldir
  - tokens.qml
- Main.qml
.qmllint.ini
default.nix
flake.lock
flake.nix
justfile
LICENSE
metadata.desktop
module.nix
README.md
rlyx.toml
theme.conf

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

# **_Thyx_**

<br/>
<p align="center">
  <a href="https://github.com/rccyx/thyx/actions/workflows/ci.yml">
    <img src="https://img.shields.io/github/actions/workflow/status/rccyx/thyx/ci.yml?branch=main&style=for-the-badge&color=black&labelColor=111111&logo=githubactions&logoColor=white" alt="CI Status"/>
  </a>
  <a href="#installation">
    <img src="https://img.shields.io/badge/Platform-Linux-black?logo=linux&logoColor=white&style=for-the-badge&labelColor=111111" alt="Platform: Linux"/>
  </a>
    <a href="https://github.com/rccyx/thyx">
    <img src="https://img.shields.io/github/repo-size/rccyx/thyx?style=for-the-badge&color=black&labelColor=111111&logo=github&logoColor=white" alt="Size"/>
  </a>
  <a href="https://github.com/rccyx/thyx/blob/main/LICENSE">
    <img src="https://img.shields.io/badge/License-MIT-black?logo=mit&logoColor=white&style=for-the-badge&labelColor=111111" alt="License: MIT"/>
  </a>
</p>

</div>

## Demo

<div align="center">
  <video title="demo" src="https://github.com/user-attachments/assets/85eaaf53-369d-4301-bc83-29367407abb7" width="100%" controls>
    Your browser does not support the video tag.
  </video>
</div>

## Presets

Ships with 5 total full visual systems.

4 static, and 1 dynamic.

Each one is a complete [preset](/presets/) with its own palette and [background](/backgrounds/).

The design system allows infinite customization, so you can also [create your own](#creating-your-own).

|                                                             **Gilded**                                                              |                                                             **Blush**                                                              |
| :---------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: |
| <img src="https://github.com/user-attachments/assets/160c90cf-a557-4d6b-ae78-9cb2703e5a11" width="100%" height="240" alt="Gilded"/> | <img src="https://github.com/user-attachments/assets/7a1be327-1097-4b7e-b860-c4b0ab94e3be" width="100%" height="240" alt="Blush"/> |

|                                                             **Malachite**                                                              |                                                             **Sakura**                                                              |
| :------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------: |
| <img src="https://github.com/user-attachments/assets/d0863369-cff9-40da-b516-554b149fcb6a" width="100%" height="240" alt="Malachite"/> | <img src="https://github.com/user-attachments/assets/256fc98a-fcbe-410e-b1ae-7d400e25ad66" width="100%" height="240" alt="Sakura"/> |

### Dynamic Preset (Cinder)

It supports video backgrounds.

<div align="center">
  <video title="demo" src="https://github.com/user-attachments/assets/2338a5a3-1ac6-4003-86b8-00bb3bc218f6" width="100%" controls>
    Your browser does not support the video tag.
  </video>
</div>

<details>
<summary><strong>Supported formats and guidelines</strong></summary>

<br/>

Video files can be used anywhere a background image is accepted and are rendered as full-screen, looped, ambient backgrounds.

#### Supported formats

- `mp4`
- `webm`
- `mkv`
- `mov`
- `m4v`
- `avi`

For maximum compatibility and reliability, **H.264-encoded MP4** is strongly recommended.

**For optimal results:**

- Keep videos short (~6–10 seconds)
- No audio
- Prefer 720p or 1080p
- Designed to loop infinitely.

</details>

## Guide

Want a fast mental model of what this is, what SDDM is, and how recovery works? Read [this](./docs/guide.md).

## Installation

Using **NixOS?**

<details>
<summary>Use the theme as a flake.</summary>

<br/>

```nix
{
  inputs = {
    thyx.url = "github:rccyx/thyx";
  };

outputs = { nixpkgs, thyx, ... }: {
    nixosConfigurations.host = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";

modules = [
        thyx.nixosModules.default

{
          services.displayManager.sddm.thyx.enable = true;
          services.displayManager.sddm.wayland.enable = true;
        }
      ];
    };
  };
}
```

Then rebuild.

```bash
sudo nixos-rebuild switch --flake .#host
```

That's it.

</details>
<br/>

Otherwise, the installer is atomic and idempotent and will auto setup everything with one command for the following:

- **Arch**

- **Fedora**

- **Ubuntu**
  - Jammy / 22.04
  - Noble / 24.04
  - Resolute / 26.04

- **Debian**
  - Bookworm
  - Trixie
  - Forky
  - Sid

- **Linux Mint**
- **Pop!\_OS**
- **Zorin**
- **openSUSE**
- **Gentoo**
- **Alpine**

Clone and run:

```bash
bash ./scripts/install
```

For non interactive installs, pass `--yes`.

```bash
bash ./scripts/install --yes
```

The installer is local, explicit, and idempotent. It validates the theme tree, installs missing runtime packages, checks required commands, stages the install atomically, writes the SDDM theme selection, and keeps the current session alive.

During setup, it prints the exact plan, asks for confirmation and sudo, installs end to end, and logs the run.

If you use another distro, have a look at the generic [package contract](/scripts/data/deps.generic) and map it through your package manager. The same install can be done manually by following the same steps of:

<details>
<summary><strong>What the installer does</strong></summary>

<br/>

It runs in this order.

1. finds the Thyx repo from the script path or current directory
2. detects the distro
3. selects the matching package manifest from [`scripts/data/deps.map`](./scripts/data/deps.map)
4. installs missing runtime packages from the selected manifest
5. verifies required shell commands, the SDDM greeter, runtime packages, and `fc-cache` when bundled fonts exist
6. prints the install plan
7. asks for confirmation and sudo
8. removes the previous fixed stage path at `/usr/share/sddm/themes/.thyx.stage` if exists
9. removes the previous fixed rollback path at `/usr/share/sddm/themes/.thyx.previous` if exists
10. creates a fresh stage directory at `/usr/share/sddm/themes/.thyx.stage`
11. copies the repo into the stage directory with `rsync --delete`
12. strips dev-only files from the staged install:
    - `.git/`
    - `.github/`
    - `fonts/` # installed system wide
    - `.qmllint.ini`
    - ...

13. validates the staged theme before activation
14. moves an existing `/usr/share/sddm/themes/thyx` to `/usr/share/sddm/themes/.thyx.previous` during activation
15. moves `/usr/share/sddm/themes/.thyx.stage` into `/usr/share/sddm/themes/thyx`
16. validates the activated theme
17. restores `/usr/share/sddm/themes/.thyx.previous` if activation or validation fails
18. removes `/usr/share/sddm/themes/.thyx.previous` after a successful activation
19. installs bundled fonts into `/usr/local/share/fonts/thyx`
20. refreshes the font cache
21. backs up `/etc/sddm.conf` once to `/etc/sddm.conf.thyx-back` when an existing config is present
22. writes `Current=thyx` under `[Theme]` in `/etc/sddm.conf`
23. enables SDDM when `systemctl` exists
24. verifies the installed theme, selected SDDM theme, metadata, config file, and fonts
25. prints a safe greeter test command
26. logs everything to `~/.cache/thyx/thyx-install-*.log`

After installation, the theme is at `/usr/share/sddm/themes/thyx`. This is where SDDM loads it from.

</details>

## Uninstallation

Thyx comes off as clean as if… **it never got in.**

Ships with a first-class [uninstall](/scripts/uninstall) script so you don’t brick your login screen or get left hanging.

It logs everything and prints a plan before proceeding.

Run it from the repo.

```bash
./scripts/uninstall
```

For non-interactive uninstall:

```bash
./scripts/uninstall --yes
```

<details>
<summary><strong>What the uninstaller does</strong></summary>

<br/>

It runs in this order.

- validates the repo tree
- verifies required uninstall commands
- prints a plan before touching anything
- asks for confirmation and sudo
- restores `/etc/sddm.conf` from `/etc/sddm.conf.thyx-back` when that backup exists
- otherwise removes `Current=thyx` from `/etc/sddm.conf`
- removes:
  - `/usr/share/sddm/themes/thyx`
  - `/usr/share/sddm/themes/.thyx.stage`
  - `/usr/share/sddm/themes/.thyx.previous`
  - `/usr/local/share/fonts/thyx`

- refreshes font cache when fonts were removed
- verifies that Thyx files are gone
- verifies that `/etc/sddm.conf` no longer selects `thyx`
- never restarts SDDM automatically
- logs everything to `~/.cache/thyx/thyx-uninstall-*.log`

</details>

When you’re ready to apply changes, restart SDDM from a TTY:

```bash
sudo systemctl restart sddm
```

> [!WARNING]
> Restarting SDDM will log you out of your current session!

Or reboot.

## Preview (no logout)

You can safely test edits using the preview command so you don’t get locked out and have to [recover](./docs/guide.md#recovery-protocol) via TTY.

```bash
./scripts/preview
```

Runs the SDDM greeter in test mode. Your session is untouched.

Close the window when done (your compositor’s normal close shortcut, for example `Alt+Q` on Hyprland).

## Configuration guide

All settings are in `theme.conf`. Edit, preview, repeat.

### Using a preset

From `/usr/share/sddm/themes/thyx`, copy any preset config from `presets/` over the main `theme.conf`.

```bash
cp presets/malachite.conf theme.conf
```

Preview it

```bash
./scripts/preview
```

When satisfied, restart SDDM

```bash
sudo systemctl restart sddm
```

Or reboot to take effect.

### Creating your own

You can create custom presets by duplicating an existing preset and modifying it.

```bash
cp presets/gilded.conf presets/my-custom.conf
cp presets/my-custom.conf theme.conf
./scripts/preview
```

Edit freely, keep as many presets as you want, and swap them by copying into `theme.conf`.

> [!TIP]
> You can wire a shell function or keybinds to switch presets instantly. I personally use `Alt + R` to rotate the login screen and matching [desktop](https://github.com/rccyx/osyx) themes.

## Fonts

Ships with **Plus Jakarta Sans**, and the installer installs it system wide for SDDM.

The `Font` setting in `theme.conf` must match the font family name exactly as your system registers it.

```ini
Font="Plus Jakarta Sans"
```

### Switching fonts

If you’ve installed additional fonts on your system, you can instruct the greeter to use a different one by updating the `Font` setting.

To see all available font families:

```bash
fc-list -f "%{family}\n" | sort -u
```

Then replace the `Font` value with the exact family name.

For example, if you have `Inter` already installed:

```ini
Font="Inter"
```

After changing fonts, rebuild the font cache:

```bash
sudo fc-cache -f -v
```

### Basic settings

| Setting                            | Description                                | Example                    |
| ---------------------------------- | ------------------------------------------ | -------------------------- |
| `Font`                             | System font family                         | `"Plus Jakarta Sans"`      |
| `FontSize`                         | Base font size in points                   | `"12"`                     |
| `Background`                       | Wallpaper or video path, relative to theme | `"backgrounds/gilded.jpg"` |
| `AllowUppercaseLettersInUsernames` | Username capitalization behavior           | `"true"`, `"false"`        |

### Time and date display

| Setting      | Description | Options                                       |
| ------------ | ----------- | --------------------------------------------- |
| `HourFormat` | Time format | `"HH:mm"` (24h), `"hh:mm AP"` (12h), `"long"` |
| `DateFormat` | Date format | `"dddd d MMMM"` gives `Thursday 29 August`    |

### Layout and form

| Setting        | Description               | Options                         |
| -------------- | ------------------------- | ------------------------------- |
| `FormPosition` | Login form position       | `"left"`, `"center"`, `"right"` |
| `Blur`         | Background blur intensity | `"0.0"` to `"1.0"`              |

### Animation

| Setting             | Description                     | Options                                 |
| ------------------- | ------------------------------- | --------------------------------------- |
| `AnimationDuration` | Hover or focus transition speed | `"80"`, `"120"`, `"300"`                |
| `AnimationEasing`   | Animation curve                 | `"OutQuart"`, `"OutCubic"`, `"OutBack"` |

### Colors

#### Text colors

- `DateTextColor` - Date display color
- `TimeTextColor` - Time display color
- `LoginFieldTextColor` - Username text
- `PasswordFieldTextColor` - Password text
- `PlaceholderTextColor` - Input placeholder text
- `LoginButtonTextColor` - Login button text
- `EnvironmentButtonTextColor` - Environment selector text
- `SystemButtonsIconsColor` - Power, restart, and sleep button icons and labels

#### Background colors

- `FormBackgroundColor` - Login form background
- `LoginFieldBackgroundColor` - Username input background
- `PasswordFieldBackgroundColor` - Password input background
- `LoginButtonBackgroundColor` - Login button background

#### Dropdown colors

- `DropdownTextColor` - Dropdown menu text
- `DropdownSelectedTextColor` - Selected item text
- `DropdownBackgroundColor` - Dropdown background
- `DropdownSelectedBackgroundColor` - Selected item background
- `DropdownBorderColor` - Dropdown border
- `DropdownSelectedBorderColor` - Selected item border

#### Hover effects

- `HoverLoginButtonBackgroundColor` - Login button on hover
- `HoverSystemButtonsIconsColor` - System buttons on hover
- `HoverEnvironmentButtonTextColor` - Environment button on hover

## Customization examples

### Change form position

```ini
FormPosition="center"
# or
FormPosition="right"
```

### Adjust colors for a dark theme

```ini
DateTextColor="#e0e0e0"
TimeTextColor="#ffffff"
FormBackgroundColor="#1a1a1a"
```

### Speed up animations

```ini
AnimationDuration="50"
AnimationEasing="OutCubic"
```

### Use a video background

```ini
Background="backgrounds/my-video.mp4"
```

Video backgrounds use the same `Background` setting as image backgrounds.

## Automatic fingerprint login

If your system uses PAM fingerprint authentication, it can start fingerprint login as soon as the screen appears.

```ini
AutoFingerprintOnLoad=true
```

When enabled, it automatically calls PAM’s fingerprint check on load and logs in as soon as the scan matches.

If fingerprint isn’t configured or fails, the greeter falls back to password login normally.

> [!IMPORTANT]
> PAM must already be [configured](https://wiki.archlinux.org/title/Fprint) for fingerprints in `/etc/pam.d/sddm` with `pam_fprintd.so`.

## Issues & Features

Read [this](./.github/ISSUES.md) first.

## License

MIT © @rccyx