120 lines
4.0 KiB
Markdown
120 lines
4.0 KiB
Markdown
# TTYverse Sound Packs
|
|
|
|
TTYverse supports audio notifications for different types of fediverse activity. Sound packs are collections of audio files that play when specific events occur.
|
|
|
|
## Quick Start
|
|
|
|
1. **Enable sounds**: Use the extension manager to enable the soundpack extension:
|
|
```bash
|
|
./extensions/manage-extensions.sh enable soundpack
|
|
```
|
|
|
|
2. **Configure TTYverse**: Add to your `~/.config/ttyverse/ttyverserc`:
|
|
```
|
|
notifytype=soundpack
|
|
notifies=default,mention,dm,me,search,follow,boost,favourite
|
|
extpref_soundpack=default
|
|
extpref_sound_command=paplay
|
|
```
|
|
|
|
3. **Test**: Start TTYverse and you should hear sounds for different activities!
|
|
|
|
## Sound Pack Structure
|
|
|
|
Sound packs are stored in `~/.local/share/ttyverse/sounds/` with this structure:
|
|
```
|
|
sounds/
|
|
├── default/ # Default sound pack (included)
|
|
│ ├── default.ogg # Regular posts
|
|
│ ├── mention.ogg # @mentions of you
|
|
│ ├── dm.ogg # Direct messages
|
|
│ ├── me.ogg # Your own posts
|
|
│ ├── follow.ogg # New followers
|
|
│ ├── boost.ogg # Your posts boosted
|
|
│ ├── favourite.ogg # Your posts favourited
|
|
│ ├── poll.ogg # Poll notifications
|
|
│ └── announcement.ogg # Server announcements
|
|
├── custom/ # Your custom sound pack
|
|
│ └── *.ogg
|
|
└── README.md # This file
|
|
```
|
|
|
|
## Required Sound Files
|
|
|
|
### Core Sounds (Essential)
|
|
- **`default.ogg`** - Regular timeline posts
|
|
- **`mention.ogg`** - When someone @mentions you
|
|
- **`dm.ogg`** - Direct messages received
|
|
- **`me.ogg`** - Your own posts (optional feedback)
|
|
|
|
### Fediverse Interaction Sounds
|
|
- **`follow.ogg`** - Someone follows you
|
|
- **`boost.ogg`** - Someone boosts (shares) your post
|
|
- **`favourite.ogg`** - Someone favourites (likes) your post
|
|
- **`poll.ogg`** - Poll results or poll you voted in ends
|
|
- **`announcement.ogg`** - Server announcements
|
|
|
|
## Creating Custom Sound Packs
|
|
|
|
1. **Create directory**: Make a new directory under `sounds/` with your pack name:
|
|
```bash
|
|
mkdir -p ~/.local/share/ttyverse/sounds/mystyle
|
|
```
|
|
|
|
2. **Add sound files**: Place `.ogg` files with the required names. All files should be:
|
|
- **Format**: OGG Vorbis (most compatible)
|
|
- **Length**: 1-3 seconds recommended (short and sweet)
|
|
- **Volume**: Normalized to prevent startling users
|
|
- **Sample Rate**: 44.1kHz or 48kHz
|
|
|
|
3. **Configure TTYverse**: Update your config to use the new pack:
|
|
```
|
|
extpref_soundpack=mystyle
|
|
```
|
|
|
|
4. **Test**: Restart TTYverse to load the new sounds
|
|
|
|
## Audio Format Support
|
|
|
|
TTYverse uses your system's audio command for playback. Supported formats depend on your audio player:
|
|
|
|
- **paplay** (PulseAudio default): OGG, WAV, FLAC
|
|
- **play** (SoX): Most formats including MP3, OGG, WAV
|
|
- **ogg123**: OGG Vorbis only
|
|
- **mpv**: Most formats including MP3, OGG, WAV, FLAC
|
|
|
|
Configure your preferred player with:
|
|
```
|
|
extpref_sound_command=paplay # or play, ogg123, mpv, etc.
|
|
```
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
### No Sound
|
|
1. Check audio command: `paplay /usr/share/sounds/alsa/Front_Left.wav`
|
|
2. Verify sound pack path: `ls ~/.local/share/ttyverse/sounds/`
|
|
3. Check TTYverse config: `grep -E "(notifytype|soundpack)" ~/.config/ttyverse/ttyverserc`
|
|
4. Test with verbose mode: TTYverse will show warnings for missing sounds
|
|
|
|
### Wrong Sounds Playing
|
|
- Verify file names exactly match the required names (case-sensitive)
|
|
- Check that you're using the correct sound pack name in config
|
|
- Restart TTYverse after changing sound files
|
|
|
|
### Performance Issues
|
|
- Use compressed formats like OGG instead of WAV
|
|
- Keep sound files under 3 seconds
|
|
- Use `&` in sound command for background playback (already handled by extension)
|
|
|
|
## Example Sound Pack Themes
|
|
|
|
### **Retro Gaming**
|
|
Use classic 8-bit style beeps and boops for different actions
|
|
|
|
### **Natural Sounds**
|
|
Bird calls, water drops, wind chimes for a calming experience
|
|
|
|
### **Minimal**
|
|
Simple tones with different pitches for each notification type
|