Merge pull request 'feat: sound alias' (#1494) from Antipathie/strudel:feature/592-sound-alias into main

Reviewed-on: https://codeberg.org/uzu/strudel/pulls/1494

packages/superdough/superdough.mjs

@@ -113,6 +113,19 @@ export async function aliasBank(...args) {
   }
 }
 
+/**
+ * Register an alias for a sound.
+ * @param {string} original - The original sound name
+ * @param {string} alias - The alias to use for the sound
+ */
+export function soundAlias(original, alias) {
+  if (getSound(original) == null) {
+    logger('soundAlias: original sound not found');
+    return;
+  }
+  soundMap.setKey(alias, getSound(original));
+}
+
 export function getSound(s) {
   if (typeof s !== 'string') {
     console.warn(`getSound: expected string got "${s}". fall back to triangle`);

website/src/pages/learn/samples.mdx

@@ -59,6 +59,14 @@ Furthermore, strudel also loads instrument samples from [VCSL](https://github.co
 
 To see which sample names are available, open the `sounds` tab in the [REPL](https://strudel.cc/).
 
+You can also create custom aliases for existing sounds using the `soundAlias` function:
+
+<MiniRepl
+  client:idle
+  tune={`soundAlias("RolandTR808_bd", "kick")
+s("kick")`}
+/>
+
 Note that only the sample maps (mapping names to URLs) are loaded initially, while the audio samples themselves are not loaded until they are actually played.
 This behaviour of loading things only when they are needed is also called `lazy loading`.
 While it saves resources, it can also lead to sounds not being audible the first time they are triggered, because the sound is still loading.