Simple Voice Chat

<h1><span style="color: #e03e2d;"><strong>Starting with <span style="background-color: #f1c40f;">1.2.7</span>, Migrated settings, setup, channel, player list, invitation, and HUD windows to <a href="https://mods.vintagestory.at/vsrmlui">RmlUi</a>.</strong></span></h1> <p>&nbsp;</p> <p>Simple Voice Chat provides proximity voice chat, whisper/normal/shout modes, custom channels, per-player local volume and muting, recording, audio processing, permission management, and capacity safeguards. The server handles only authentication, routing, and forwarding; clients handle capture, playback, and local settings.</p> <p>&nbsp;</p> <div style="border-left: 4px solid #3182ce; padding: 8px 12px; margin: 12px 0; background-color: #ebf8ff;"> <p style="margin: 0 0 8px 0;"><strong>Documentation:</strong> For more detailed documentation, the mod website does not have enough space for such a long description. <a href="https://vscn.studio/docs/simplevoicechat">Please check the <strong>wiki</strong></a></p> <hr style="border: 0; border-top: 1px solid #bee3f8; margin: 10px 0;" /> <p style="margin: 0 0 6px 0;"><strong>Recommended Mods to Use Together</strong></p> <ol style="margin: 0; padding-left: 20px;"> <li style="margin-bottom: 6px;"><a href="https://mods.vintagestory.at/vsdirector"><strong>VS Director</strong></a><strong>：</strong>Supports replay, off-screen recording, and workspace editing features. It provides a VoiceApi for recording and replaying Simple Voice Chat audio and including it in videos.</li> <li><a href="https://mods.vintagestory.at/simplevoicevoicechanger"><strong>Simple Voice Voice Changer</strong></a><strong>：</strong>A client-only voice processing mod for Simple Voice Chat. It processes PCM microphone frames before Simple Voice Chat encodes them. Supports pitch, formant, equalizer, distortion, echo, vibrato, robot voice layers, auto-tune, and more.</li> <li> <p><a href="https://mods.vintagestory.at/simplevoicechatcaptions"><strong>Simple Voice Chat: Captions</strong></a>: adds a separate lower-right HUD for nearby game sounds. <span style="text-decoration: line-through; color: #95a5a6;">It can also show <a style="color: #95a5a6; text-decoration: line-through;" href="https://mods.vintagestory.at/simplevoicechat">Simple Voice Chat</a> local speech-recognition results and received remote voice as captions</span>. The caption HUD does not replace the Simple Voice Chat HUD or the vanilla HUD。&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;</p> </li> </ol> <p><img src="https://i.postimg.cc/5tvrY2tz/2e2cf9a4-9402-45a9-a363-78a5201526a7.png" alt="image" /></p> <p><a href="https://mods.vintagestory.at/simplevoicechatasr"><strong><code dir="ltr">4.SimpleVoiceChatASR</code></strong> </a>is the client-side dependency package required for local Whisper speech recognition in the main mod.</p> <p><span style="color: #000000;">Starting with <span style="background-color: #f1c40f;">1.2.7</span>, ASR (speech recognition) is removed from the main mod to reduce its size. If needed, download the client-side-only mod above; no server installation is required.</span></p> </div> <div style="border-left: 4px solid #e03e2d; padding: 8px 12px; margin: 12px 0; background-color: #fff5f5;"> <p style="margin: 0 0 6px 0;"><span style="color: #e03e2d;"><strong>Critical Warning:</strong></span> Version <strong>1.0.0</strong> is a complete rewrite. If you choose to use this version, you will lose some features from previous versions and must clear the configuration files (located in the <strong>ModConfig</strong> folder).</p> </div> <h1>Feature List</h1> <h2>Voice Communication &amp; Playback</h2> <ol start="1" data-spread="false"> <li><strong>Voice Modes:</strong> Supports push-to-talk and voice activation with separate noise-gate and activation thresholds.</li> <li><strong>Voice Ranges:</strong> Supports whisper, normal, and shout modes with default ranges of 8, 18, and 35 blocks.</li> <li><strong>Send Targets:</strong> Supports nearby players, the current channel, or both, while preventing duplicate playback.</li> <li><strong>Spatial Audio:</strong> Proximity voice uses positional audio and distance attenuation; channel voice is not distance-dependent.</li> <li><strong>Voice Controls:</strong> Supports local mute, global voice rejection, per-player mute, and master/channel/player volume controls.</li> </ol> <h2>Audio Devices &amp; Processing</h2> <ol start="6" data-spread="false"> <li><strong>Audio Devices:</strong> Supports selectable input/output devices, Chinese OpenAL device names, and legacy garbled-name migration.</li> <li><strong>Microphone Processing:</strong> Provides high-pass filtering, automatic/manual gain, soft limiting, and noise gating with optional RNNoise.</li> <li><strong>Microphone Test:</strong> Supports in-memory recording and playback without creating files or uploading audio.</li> <li><strong>Device Recovery:</strong> Automatically retries failed capture and falls back to the game audio device when necessary.</li> <li><strong>Echo Cancellation:</strong> Not currently implemented; related configuration fields are retained only for compatibility.</li> </ol> <h2>Environmental Effects &amp; Performance</h2> <ol start="11" data-spread="false"> <li><strong>Environmental Effects:</strong> Supports block occlusion, underwater audio, helmets/masks, weather, low temporal stability, and poison effects.</li> <li><strong>State Detection:</strong> Underwater and equipment states are server-controlled, with wildcard equipment rules.</li> <li><strong>Occlusion Control:</strong> Clients can control local environmental effects, while servers can enforce occlusion.</li> <li><strong>Performance Mode:</strong> Reduces occlusion sampling and environment-state update frequency without changing the audio driver, sample rate, or Opus complexity.</li> </ol> <h2>Channels, Players &amp; UI</h2> <ol start="15" data-spread="false"> <