feat: Add a lot more features
CI / build-ubuntu (, default) (push) Has been cancelled
CI / build-ubuntu (--features networking, networking) (push) Has been cancelled
CI / build-ubuntu (--no-default-features, no-default-features) (push) Has been cancelled
CI / build-debian (push) Has been cancelled
CI / build-fedora (push) Has been cancelled
CI / build-arch (push) Has been cancelled
CI / build-opensuse (push) Has been cancelled

- Add new system.rs module for system monitoring via D-Bus:
  - Battery status (UPower)
  - Media player controls and metadata (MPRIS)
  - WiFi/Bluetooth status (NetworkManager)
  - Keyboard layout tracking
- Add media key support (XF86 Play/Pause/Next/Prev)
- Add function keys F1-F3 for Suspend/Reboot/PowerOff
- Replace deprecated timer.rs with async system management
- Add GitHub Actions CI/CD workflows (CI + Release)
- Update dependencies and add optional networking feature
This commit is contained in:
2026-03-16 14:12:43 +01:00
parent 1dc4d68cf7
commit f489a6e46e
15 changed files with 3582 additions and 829 deletions
+85 -20
View File
@@ -2,7 +2,6 @@
[![License](https://img.shields.io/badge/license-AGPL--3.0%2B-blue.svg)](https://github.com/yourusername/rustlock/blob/main/LICENSE)
[![Version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://github.com/yourusername/rustlock/releases)
[![Updated](https://img.shields.io/badge/updated-2026--03--07-blue.svg)](https://github.com/yourusername/rustlock/commits/main)
A high-performance Wayland screen locker written in Rust, inspired by `swaylock-effects`.
@@ -10,26 +9,40 @@ A high-performance Wayland screen locker written in Rust, inspired by `swaylock-
## ✨ Features
-**Performance**: Written in safe Rust with minimal dependencies
-**Performance**: Written in safe Rust, optimized binary size (~2.4MB without networking, ~4MB with)
- 🎨 **Visual Effects**:
- Gaussian blur (configurable radius and passes)
- Vignette effect (configurable base and factor)
- Pixelate, Swirl, and Melting effects
- Smooth fade-in animation
- 🔐 **Password Indicator**:
- Circular ring with configurable radius and thickness
- Dynamic key highlight segments that rotate with each keystroke
- Customizable colors (ring, inside, separator, highlight)
- Caps lock indicator
- 🕐 **Information Display**:
- Centered clock (HH:MM format)
- Full date
- System uptime
- 📻 **Media & System Status** (optional):
- MPRIS media player integration with album art
- Battery percentage and charging status
- WiFi SSID and signal strength
- Bluetooth connected devices
- Keyboard layout indicator
- 🔑 **Session Management**:
- F1: Suspend
- F2: Reboot
- F3: Power Off
- 📸 **Screenshot Support**:
- Captures desktop background before locking
- Applies visual effects to background
- 🔑 **Authentication**:
- Custom background image support
- 🔐 **Authentication**:
- PAM-based authentication
- Configurable grace period (any key press within N seconds unlocks without password)
- 📝 **Logging**: Verbose debug logs written to `~/.rustlock.log`
- 🎯 **Customization**:
- Custom icons for WiFi, Bluetooth, Battery
- Theme presets (dark, light, nord, dracula)
- Configuration via config file or CLI
---
@@ -61,67 +74,119 @@ rustlock \
--fade-in 0.2
```
### Session Controls
When locked, use function keys to control the system:
- **F1**: Suspend to RAM
- **F2**: Reboot
- **F3**: Power Off
---
## ⚙️ Configuration
Options can be provided via command line or a configuration file at `~/.config/rustlock/config.toml`. CLI arguments take precedence.
Options can be provided via command line or a configuration file at `~/.config/rustlock/config.toml`. CLI arguments take precedence over config file, which takes precedence over theme defaults.
### Options
| Option | Description |
|--------|-------------|
| **General** | |
| `--screenshots` | Capture desktop background before locking |
| `--image <PATH>` | Use custom background image instead of screenshot |
| `--clock` | Display centered clock and date |
| `--indicator` | Show password entry ring (default: true) |
| `--indicator-radius <N>` | Ring radius in pixels (default: 100) |
| `--indicator-thickness <N>` | Ring thickness in pixels (default: 7) |
| **Effects** | |
| `--effect-blur <R>x<P>` | Gaussian blur: radius x passes (e.g., `7x5`) |
| `--effect-pixelate` | Pixelate effect |
| `--effect-swirl` | Swirl distortion effect |
| `--effect-melting` | Melting distortion effect |
| `--effect-vignette <B>:<F>` | Vignette: base:factor (e.g., `0.5:0.5`) |
| **Colors** | |
| `--ring-color <RRGGBB[AA]>` | Outer ring color (hex, optional alpha) |
| `--key-hl-color <RRGGBB[AA]>` | Key highlight segment color |
| `--line-color <RRGGBB[AA]>` | Separator line color |
| `--inside-color <RRGGBB[AA]>` | Inner circle color |
| `--separator-color <RRGGBB[AA]>` | Ring separator color |
| **Display Options** | |
| `--show-media` | Show MPRIS media info (default: true) |
| `--show-battery` | Show battery status (default: true) |
| `--show-network` | Show WiFi status (default: true) |
| `--show-bluetooth` | Show Bluetooth status (default: true) |
| `--show-keyboard-layout` | Show keyboard layout indicator (default: true) |
| `--show-album-art` | Show album art (default: true) |
| **Custom Icons** | |
| `--wifi-icon <PATH>` | Custom WiFi icon (PNG/SVG) |
| `--bluetooth-icon <PATH>` | Custom Bluetooth icon (PNG/SVG) |
| `--battery-icon <PATH>` | Custom battery icon (PNG/SVG) |
| **Other** | |
| `--grace <SECONDS>` | Grace period in seconds (default: 2) |
| `--fade-in <SECONDS>` | Fade-in animation duration (default: 0.2) |
| `--pam-service <NAME>` | PAM service name (default: "rustlock") |
| `--config <PATH>` | Path to config file |
| `--theme <NAME>` | Theme preset: dark, light, nord, dracula |
| `--debug` | Enable debug logging |
| `--log-file` | Write logs to `~/.rustlock.log` |
| `--temp-screenshot` | Enable peek feature (press 'p' to temporarily show background) |
---
## 📦 Installation
### Using Nix (Recommended)
```bash
nix-shell -p rustlock
```
Or with flakes:
```bash
nix run github:yourusername/rustlock
```
### From Source
```bash
cargo build --release
```
The binary will be available at `target/release/rustlock`.
### Build Options
- **With networking** (default): Includes reqwest for album art fetching
```bash
cargo build --release --features networking
```
- **Without networking**: Smaller binary (~2.4MB)
```bash
cargo build --release --no-default-features
```
---
## ✅ Completed
- [x] PAM-based authentication
- [x] Grace period (any key unlocks within N seconds)
- [x] Screenshot capture with blur/vignette effects
- [x] Configuration file support (`~/.config/rustlock/config.toml`)
- [x] Screenshot capture with blur/vignette/pixelate/swirl/melting effects
- [x] Configuration file support (`~/.config/rustlock/config.toml`) with schema validation
- [x] Debug logging to `~/.rustlock.log`
- [x] Clock and date display
- [x] Password indicator ring with rotating highlights
## 🚧 TODO
- [ ] Don't hardcode screen resolution (detect dynamically)
- [ ] Add multi-monitor support (handle multiple outputs)
- [ ] Automatically install PAM configuration file
- [ ] Configuration file schema validation
- [ ] Additional visual effects (pixelate, swirl, etc.)
- [ ] Theme/profile support with presets
- [ ] Wayland protocol stability updates
- [x] Dynamic screen resolution detection
- [x] Full multi-monitor support with different resolutions
- [x] Theme/profile support with presets (dark, light, nord, dracula)
- [x] Wayland protocol stability fixes
- [x] Media control integration (MPRIS support with Album Art)
- [x] Battery, WiFi, and Bluetooth status indicators
- [x] Custom background image support
- [x] Custom icons for status indicators
- [x] Keyboard layout indicator
- [x] Session management (F1-F3 keys)
- [x] Caps lock indicator
---