From 61ac48c99f5a650c088ff752ce27f9079c64d4b9 Mon Sep 17 00:00:00 2001 From: Jonathan Coates Date: Sun, 11 Sep 2022 14:57:45 +0100 Subject: [PATCH] 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 --- .../resources/data/computercraft/lua/rom/help/speaker.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/main/resources/data/computercraft/lua/rom/help/speaker.md b/src/main/resources/data/computercraft/lua/rom/help/speaker.md index 872f5dfc9..0ea3c2916 100644 --- a/src/main/resources/data/computercraft/lua/rom/help/speaker.md +++ b/src/main/resources/data/computercraft/lua/rom/help/speaker.md @@ -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.