Skip to content
Ethorbit edited this page Oct 7, 2025 · 6 revisions

Usage

  • For each audio file

    • Create a file with the EXACT SAME name, ending with .txt (e.g. epic-explosion.wav.txt)
    • Inside the file, add comma separated tags describing the sound: explosion, boom
  • Save the library: python ./src/main.py --save <directory>

  • Load the library: python ./src/main.py --load <directory>

  • After loading, type something that resembles the sound you want to hear (e.g. explode)

⚙️ Configuring

  • Run the program at least once to generate a config

  • Find the config

    On Windows: C:\Users\YourUserName\AppData\Roaming\soundprompt\config.toml

    On Linux: $HOME/.config/soundprompt/config.toml

  • Edit the values to your liking

(Unfinished)

🎤 Routing to Your Apps

SoundPrompt does not create a virtual microphone; it simply plays sounds through the device's primary output device. To use it in apps like Discord, Zoom, OBS, etc., you’ll need a virtual audio input device/loopback to route the sound as if it were coming from a microphone.

Windows
  • Install VB-Cable Free (single virtual cable).
  • Set SoundPrompt’s output to VB-Cable Input.
  • In Discord (or any other app), select VB-Cable Output as your microphone.
macOS
  • Use BlackHole (free, open-source).
  • Route SoundPrompt through the virtual device.
  • Choose that virtual device as the input in your app.
Linux
  • Use PulseAudio (usually preinstalled) or JACK (optional advanced routing).
  • With pavucontrol, create a loopback from SoundPrompt’s output to a virtual input.
  • Select the virtual input as your microphone in the target app.

Clone this wiki locally