aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_audio.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-06-15 22:31:06 -0700
committerGitHub <noreply@github.com>2021-06-15 22:31:06 -0700
commit2538d341d828d04392898a9d3ce691bcd4a79e1f (patch)
treeee3f80d1a11bb477377cbd9bbac399584ec69916 /docs/feature_audio.md
parent83ee79565ce81c3e8dd097be1fe46dc522e17544 (diff)
downloadqmk_firmware-2538d341d828d04392898a9d3ce691bcd4a79e1f.tar.gz
qmk_firmware-2538d341d828d04392898a9d3ce691bcd4a79e1f.zip
Document user song list file (#13101)
Diffstat (limited to 'docs/feature_audio.md')
-rw-r--r--docs/feature_audio.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index b7b572974..9ffbc2cba 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -131,12 +131,14 @@ You can override the default songs by doing something like this in your `config.
131 131
132```c 132```c
133#ifdef AUDIO_ENABLE 133#ifdef AUDIO_ENABLE
134 #define STARTUP_SONG SONG(STARTUP_SOUND) 134# define STARTUP_SONG SONG(STARTUP_SOUND)
135#endif 135#endif
136``` 136```
137 137
138A full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h). 138A full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h).
139 139
140Additionally, if you with to maintain your own list of songs (such as ones that may be copyrighted) and not have them added to the repo, you can create a `user_song_list.h` file and place it in your keymap (or userspace) folder. This file will be automatically included, it just needs to exist.
141
140To play a custom sound at a particular time, you can define a song like this (near the top of the file): 142To play a custom sound at a particular time, you can define a song like this (near the top of the file):
141 143
142```c 144```c