readme update

This commit is contained in:
2025-06-17 16:29:03 +02:00
parent 06642bd570
commit 4a04e95757

View File

@ -15,7 +15,6 @@
```
config.txt
click.wav
sound/
├─ 1.wav
├─ 2.wav
@ -25,6 +24,9 @@ sound/
├─ 6.wav
├─ 7.wav
├─ 8.wav
ui/
├─ click.wav
├─ beep.wav
```
@ -66,21 +68,31 @@ Json formatted config file. For now only edge led color working.
}
```
### click.wav
## Sound
Put a file called `click.wav` (not longer than a few seconds) in the root of the SD card and it will play when you press a button.
### UI
There are two UI sounds - `click.wav` and `beep.wav`.
- `click.wav` is played when a button is pressed other than the select button
- `beep.wav` is played when the rotary encoder select button is pressed
Put these files in the subfolder `ui` on the SD card.
#### Wave File Format for UI Sounds
`click.wav` needs to be **22050Hz (22kHz) 16bit Mono**
### Sounds
### Audio Out or Speakers
Put all sounds into the `/sound` subfolder. Name them `1.wav, 2.wav, 3.wav...`
## Wave File Format
#### Wave File Format for Audio Out and Speakers
Export all sounds except `click.wav` as **48000Hz (48kHz) 16bit Stereo**.
Export all sounds as **48000Hz (48kHz) 16bit Stereo**.
`click.wav` needs to be **22050Hz (22kHz) 16bit Mono**
### Audacity
@ -94,14 +106,14 @@ Download it here [Github](https://github.com/audacity/audacity/releases)
#### Format options in Audacity
**Sounds**
**Audio Out**
- WAV(Microsoft)
- Chanels: Stereo
- Samplerate: 48000Hz
- Encoding: Signed 16-bit PCM
**click.wav**
**UI**
- WAV(Microsoft)
- Channels: Mono