VoiceDebug

Voice Debug

A tiny HUD for in‑game voice recognition: it shows the last recognized phrase on screen ideal for debugging what you're saying and understand what the game is understanding.

✨ Features

• Overlay that displays the last recognition result.
• Toggle on/off with a keybind (default: F8).
• Configurable vertical position (percentage), alignment (TextAnchor), font size, fade time.
• Optional: use the same font as the game menus (on by default).
• No networking, no cloud, no extra microphone access — it only reflects what the game already recognized.

📦 Requirements

• BepInEx 5.x.

🧰 Installation

Via Thunderstore Mod Manager / r2modman

1. Search for Voice Debug in your game's Thunderstore community.
2. Click Install (the manager will place files under the correct BepInEx/plugins folder automatically).

Manual install

1. Ensure BepInEx is installed and the game runs once with BepInEx.
2. Extract this package into the game folder so the DLL ends up here:

BepInEx/
plugins/
AntsLab.VoiceDebug/
AntsLab.VoiceDebug.dll

Managers follow a “legacy” default install layout if no custom installer is declared; the structure above is compatible with that behavior.

⚙️ Configuration

After first launch, a config file is created at:

BepInEx/config/antslab.VoiceDebug.cfg

Key options (defaults in bold):

• UI.ToggleKey — toggle overlay key (F8)
• UI.ShowOverlay — show HUD on startup (true)
• UI.FontSize — font size in points (30)
• UI.VerticalPercent — vertical position from top (0–1, 0.80)
• UI.TextAlign — one of Unity's TextAnchor names; e.g. MiddleCenter, LowerCenter, UpperLeft
• UI.UseGameFont — try to use the game's menu font (true)
• UI.FadeSeconds — time for the text to fade out (8.0)

Change values while the game is closed for consistency. Some options can be toggled live (e.g., ShowOverlay via F8).

🕹️ Usage

• Join a session as usual and talk.
• Whenever the game's recognizer resolves a phrase, the HUD displays it (e.g., mirror, fireball, or [unk] if unknown).
• Press F8 to hide/show the HUD.

❓ FAQ

• Why do I see [unk] sometimes?

That is what the game's recognizer emits when the audio didn't match any entry in its vocabulary closely enough. The HUD is only reflecting that string.

• Can I move the text lower/higher?

Yes, set VerticalPercent to something like 0.95 (lower) or 0.10 (higher).

• Can I center/left/right align it?

Set TextAlign to any Unity TextAnchor name (e.g., MiddleCenter, UpperLeft, LowerRight).

• Can I disable the game's font?

Simply toggle UseGameFont in configs to false.

🧪 Compatibility

• Client‑side only.
• Doesn't patch network behavior.
• Should be safe with most mods — it only reads the last result and displays it.