Keyboard Foley

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# Keyboard Foley

Add sound to ordinary typing with three original synthesized themes. Letters,
numbers, punctuation, and Tab use three alternating samples per theme. Space,
Enter, and Backspace each have a distinct sound.

| Theme | Sound design |
|---|---|
| Mechanical | Short switch clicks, a low case resonance, and a light return tick. |
| Typewriter | A sharper impact, metallic resonances, and a two-part mechanism sound. |
| Soft Pop | Rounded, falling-pitch pops with a muted noise attack. |

## Start and control

Requires Rebind Engine 3.5.0 or newer on Windows or macOS. Rebind Link is not
required. See [platform support](https://docs.rebind.gg/concepts/platforms)
for capture requirements.

Open the package's `main.luau` in Rebind and start it from the editor toolbar.
For development, run `rebind run library/keyboard-foley` from the repository
root. Open **Options** to change the theme, volume, or shortcut-sound setting.
Settings save automatically and apply while running.

- **F8** mutes or unmutes this package.
- **F9** cycles Mechanical, Typewriter, and Soft Pop.
- **Volume** starts at 35%. Set it to 0% for silence.
- **Sound with Ctrl, Alt, Cmd, or Win** is off by default. Shifted typing
  still makes sound.

F8 and F9 are reserved while the script runs, including while muted. Other keys
keep their normal behavior. Modifier keys by themselves, navigation keys,
function keys, and mouse buttons are silent. Holding a key does not produce
a sound for each operating-system repeat.

Stop the script from the editor or press Ctrl+C in its development terminal.
To stop every script and release held input, press **Left Ctrl + Left Alt + K**.
Keyboard Foley itself never presses or holds a key.

## Samples and privacy

The 18 samples are original procedural synthesis, not recordings or borrowed
sound packs. `tools/synth.py` generates 48 kHz, mono, 16-bit PCM WAV files using
only Python's standard library. To regenerate them from the repository root:

```sh
python3 library/keyboard-foley/tools/synth.py
```

The runtime opens only its bundled sounds. It does not save typed text, keep
keystroke history, use the clipboard, execute commands, or access the network.
Sound plays for captured typing in any application, including password fields;
the script cannot identify sensitive fields. Mute it when sound is unwanted.

## Limits and verification

At most 12 sounds overlap. If another begins at that limit, the oldest stops.
Finished sound handles are released, and muting or stopping ends active sounds.
An audio error mutes the package and records the reason in Logs. Correct the
problem and press F8 to retry.

Playback uses the host's default audio output. Output-device changes and audio
latency need live verification on each platform. Sound quality cannot be
established by source checks alone. Listing artwork is an illustration, not a
screenshot or evidence of execution.