docs: update README with comprehensive effects documentation and bump version to 1.2.0
README Updates: - Updated features list with all new capabilities - Comprehensive Audio Effects section covering all 7 effects: - Pitch, Speed, Echo, Robot, Chorus, Tremolo Depth, Tremolo Rate - Detailed effect ranges, defaults, and descriptions - Effect application order documentation - Performance notes and warnings - Enhanced Preview with Effects section with examples - Example effect combinations for users to try Version Bump: - Bumped __version__ from 1.1.0 to 1.2.0 Major features in 1.2.0: - 4 new voice effects (echo, robot, chorus, tremolo) - Unlimited effects with performance warnings - Complete effects pipeline implementation - Enhanced preview system
This commit is contained in:
88
README.md
88
README.md
@@ -14,7 +14,9 @@ A Discord bot that reads messages aloud using [Pocket TTS](https://github.com/ky
|
||||
- 🧪 **Test Mode**: Separate testing configuration for safe development
|
||||
- 📦 **Auto-updates**: Automatically checks for and installs dependency updates on startup
|
||||
- 👂 **Voice Preview**: Preview voices with `/voice preview` before committing to them
|
||||
- 🎵 **Audio Effects**: Apply pitch shift and speed changes to your TTS voice
|
||||
- 🎵 **Audio Effects**: 7 different effects to customize your voice (pitch, speed, echo, robot, chorus, tremolo)
|
||||
- ⚡ **Unlimited Effects**: Use as many effects as you want (warning shown when >2 active)
|
||||
- ⏱️ **Processing Indicator**: Shows when audio processing is taking longer than expected
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -130,25 +132,89 @@ Create `.env.testing` by copying `.env.example` and configuring it with your tes
|
||||
|
||||
### Audio Effects
|
||||
|
||||
Apply pitch shift and speed changes to your TTS voice:
|
||||
Transform your TTS voice with 7 different audio effects:
|
||||
|
||||
- `/effects list` - Show your current effect settings
|
||||
- `/effects set pitch <semitones>` - Change pitch (-12 to +12)
|
||||
#### Available Effects:
|
||||
|
||||
**🎵 Pitch** (`/effects set pitch <semitones>`)
|
||||
- Range: -12 to +12 semitones
|
||||
- Default: 0 (no change)
|
||||
- Positive = higher/chipmunk voice
|
||||
- Negative = lower/deeper voice
|
||||
- 0 = normal pitch (default)
|
||||
- `/effects set speed <multiplier>` - Change speed (0.5 to 2.0)
|
||||
|
||||
**⚡ Speed** (`/effects set speed <multiplier>`)
|
||||
- Range: 0.5 to 2.0
|
||||
- Default: 1.0x (normal speed)
|
||||
- Higher = faster speech
|
||||
- Lower = slower speech
|
||||
- 1.0 = normal speed (default)
|
||||
- `/effects reset` - Reset all effects to defaults
|
||||
|
||||
**Note**: You can use up to 2 effects simultaneously. More effects require more processing time.
|
||||
**🔊 Echo** (`/effects set echo <percentage>`)
|
||||
- Range: 0-100%
|
||||
- Default: 0% (off)
|
||||
- Adds spatial delay and reverb effect
|
||||
- Higher values = more pronounced echo
|
||||
|
||||
**🤖 Robot** (`/effects set robot <percentage>`)
|
||||
- Range: 0-100%
|
||||
- Default: 0% (off)
|
||||
- Applies ring modulation for sci-fi robotic voice
|
||||
- Higher values = more robotic distortion
|
||||
|
||||
**🎶 Chorus** (`/effects set chorus <percentage>`)
|
||||
- Range: 0-100%
|
||||
- Default: 0% (off)
|
||||
- Creates "multiple voices" effect with slight pitch variations
|
||||
- Higher values = more voices and depth
|
||||
|
||||
**〰️ Tremolo Depth** (`/effects set tremolo_depth <value>`)
|
||||
- Range: 0.0 to 1.0
|
||||
- Default: 0.0 (off)
|
||||
- Controls amplitude modulation amount
|
||||
- Higher = more warble/vintage radio effect
|
||||
|
||||
**📳 Tremolo Rate** (`/effects set tremolo_rate <hertz>`)
|
||||
- Range: 0.0 to 10.0 Hz
|
||||
- Default: 0.0 Hz (off)
|
||||
- Controls how fast the tremolo warbles
|
||||
- Requires tremolo_depth > 0 to have effect
|
||||
|
||||
#### Effect Commands:
|
||||
- `/effects list` - Show all your current effect settings
|
||||
- `/effects set <effect> <value>` - Change an effect value
|
||||
- `/effects reset` - Reset all effects to defaults (with confirmation)
|
||||
|
||||
#### Effect Application Order:
|
||||
Effects are applied in this sequence:
|
||||
1. Pitch shift
|
||||
2. Speed change
|
||||
3. Echo/Reverb
|
||||
4. Chorus
|
||||
5. Tremolo
|
||||
6. Robot voice
|
||||
|
||||
#### Performance Notes:
|
||||
- **No limit** on number of active effects
|
||||
- ⚠️ Warning shown when you have more than 2 active effects
|
||||
- More effects = longer processing time
|
||||
- Some effects (like pitch shift and chorus) are more CPU-intensive
|
||||
- Processing time is logged to console for monitoring
|
||||
|
||||
### Preview with Effects
|
||||
|
||||
Test voice and effect combinations before committing:
|
||||
- `/voice preview <name> [pitch] [speed]` - Preview a voice with optional effect overrides
|
||||
Test any combination of voice and effects before committing:
|
||||
|
||||
**Preview a voice:**
|
||||
- `/voice preview <voice_name>` - Preview with your current effects
|
||||
|
||||
**Preview with specific effects:**
|
||||
- `/voice preview <voice_name> pitch:5 speed:1.5` - Preview with pitch +5 and 1.5x speed
|
||||
- All effect parameters are optional and default to your current settings
|
||||
|
||||
**Example combinations to try:**
|
||||
- Robot voice: `/effects set robot 75`
|
||||
- Deep scary voice: `/effects set pitch -8`
|
||||
- Fast chipmunk: `/effects set pitch 8 speed:1.5`
|
||||
- Radio announcer: `/effects set echo 40 tremolo_depth:0.3 tremolo_rate:4`
|
||||
|
||||
## How It Works
|
||||
|
||||
|
||||
Reference in New Issue
Block a user