1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-14 04:00:30 +00:00

Mention audio formats in speaker help

Closes #1133. I'm not super happy about any of the versions proposed
there, but I think this is better than nothing.

Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
This commit is contained in:
Jonathan Coates 2022-09-11 14:57:45 +01:00
parent d22e138413
commit 61ac48c99f
No known key found for this signature in database
GPG Key ID: B9E431FF07C98D06

View File

@ -1,5 +1,9 @@
The speaker program plays audio files using speakers attached to this computer.
It supports audio files in a limited number of formats:
* DFPWM: You can convert music to DFPWM with external tools like https://music.madefor.cc.
* WAV: WAV files must be 8-bit PCM or DFPWM, with exactly one channel and a sample rate of 48kHz.
## Examples:
- `speaker play example.dfpwm left` plays the "example.dfpwm" audio file using the speaker on the left of the computer.
- `speaker stop` stops any currently playing audio.
* `speaker play example.dfpwm left` plays the "example.dfpwm" audio file using the speaker on the left of the computer.
* `speaker stop` stops any currently playing audio.