Skip to content
This repository was archived by the owner on Oct 11, 2025. It is now read-only.

Commit 624e5a1

Browse files
authored
Update README.md
1 parent 8be5d2a commit 624e5a1

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ cat > ~/.config/fancylock/config.json << 'EOF'
5151
"image_display_time": 30,
5252
"background_color": "#000000",
5353
"blur_background": false,
54-
"media_player_cmd": "mpv"
54+
"media_player_cmd": "mpv",
55+
"pre_lock_command": "",
56+
"post_lock_command": ""
5557
}
5658
EOF
5759
```
@@ -172,7 +174,9 @@ fancylock -c /path/to/config.json
172174
"image_display_time": 30,
173175
"background_color": "#000000",
174176
"blur_background": false,
175-
"media_player_cmd": "mpv"
177+
"media_player_cmd": "mpv",
178+
"pre_lock_command": "pypr hide mywindow",
179+
"post_lock_command": "pypr show mywindow"
176180
}
177181
```
178182
</details>
@@ -186,6 +190,8 @@ fancylock -c /path/to/config.json
186190
- `include_images`: Whether to include images along with videos
187191
- `image_display_time`: How long to display each image in seconds
188192
- `media_player_cmd`: Command to use for playing media (default: mpv)
193+
- `pre_lock_command`: Execute this command before locking the screen.
194+
- `post_lock_command`: Execute this command after unlocking the screen.
189195

190196
Note: The configuration also includes `background_color` and `blur_background` options, but these are not currently implemented.
191197

@@ -194,25 +200,24 @@ Note: The configuration also includes `background_color` and `blur_background` o
194200
### What's Working
195201

196202
- ✅ X11 screen locking with PAM authentication
203+
- ✅ Basic hyprland support
197204
- ✅ Multi-monitor support with correct video positioning
198205
- ✅ Video and image playback during lock screen
199206
- ✅ Password entry with visual feedback (dots)
200207
- ✅ Keyboard and pointer grabbing to prevent bypass
201208
- ✅ Failed password attempt limiting
202-
- ✅ Embedded version metadata via `--version`
209+
- ✅ Embedded version metadata via `-v`
203210

204211
### What Needs Improvement
205212

206213
- ⚠️ Error handling in some edge cases
207214
- ⚠️ Password entry UI could be more polished
208-
- ⚠️ Video transition effects between media files
209215
- ⚠️ Memory optimization for long-running sessions
210216
- ⚠️ Better handling of system sleep/wake events
211217
- ⚠️ Auto-creation of default config file (if none exists)
212218

213219
## Future Implementations
214220

215-
- 🚧 Wayland support
216221
- 🚧 Configurable UI theme and appearance
217222
- 🚧 Blurred background option
218223
- 🚧 More interactive lock screen elements

0 commit comments

Comments
 (0)