Sound Alerts

Audio notifications for game events.

Setup

1. Create sounds directory: ~/.vellum-fe/sounds/
2. Add .wav files
3. Reference in highlights

Using Sounds

In highlights.toml:

[[highlights]]
name = "death_alert"
pattern = "appears dead"
foreground = "#00FF00"
sound = "kill.wav"
sound_volume = 0.8

Sound Properties

Global Settings

In config.toml:

[sound]
enabled = true
volume = 0.7              # Master volume
cooldown_ms = 500         # Min time between sounds
startup_music = true      # Play music on launch

Disabling Sounds

All Sounds

[sound]
enabled = false

Highlight Sounds Only

[highlights]
sounds_enabled = false

Example Sounds Setup

Directory structure:

~/.vellum-fe/sounds/
├── kill.wav
├── alert.wav
├── whisper.wav
├── danger.wav
└── loot.wav

Highlights:

[[highlights]]
name = "kill"
pattern = "appears dead"
sound = "kill.wav"

[[highlights]]
name = "stunned"
pattern = "You are stunned"
sound = "alert.wav"
sound_volume = 1.0

[[highlights]]
name = "whisper"
pattern = "whispers to you"
sound = "whisper.wav"
sound_volume = 0.5

[[highlights]]
name = "bleeding"
pattern = "Blood runs down"
sound = "danger.wav"

Supported Formats

• WAV (recommended)
• MP3
• OGG
• FLAC

Troubleshooting

No sound playing?

1. Check [sound] enabled = true in config.toml
2. Check [highlights] sounds_enabled = true
3. Verify file exists in sounds directory
4. Check file format is supported
5. Try increasing volume