Skip to content

Commit 6e10068

Browse files
authored
Update README.md
1 parent 1c75dad commit 6e10068

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,34 +18,39 @@ You can either use the latest executable release, or run the script itself. Both
1818

1919
## Running the executable
2020

21-
Download the [latest executable release](https://github.com/sophice/ahk-keyboard-locker/releases), place it anywhere you want, and run it!
22-
23-
Note: You cannot currently change the keyboard shortcut or password in the executable version. The keyboard shortcut to lock is Ctrl+Alt+K, and the password to unlock is "unlock".
21+
Download the [latest release](https://github.com/sophice/ahk-keyboard-locker/releases), place it where you want, and run `keyboard-locker.exe`.
2422

2523
## Running the .ahk script
2624

2725
1) Install [AutoHotkey](https://www.autohotkey.com/) version 1.x in order to run .ahk scripts. Not tested with AutoHotkey version 2.
28-
2) Download [the latest release](https://github.com/sophice/ahk-keyboard-locker/releases) and extract the files where you want.
26+
2) Download the [latest release](https://github.com/sophice/ahk-keyboard-locker/releases) and extract the files where you want.
2927
3) Run keyboard-locker.ahk.
3028
4) Lock the keyboard either by pressing the default shortcut "Ctrl+Alt+k", or by right clicking on the tray icon and selecting "Lock keyboard".
3129
5) Unlock the keyboard either by typing the default password "unlock", or by right clicking on the tray icon and selecting "Unlock keyboard".
3230

33-
The keyboard shortcut and password can be changed by editing keyboard-locker.ahk.
31+
# Settings
32+
33+
Various settings can be changed by editing `settings.ini`. The file contains explanations for each setting.
34+
35+
- keyboard shortcut and password
36+
- disable keyboard shortcut or password
37+
- disable tray notifications
38+
- automatically lock on open
39+
- automatically exit on unlock
40+
- lock mouse as well
3441

3542
# Known issues
3643

3744
- Some media keys or Windows shortcuts may not be blocked.
38-
- Some keys (especially modifiers) may get "stuck" after typing the unlock password, requiring you to press them again to get them unstuck.
45+
- Some keys (especially modifiers) may get "stuck" after unlocking, requiring you to press them again to get them "unstuck".
3946
- There is sometimes a slight delay after typing the password before the keyboard is unlocked.
4047

4148
Feel free to submit a PR if you have improvements for these issues!
4249

4350
# Potential future improvements
4451

45-
- Better configuration: command line parameters to customize the script on run, and a config file to provide your own defaults.
4652
- Stealth mode: hide the tray icon and disable tooltips on lock, making it slightly more difficult to bypass the script.
4753
- Temporary password: change the password at run time to avoid using the one that is readable in the script itself.
48-
- Lock the mouse: lock the mouse, keyboard, or both.
4954
- Unlock timer: automatically unlock after a period of time.
5055
- Inactivity lock: automatically lock after a period of inactivity.
5156
- Scheduled lock: automatically lock and unlock on a schedule.

0 commit comments

Comments
 (0)