Sound and music
Recordings for a mod's weapons, and menu and battle playlists of its own.
A mod may bring its own recordings for its weapons, and its own music for the menu and for battle.
Weapon sounds
A sounds entry per file, keyed <mod id>-<name> so it can clash with nothing, and a weapon whose sound names that key fires with it, attenuated and panned by the engine like every other shot. A weapon without one uses the game's sound for its class. Keep a recording the way the game keeps its own: a dry, close-miked one-shot under a second, no reverb tail, mono MP3 (WAV works; OGG does not play on Safari).
Background music
A mod can replace the menu and battle playlists with ordered, repeating queues. Keep built-in IDs to mix the game's tracks with your own, or list only your own IDs for a complete replacement. menu also covers match setup; supply setup for a separate setup playlist. Omit a queue to leave it alone, or use [] for silence. When several active mods supply the same queue, the last one wins; disabling it restores the preceding queue or the game's original shuffle.
{
"format": "steel-tide-mod",
"v": 2,
"id": "my-score",
"name": "My soundtrack",
"version": "1.0.0",
"defs": [],
"music": {
"tracks": [{ "id": "my-score-march", "file": "music/march.mp3" }],
"menu": ["glassline-drive", "my-score-march"],
"battle": ["my-score-march", "iron-standard"]
}
}
Custom track IDs start with the mod's ID and a dash. Files are MP3, Ogg or WAV, relative to mod.json, and use the existing mod asset budget. A music-only mod uses defs: []. Queues retain the normal gaps, music volume and pause behavior; missing or unplayable recordings are skipped. Victory and defeat music stay as shipped. The reference below lists the built-in IDs.
Reference
A sound (sounds[])
| field | type | required | default | meaning |
|---|---|---|---|---|
| key | string | yes | `<mod id>-<name>`, lower case; what a weapon's `sound` names | |
| file | string | yes | the recording, relative to mod.json. An MP3 plays everywhere; WAV works, OGG not on Safari. Dry, close, under a second |
Background music (music)
| field | type | required | default | meaning |
|---|---|---|---|---|
| tracks | track[] | up to 32 custom recordings, each with an id and file | ||
| menu | track id[] | ordered repeating queue for menus; also used for setup unless setup is supplied. Omitted keeps the previous queue; [] is silence | ||
| setup | track id[] | optional separate queue for match setup | ||
| battle | track id[] | ordered repeating queue during battle. Omitted keeps the previous queue; [] is silence. Built-in IDs: menu, glassline-drive, setup, cold-front, victory, defeat, battle-1, battle-2, assembly-gears, disciplined-unease, methodical-calm, iron-standard, danger-close, dead-reckoning, zero-hour, stand-to, stand-down |
A music track (music.tracks[])
| field | type | required | default | meaning |
|---|---|---|---|---|
| id | id | yes | unique track id: <mod id>-<name>; cannot replace a built-in ID | |
| file | string | yes | MP3, Ogg or WAV path relative to mod.json |
Last edited