Skip to main content

Custom SFX Overrides

warning

This system is in development and has not been merged into Ship of Harkinian. Nothing on this page works in current releases, and details (file naming, authoring rules) may still change before it ships.

Custom SFX overrides give a single sound effect its own audio sample, leaving everything else untouched.

Many sound effects in OoT share audio: when a sound effect plays, a script picks a font instrument (which points at a sample) and plays it at a scripted pitch. The bow and the slingshot, for example, play the same samples at different pitches for their shot, draw and flick sounds. Overriding a sound effect by its SFX id sidesteps that sharing entirely — the slingshot gets a new shot sound while the bow keeps vanilla.

Usage​

Place a sample in your mod o2r at audio/custom/, named after the SFX id you want to replace:

audio/custom/NA_SE_IT_SLING_SHOT      ← only the slingshot shot changes
audio/custom/NA_SE_IT_SLING_DRAW ← only the slingshot draw changes

At boot, SoH scans audio/custom/ and matches filenames against the SFX name list. Whenever that SFX id plays, your sample is used.

Rules:

  • The sample plays as recorded. Vanilla sounds are raw material that the game's scripts repitch heavily (the slingshot is a whoosh sample driven through a four-octave pitch dive) — a custom sample is a finished sound, so the scripted note pitches, pitch slides and vibrato are nullified. Only the subtle per-play effects vanilla applies on top remain: the small random pitch variation and distance-based scaling.
  • Author at 32 kHz, or embed your own rate. By default the engine treats the sample data as 32 kHz — resample your audio to 32 kHz before converting, or it will play at the wrong speed. If your conversion tool supports the newer V3 sample format (e.g. the "Export as V3" option in the SoH Audio Tool), your file's actual sample rate is embedded and this restriction goes away — any rate works.
  • Keep the duration close to vanilla. The scripted note length still governs how long the sound is held — a sample much longer than the original sound will be faded out early.
  • One sample per SFX id. Some sounds (several of Link's voice lines, for example) randomly pick between a few different vanilla recordings on each play. An override replaces all of them with the same single sample, so that variation is lost — every play sounds identical instead of varying.
  • Not supported at this time: music. This system only overrides SFX-bank playback — it has no effect on background themes, song-teaching demos, warp song jingles, cutscene arrangements or any other music, even when a music sequence happens to reuse the same soundfont as an SFX sound.

Pitched overrides (.pitched suffix)​

Some sounds are made of pitch shifting — the ocarina builds its melodies by pitching one sample. For those, add .pitched to the filename:

audio/custom/NA_SE_OC_OCARINA.pitched

A .pitched sample keeps the full scripted pitch behavior — notes still play at the pitches the script asks for, just from your sample instead of the vanilla one.

  • V3 format: tuning is computed from your file's own embedded rate. Any rate works; it does not need to match the vanilla sample.
  • Legacy (non-V3) format: no rate is embedded, so the vanilla instrument's original tuning is reused unchanged. Your file must be recorded at the vanilla sample's exact rate and reference pitch, or every note will be off-pitch.

The ocarina​

NA_SE_OC_OCARINA covers both you playing and the game's playback of a song (the echo after a correct song, Scarecrow's song, etc.), and switches between six instruments depending on context (ocarina, Malon, whistle, harp, organ, flute).

  • Ocarina overrides must use .pitched — the melodies are pitch shifts of the sample, so an as-recorded override would play every note at the same pitch.
  • The override applies to both your own live playing and the game's own playback of a song (the echo after a correct song, Scarecrow's Song, warp songs, etc.) — the two cannot be given different sounds.
  • NA_SE_OC_OCARINA is the one SFX id behind all six instruments — the game swaps which instrument the channel plays through depending on context (the actual ocarina, Malon singing, the whistle, harp, grind organ, flute). An override only replaces the default ocarina instrument; the other five arrive under the same SFX id but a different instrument, so they're left untouched and keep their own sounds.
  • Record at the vanilla sample's rate (32 kHz) and reference pitch (the game plays the raw sample ~8 semitones below its recorded pitch) — or, using the V3 format, embed your own rate and skip matching it. Either way, give the file loop points — ocarina notes sustain while a button is held.
  • The ocarina heard in music sequences (Lost Woods' theme, for example) is not NA_SE_OC_OCARINA — see "Not supported at this time: music" above. If you're testing an ocarina override, listen for the confirmation echo after correctly playing a song, not the ambient music of an area.

Reference: item SFX (NA_SE_IT_*)​

Filename = SFX name. The pitch behavior column describes the sound's vanilla pitch character and what an override inherits from it:

  • fixed note — the script plays a single note. An override is a perfect 1:1 swap.
  • multi-note — the script triggers several notes, layered and/or in sequence (composite sounds). Your sample plays once per note trigger at the scripted timing, each time as recorded — bake the finished composite into one file and expect it to retrigger.
  • portamento — the vanilla sound's pitch slides during playback (often its defining character, like the slingshot's descending chirp). The slide does not apply to your sample — author the character you want into the recording.
  • random pitch — the engine applies a small random pitch offset each play so repeats don't sound identical. This still applies to your sample.
Vanilla sampleSFX nameIDPitch behavior
Metal ClinkNA_SE_IT_SWORD_IMPACT0x1800fixed note, random pitch
WhishNA_SE_IT_SWORD_SWING0x1801portamento, fixed note, random pitch
Sheathe SwordNA_SE_IT_SWORD_PUTAWAY0x1802fixed note
Draw SwordNA_SE_IT_SWORD_PICKOUT0x1803fixed note
Air SwishNA_SE_IT_ARROW_SHOT0x1804fixed note, random pitch
Air WhistleNA_SE_IT_BOOMERANG_THROW0x1805portamento, multi-note, random pitch
Sword Striking Metal ShieldNA_SE_IT_SHIELD_BOUND0x1806multi-note, random pitch
Bow Pulled TautNA_SE_IT_BOW_DRAW0x1807portamento, fixed note, random pitch
Metal Clink, Sword Striking Metal ShieldNA_SE_IT_SHIELD_REFLECT_SW0x1808multi-note, random pitch
Arrow Thunk in WoodNA_SE_IT_ARROW_STICK_HRAD0x1809fixed note
Metal Clink, Heavy ThumpNA_SE_IT_HAMMER_HIT0x180Amulti-note, random pitch
Moving Metal Chain, Explosion 1NA_SE_IT_HOOKSHOT_CHAIN0x180Bmulti-note
Sword Striking Metal Shield, Buzzing SynthNA_SE_IT_SHIELD_REFLECT_MG0x180Cportamento, multi-note
Hissing FuseNA_SE_IT_BOMB_IGNIT0x180Dfixed note
Explosion 1NA_SE_IT_BOMB_EXPLOSION0x180Efixed note
Hissing FuseNA_SE_IT_BOMB_UNEXPLOSION0x180Fportamento, multi-note
Air SwishNA_SE_IT_BOOMERANG_FLY0x1810portamento, multi-note
Soft ThumpNA_SE_IT_SWORD_STRIKE0x1811portamento, multi-note
WhishNA_SE_IT_HAMMER_SWING0x1812portamento, fixed note, random pitch
Metal ClinkNA_SE_IT_HOOKSHOT_REFLECT0x1813portamento, multi-note
Air SwishNA_SE_IT_ARROW_STICK_CRE0x1814portamento, multi-note
Arrow Thunk in WoodNA_SE_IT_ARROW_STICK_OBJ0x1815fixed note
Whish, Air WhooshNA_SE_IT_SWORD_SWING_HARD0x1818portamento, multi-note
Metal ClinkNA_SE_IT_WALL_HIT_HARD0x181Afixed note
Metal ClinkNA_SE_IT_WALL_HIT_SOFT0x181Bportamento, multi-note
Metal ClinkNA_SE_IT_STONE_HIT0x181Cmulti-note
Broken WoodNA_SE_IT_WOODSTICK_BROKEN0x181Dmulti-note
Air Swish, Whip SnapNA_SE_IT_LASH0x181Emulti-note, random pitch
Metal Clink, Sheathe SwordNA_SE_IT_SHIELD_POSTURE0x181Fmulti-note, random pitch
Air SwishNA_SE_IT_SLING_SHOT0x1820portamento, fixed note
Bow Pulled TautNA_SE_IT_SLING_DRAW0x1821portamento, fixed note
(synth wave), Buzzing SynthNA_SE_IT_SWORD_CHARGE0x1822portamento, multi-note
Whish, Air WhooshNA_SE_IT_ROLLING_CUT0x1823portamento, multi-note
Egg Hatching, Soft ThumpNA_SE_IT_SWORD_STRIKE_HARD0x1824portamento, multi-note
Metal ClinkNA_SE_IT_SLING_REFLECT0x1825portamento, multi-note
Metal Clink, Sheathe SwordNA_SE_IT_SHIELD_REMOVE0x1826multi-note
Metal Clink, Sheathe SwordNA_SE_IT_HOOKSHOT_READY0x1827multi-note
Metal Clink, Sheathe Sword, Moving Metal ChainNA_SE_IT_HOOKSHOT_RECEIVE0x1828multi-note
Metal Clink, Explosion 1NA_SE_IT_HOOKSHOT_STICK_OBJ0x1829portamento, multi-note, random pitch
Air Whoosh, Buzzing SynthNA_SE_IT_SWORD_REFLECT_MG0x182Aportamento, multi-note
Metal Clink, Whip SnapNA_SE_IT_DEKU0x182Bportamento, multi-note
Ocarina_Looped, Dodongo Roar, Egg HatchingNA_SE_IT_WALL_HIT_BUYO0x182Cportamento, multi-note
Draw SwordNA_SE_IT_SWORD_PUTAWAY_STN0x182Dportamento, multi-note
Whish, Air Whoosh, Buzzing SynthNA_SE_IT_ROLLING_CUT_LV10x182Eportamento, multi-note
Flamethrower, Air Whoosh, Buzzing SynthNA_SE_IT_ROLLING_CUT_LV20x182Fportamento, multi-note
Bow Pulled TautNA_SE_IT_BOW_FLICK0x1830portamento, fixed note
Hissing FuseNA_SE_IT_BOMBCHU_MOVE0x1831portamento, fixed note
Synth Pad StingNA_SE_IT_SHIELD_CHARGE_LV10x1832portamento, multi-note
Synth Pad StingNA_SE_IT_SHIELD_CHARGE_LV20x1833portamento, multi-note
Synth Pad StingNA_SE_IT_SHIELD_CHARGE_LV30x1834portamento, multi-note
Bow Pulled TautNA_SE_IT_SLING_FLICK0x1835portamento, fixed note
Metal Clink, Explosion 1NA_SE_IT_SWORD_STICK_STN0x1836portamento, multi-note
Step - Wooden Bridge, Wooden StrikeNA_SE_IT_REFLECTION_WOOD0x1837multi-note, random pitch
Sword Striking Metal Shield, Buzzing SynthNA_SE_IT_SHIELD_REFLECT_MG20x1838portamento, multi-note
Air Swish, Air WhooshNA_SE_IT_MAGIC_ARROW_SHOT0x1839portamento, multi-note
Eye of Truth, Explosion 1, IgnitionNA_SE_IT_EXPLOSION_FRAME0x183Aportamento, multi-note
Eye of Truth, Explosion 1, Warp Circle AmbienceNA_SE_IT_EXPLOSION_ICE0x183Bportamento, multi-note
Eye of Truth, Explosion 1, Flying FairyNA_SE_IT_EXPLOSION_LIGHT0x183Cportamento, multi-note
Bow Pulled TautNA_SE_IT_FISHING_REEL_SLOW0x183Dfixed note
Bow Pulled TautNA_SE_IT_FISHING_REEL_HIGH0x183Efixed note
Bow Pulled TautNA_SE_IT_PULL_FISHING_ROD0x183Fportamento, fixed note, random pitch
Crystal Synth (Low), Heavy Rumbling, Explosion 1NA_SE_IT_DM_FLYING_GOD_PASS0x1840portamento, multi-note
Crystal Synth (Low), Heavy Rumbling, Explosion 1NA_SE_IT_DM_FLYING_GOD_DASH0x1841portamento, multi-note
Crystal Synth (Low), Heavy Rumbling, Distorted Static, Explosion 1NA_SE_IT_DM_RING_EXPLOSION0x1842portamento, multi-note
Heavy Rumbling, Explosion 1NA_SE_IT_DM_RING_GATHER0x1843multi-note
Horse NeighNA_SE_IT_INGO_HORSE_NEIGH0x1844fixed note, random pitch
Heavy Rumbling, Explosion 1NA_SE_IT_EARTHQUAKE0x1845multi-note
Bow Pulled TautNA_SE_IT_KAKASHI_JUMP0x1847portamento, fixed note
Heavy Static, IgnitionNA_SE_IT_FLAME0x1848portamento, multi-note
Warp Circle AmbienceNA_SE_IT_SHIELD_BEAM0x1849fixed note
Bow Pulled Taut, Air Whoosh, Whip SnapNA_SE_IT_FISHING_HIT0x184Amulti-note
Explosion 1NA_SE_IT_GOODS_APPEAR0x184Bfixed note
Metal Clink, Sword Striking Metal Shield, Buzzing SynthNA_SE_IT_MAJIN_SWORD_BROKEN0x184Cportamento, multi-note
Whip SnapNA_SE_IT_HAND_CLAP0x184Dfixed note
Crystal Synth (Low), WhishNA_SE_IT_MASTER_SWORD_SWING0x184Eportamento, multi-note

Other banks​

Overrides work for every SFX bank the same way — player (NA_SE_PL_*), environment (NA_SE_EV_*), enemy (NA_SE_EN_*), system (NA_SE_SY_*), ocarina (NA_SE_OC_*) and voice (NA_SE_VO_*). A complete list of all SFX names can be found in soh/include/sfx.h in the Shipwright repository.