Audio System

The audio system handles music (background tracks) and sounds (effects).

Music

Music entries contain multiple track files. When you set music, the system:

Fade transition: When changing music, the current track fades out (1 second unless its fade_out says otherwise) before the new music starts. Pass true as the second argument to game.setMusic(...) to switch instantly with no fades.

Playing Music

Example:

Default Dungeon Music

Set default music in the dungeon template config:

When {music: false} is used, the system reverts to the dungeon's configured music.

Sounds

Sound entries can contain multiple files. When you play a sound, the system:

Sounds play in sequence (one after another), not simultaneously.

Random Variations

Tick random to make the files a pool instead: each play picks ONE file at random. Use it for a sound that repeats often – footsteps, hits, a slap on every beat – so a run of them does not sound like one take copied over and over. With loop also on, the files follow each other in random order.

Looping

Tick loop on a sound to make it repeat – it plays every file in sequence, then restarts from the first. Use it for ambience: rain, a crackling forge, a hum under a scene.

Looping sounds keep playing until stopped with {sound: "!sound_id"} or {sound: false}. Where a loop is started decides how long it lives:

Use scene loops for a sound tied to one moment, and room or dungeon loops for ambience that should follow the player around.

Room and dungeon ambience

The simplest ambience needs no script. Set Default Sounds on a room, or on the dungeon itself, next to its Default Assets. The dungeon's sounds play anywhere in it, and a room's play on top of them while the player is in that room. They keep playing through scenes, stop as the player walks out, and come back after a scene that silenced them. Pick looping sounds; a one-shot would replay on every entry.

Looping sounds are saved with the run. Load a save and they resume from the top of their sequence – on the player's first click or keypress, since browsers block audio until the page has been interacted with.

Playing a loop that is already running leaves it running – it neither restarts nor layers a second copy. A new volume on the repeat still applies: {sound: "rain(volume=0.3)"} quiets the rain in place.

One-shot sounds always stop when the scene exits, and when the player walks to another room.

Channels

Give sounds the same channel to make them replace each other. Starting one stops whatever else is playing on that channel, each over its own fade_out, so the new sound takes over instead of layering.

Sounds with no channel play alongside everything, as before.

Playing Sounds

Example:

Volume and Fades

The player's music and sound sliders in the menu set the ceiling. Everything below scales under them.

Every music track and sound has these fields in the editor. Each can be overridden for one play with a (prop=val) tail on the id, the same form assets and actors take. An unset value falls back to the entity's field, then to the engine default; an explicit 0 means none.

On a music switch, fade_out is how the outgoing track leaves and fade_in how the new one arrives:

{music: "tense(fade_out=3, fade_in=1)"}

On a stop, fade_out is the stopping fade. A sound's own fade_out also applies when the scene ends or {sound: false} clears everything, so an ambience with fade_out: 2 never cuts.

{sound: "!rain(fade_out=3)"}
{music: "!(fade_out=4)"}

Delay lines a sound up with a beat or an asset's enter_delay:

{asset: "lightning(enter_delay=0.5)", sound: "thunder(delay=0.8)"}

A save taken during a fade restores the sound at its full gain. Playing the track that is already playing is a no-op; the music never restarts on a repeated {music}.

Methods

Quick Reference

Next Steps

• Assets - Asset management