Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Sound Effects

Plays a sound effect from a mod asset.

Sound effects are played immediately and do not block execution. The sound file must be included in a mod's assets directory. Supports common audio formats like WAV, MP3, and OGG.

Parameters

  • source: The mod asset path relative to the assets/mods directory.

Examples

Basic Sound Effects

// Play notification sounds
await effects.sound("ui-sounds/button-click.wav");
await effects.sound("notifications/message-received.mp3");
await effects.sound("character-voices/greeting.ogg");
  • stamp() - Display visual effects alongside sounds