Skip to main content

Audio

Audio tools handle speech, sound effects, and background music.

speak_message

Make the active character speak text aloud using VoiceVox text-to-speech.

note

Requires the VoiceVox MOD to be installed and the VoiceVox engine to be running.

ParameterTypeDefaultDescription
textstring | string[]requiredText to speak. Pass an array of short sentences for more reliable synthesis.
speakernumber0VoiceVox speaker ID
timeoutMsnumber30000Timeout in milliseconds (range: 1000–120000)

Example:

{
"text": ["Hello!", "How can I help you today?"],
"speaker": 3,
"timeoutMs": 15000
}

play_sound

Play a sound effect asset.

ParameterTypeDefaultDescription
soundstringrequiredSound asset ID (e.g. se:open)
volumenumber0.8Volume level (range: 0.0–1.0)

control_bgm

Control background music playback.

ParameterTypeDefaultDescription
action"play" | "stop" | "pause" | "resume" | "status"requiredAction to perform
assetstringMOD asset ID — required when action is "play"
volumenumberVolume level (range: 0.0–1.0)

The "status" action returns the current playback state as JSON.