Checkpoint current interactive fiction state

2026-05-14 21:17:43 +02:00
parent c745efd1d2
commit 873049f7e6
183 changed files with 13755 additions and 1459 deletions
@@ -0,0 +1,34 @@
+Music
+=====
+
+Story music paths resolve relative to this directory.
+
+Block music markup:
+
+```text
+::music[crossfade, loop, lead=4](track-name.ogg)
+```
+
+Inline music cue:
+
+```text
+The candles gutter. {{music:cut:danger.ogg}} Something moves upstairs.
+```
+
+Supported modes:
+
+- `queue`: start the new track after the current track ends.
+- `crossfade`: fade from the current track into the new track.
+- `cut`: stop the current track and start the new track immediately.
+
+Supported playback flags:
+
+- `loop`: repeat the track.
+- `once`: play the track one time.
+- `lead=<seconds>`: for block music, let the music play alone for this many seconds before the next text/TTS paragraph starts.
+
+Music volume is controlled by master volume and music volume in the options menu. While TTS is playing, music is ducked to 70% of its configured volume and restored when TTS playback is idle.
+
+Browsers require a user interaction before audio can play, so music should begin after `new game` or `load`, not during passive page load.
+
+Document third-party source and license information here or next to the file.