Setup Guide
Goal: working microphone transcription in about five minutes.
1. Enable the plugin
After installing from FAB, open Edit → Plugins, find Elys Listen under Elys'Plugins, make sure it is enabled, and restart the editor if prompted.
2. Download a Whisper model
Open Tools → Elys Listen → Download Whisper Models. Pick a model:
| Model | Size | Notes |
|---|---|---|
tiny / base | 75–142 MB | Fast, good for testing |
small | 466 MB | Recommended balance of speed/accuracy |
medium / large | 1.5–3 GB | Best accuracy, heavier |
Models download to Content/ElysListen/Models/. When a download finishes,
the plugin auto-configures the model path for you.
3. Configure settings
In Project Settings → Plugins → Elys Listen (STT):
- Enable STT: on
- STT Backend:
Whisper (Local) - STT Model Path: set automatically by the downloader (or browse to a
.bin) - Default Language Code: e.g.
en-US,fr-FR
4. Add the component
Add an Elys STT Component to any actor (a PlayerController or pawn works well). Bind On STT Result and call Start Listening (or tick Auto Start Listening).
// C++
UERP_STTComponent* STT = CreateDefaultSubobject<UERP_STTComponent>(TEXT("STT"));
STT->Config.LanguageCode = TEXT("en-US");
// In BeginPlay:
STT->OnSTTResult.AddDynamic(this, &AMyActor::HandleTranscript);
STT->StartListening();
5. Multiplayer note
STT runs client-side only. Never replicate audio. If the server needs the
text, send the final FERP_STTResult.TranscribedText over an RPC.
Next: pipe transcripts into an LLM or TTS — see Chaining.