update docs and default-prefs with custom sounds and default-sounds feature

Author: nc7s

README.md

@@ -36,7 +36,7 @@ Run this command too if you want to update bacon. Configuration has always been
 
 Some features are disabled by default. You may enable them with
 
-    cargo install --features "clipboard sound"
+    cargo install --features "clipboard sound default-sounds"
 
 ## check the current project
 
@@ -116,6 +116,7 @@ Some bacon features can be disabled or enabled at compilation:
 
 * `"clipboard"` - disabled by default : necessary for the `copy-unstyled-output` internal
 * `"sound"` - disabled by default : necessary for the `play-sound` internal
+* `"default-sounds"` - disabled by default: embed some default sounds for the `play-sound` internal
 
 ## Licences
 

defaults/default-prefs.toml

@@ -79,6 +79,13 @@ line_format = "{kind} {path}:{line}:{column} {message}"
 enabled = false # set true to allow sound
 base_volume = "100%" # global volume multiplier
 
+# Specify your own sound files, e.g.
+#     bepop = "~/audio/bepop.mp3"
+#
+# Then use its name as usual in a job, e.g.
+#     on_success = "play-sound(name=bepop,volume=42)"
+[sound.collection]
+
 # Uncomment and change the key-bindings you want to define
 # (some of those ones are the defaults and are just here for illustration)
 [keybindings]
@@ -110,4 +117,3 @@ base_volume = "100%" # global volume multiplier
 # r = "job:run"
 # ctrl-e = "export:analysis"
 # ctrl-c = "copy-unstyled-output"
-

website/docs/config.md

@@ -323,4 +323,27 @@ on_success = "play-sound(name=90s-game-ui-6,volume=50)"
 on_failure = "play-sound(name=beep-warning,volume=100)"
 ```
 
-Sound name can be omitted. Possible values are `2`, `90s-game-ui-6`, `beep-6`, `beep-beep`, `beep-warning`, `bell-chord`, `car-horn`, `convenience-store-ring`, `cow-bells`, `pickup`, `positive-beeps`, `short-beep-tone`, `slash`, `store-scanner`, `success`.
+Sound name can be omitted.
+
+If the `default-sounds` feature is enabled, some pre-chosen sounds are available; their names are `2`, `90s-game-ui-6`, `beep-6`, `beep-beep`, `beep-warning`, `bell-chord`, `car-horn`, `convenience-store-ring`, `cow-bells`, `pickup`, `positive-beeps`, `short-beep-tone`, `slash`, `store-scanner`, `success`.
+
+Or, you can add your own sounds.
+
+Either use a direct path, eg
+
+```TOML
+on_success = "play-sound(path=media/bepop.mp3,volume=42)"
+```
+
+or, add sounds to a root level collection, eg
+
+```TOML
+[sound.collection]
+bepop = "~/audio/bepop.mp3"
+```
+
+then use its name in a job as usual, eg
+
+```TOML
+on_success = "play-sound(name=bepop,volume=42)"
+```