# 🎮 XuruVOIP Client User Guide Welcome to the **XuruVOIP Client Guide**! This guide is designed to help you set up and use the voice client while playing Star Citizen, even if you are not a computer expert. --- ## 🌟 What is the XuruVOIP Client? The **XuruVOIP Client** is an application that runs on your gaming computer. It works in the background to: 1. Capture your voice from your microphone. 2. Track your in-game character's position and environment. 3. Apply realistic sound effects (like making you sound like you are inside a space suit helmet or broadcasting your voice ship-wide). 4. Send your voice to other players near you or on your radio channels. --- ## 🛠️ Step 1: Initial Audio Setup When you open the client for the first time, you need to select your audio devices. 1. **Select your Microphone:** * Look for the **Microphone (Input Device)** dropdown menu. * Select the microphone you use for gaming. 2. **Select your Headphones/Speakers:** * Look for the **Playback (Output Device)** dropdown menu. * Select your headphones or speakers. 3. **Adjust Volume & Boost:** * **Microphone Gain (dB):** If your friends say you are too quiet, drag this slider to the right to boost your voice. If you are too loud, drag it to the left. * **Output Volume (%):** Adjusts how loud other players sound in your ears. * **Channel Volumes (%):** Adjust individual playback volume levels for each communication channel: * **Proximity Channel Volume:** Controls the volume of localized 3D voice chats. * **Radio Channel Volume:** Controls the volume of radio communications. * **Profile Channel Volume:** Controls the volume of custom profile channels. * **Channel Volumes (%):** Adjust individual playback volume levels for each communication channel: * **Proximity Channel Volume:** Controls the volume of localized 3D voice chats. * **Radio Channel Volume:** Controls the volume of radio communications. * **Profile Channel Volume:** Controls the volume of custom profile channels. --- ## 🎤 Step 2: Choosing How to Talk (PTT vs. VAD) You can choose between two methods to transmit your voice: ### Method A: Push-to-Talk (PTT) * **What it is:** You only transmit your voice when holding down a specific key on your keyboard. * **How to use it:** 1. Set the **Audio Mode** setting to **PTT**. 2. Click in the key binding box for the channel you want (e.g., **Proximity PTT Key** for people close to you, or **Radio PTT Key** for radio channels). 3. Press the key on your keyboard you want to use (like `Caps Lock` or `NumPad1`). 4. Hold that key down while speaking, and release it when you are done. ### Method B: Voice Activation (VAD) * **What it is:** The application listens to your voice and automatically transmits when it detects you speaking. * **How to use it:** 1. Set the **Audio Mode** setting to **VAD**. 2. Adjust the **VAD Sensitivity** slider. * **High Sensitivity:** Captures quiet whispers, but might accidentally transmit background noises (like keyboard clicks or fan noise). * **Low Sensitivity:** Prevents background noise, but you will need to speak louder to trigger it. --- ## 🚀 Immersive Features & How to Configure Them XuruVOIP includes special features that make voice communication match your gameplay: ### 🪖 1. Space Suit Helmet Modulation * **What it does:** When you put your helmet on in Star Citizen, it automatically alters your voice to sound like a digital radio transmission. It also overlays subtle suit breathing sounds. * **How to configure it:** * Go to **Settings** and check **Enable Helmet Modulator**. * You can manually toggle the helmet state using the **Helmet Toggle Key** (default is `H`). * If using automated logging, the app will read Star Citizen's game log to detect when you equip or remove your helmet and toggle the effect automatically! ### 🤢 2. G-Force & Physical Exertion voice distortion * **What it does:** Simulates physical strain on your character's voice. * **Tremolo:** If your character experiences high G-forces (e.g., during sharp turns in a spacecraft), your voice will shake/tremble. * **Pitch Shift:** High G-forces will make your voice sound deeper. * **Exertion Gasping:** If your character runs out of stamina (sprinted too much), the app automatically overlays heavy breathing/panting sounds over your microphone feed. * **How to configure it:** * Go to **Settings** and check **Enable G-Force & Exertion Voice Distortion**. * Make sure your Star Citizen directory configuration is correct so the app can read your character's stamina status in real-time. ### 📢 3. Ship Public Address (PA) System * **What it does:** Allows ship captains or crew members to broadcast a ship-wide message to everyone inside the same spaceship. * PA broadcasts bypass local proximity mutes (so everyone on board hears you). * Plays a Sci-Fi chime alert before you start speaking. * Adds a megaphone distortion filter to make it sound like it is coming from ceiling speakers. * **How to configure it:** * Go to **Settings** and check **Enable Ship PA System**. * Set a hotkey in the **PA Broadcast Key** box (default is `P`). * Press and hold the key to make a ship-wide announcement. ### 📡 4. Tactical Radio Repeaters * **What it does:** If you are too far away from someone to reach them directly over the radio, you can turn on **Repeater Mode**. This turns your client into a radio beacon, allowing other players to relay their signals through you to reach further distances. * **How to configure it:** * Go to **Settings** and check **Enable Radio Repeaters**. * To act as a repeater for your team, check the **Act as Radio Repeater Beacon** box. ### ⚡ 5. Dynamic Intercom Degradation (Ship Damage/Status) * **What it does:** Simulates communication interference when your spaceship takes shield damage, experiences power grid failures, or engages in Quantum Travel. This only affects intercom channels (channels starting with `Intercom_` that you automatically join when boarding a ship). * **Shield Hits Effect:** Injects a burst of static noise and crackles for 2.5 seconds when the ship's shields are hit. * **Critical Power Effect:** Injects an electrical AC hum (60Hz + harmonics), drops voice pitch (speed factor 0.78x), and applies heavy saturation distortion during power losses. * **Quantum Travel Effect:** Applies a flanger/phaser comb-filter sweep and a high-frequency whine when traveling in quantum. * **How to configure it:** * Go to **Settings** -> **General** tab. * Check the global option **Enable Intercom Degradation (Ship Damage)** (disabled by default). * Under it, you can toggle the individual sub-effects (**Shield Hits**, **Critical Power**, **Quantum Travel**) depending on your preferences. * When active, warning messages like `⚡ INTERCOM: POWER LOSS` or `⚡ INTERCOM: QUANTUM WAVE` will display on your HUD overlay. ### 🎙️ 6. Offline Voice Commands (Hands-Free PTT) * **What it does:** Allows you to hold a dedicated key to speak commands directly to your ship's onboard computer (like lowering/raising your helmet visor, muting/unmuting your microphone, changing radio channels, or switching voice changer profiles) without other players hearing you. * **Suppressed Transmit:** Holding the Voice Command key silences your proximity and radio voice streams, keeping your instructions private. * **Offline Transcription:** Uses an offline Whisper model to translate your speech into actions. * **Confidence Threshold:** A slider filter allows you to adjust how strictly the computer matches your voice commands. * **Supported Languages:** Localized matching dictionaries support English, French, German, Spanish, Portuguese, Japanese, and Chinese. * **How to configure it:** * Go to **Settings** -> **General** tab. * Check **Enable Voice Commands (Hands-Free PTT)** (disabled by default). * *Notice: Enabling this for the first time will automatically download the required Whisper speech-to-text model (~140MB) in the background.* * Go to the **Hotkeys** tab. * Assign a hotkey in the **Voice Command Key (PTT)** box (default is `V`). * Hold the key to speak (e.g. *"Computer, toggle visor"*, French: *"Ordinateur, basculer le casque"*, German: *"Kanal auf Alpha"*), and release it to execute. ### 📞 7. Ship-to-Ship Hailing & Calling * **What it does:** Allows you to place a private cockpit-to-cockpit call to another ship within 5,000 meters. The call operates on a private voice channel that overrides standard proximity and radio Push-to-Talk keys, enabling hands-free, voice-activated transmission during the call. * **How to configure it:** 1. Go to the **Hotkeys** tab in Settings. 2. Bind keys to **Initiate Hail**, **Accept Hail**, and **Decline/End Hail** (defaulted to `I`, `K`, and `X`). 3. When dialing, you will hear a dialing tone. The target will hear an incoming call ringing loop and see a tech-themed HUD notification. 4. Press the **Accept** key to answer, or **Decline** key to ignore/hang up. ### 🔤 8. Visor HUD Real-Time Translation Subtitles * **What it does:** Automatically translates incoming foreign-language voice streams in real-time and displays them on your Visor HUD overlay, prefixed with source and target languages (e.g., `[FR -> EN] Subtitle text`). * **How to configure it:** 1. Go to the **Overlay** tab in Settings. 2. Check **Enable Real-Time HUD Translation Subtitles** (disabled by default). 3. *Notice: If the Whisper speech-to-text model (~75MB) is not already present, enabling this feature will trigger a yellow warning notice and start downloading the model in the background.* 4. Once downloaded, incoming foreign spoken languages will translate automatically to your client's configured language (e.g., English, French, German, Spanish, Portuguese, Japanese, or Chinese). ### 🔌 9. External Hardware Telemetry (Sim-Pit UDP Sync) * **What it does:** Broadcasts client VoIP and helmet states in JSON format to `127.0.0.1:8895` (configurable) every 100ms. This allows physical simulator cockpits (sim-pits), custom LEDs, or external dashboard applications to sync in real-time with your VoIP status. * **How to configure it:** 1. Go to the **General** tab in Settings. 2. Check **Enable External Telemetry Broadcast (UDP)** (disabled by default). 3. Enter the target IP address and port (default is `127.0.0.1:8895`). ### 🪐 10. Planetary Atmosphere Density Simulation * **What it does:** Dynamically scales your proximity voice range and muffles outgoing audio based on the atmospheric density of the planet or moon you are currently on. Thin atmospheres like Cellin result in quick voice decay and muffling, while pressurized ship cabins or space stations bypass this simulation automatically. * **How to configure it:** 1. This system works automatically in the background by reading coordinate and environmental logs. 2. Ensure your Star Citizen installation path is set correctly in settings so `Game.log` can be parsed (you can use the **Auto-Detect** button next to the path box to find it automatically). ### 🎧 11. Binaural HRTF Spatial Audio * **What it does:** Simulates the physical shape of human ears and head shadow effects (ITD/ILD low-pass attenuation) to provide rich, immersive 3D spatial cues over ordinary stereo headphones. * **How to configure it:** 1. Go to the **Audio** tab in settings. 2. Check **Enable HRTF Binaural Rendering** (disabled by default). 3. (Optional) Toggle this on/off in real-time using companion controllers or Stream Deck actions. ### 📊 12. Visor HUD 3D Spectrogram * **What it does:** Computes a real-time Radix-2 64-point FFT on incoming speakers' voices and renders a 3D spectral analyzer overlay with smooth integrates decay next to their names on your HUD. * **How to configure it:** 1. Go to the **Overlay** tab in settings. 2. Check **Enable Visor HUD 3D Spectrogram** (disabled by default). ### 🎙️ 13. Voice-Activated Ship Controls * **What it does:** Allows you to control ship operations (Power, Doors, Shields, and Landing Gear) by speaking localized commands in any of 8 languages, simulating low-level hardware keypresses. * **How to configure it:** 1. Go to the **Hotkeys** tab in settings and map custom keys for Power, Doors, Shields, and Landing Gear. 2. Go to the **General** tab and check **Enable Voice Commands (Hands-Free PTT)**. 3. Assign and hold the **Voice Command Key (PTT)** (default: `V`), speak a command (e.g. "open doors"), and release the key. ### 🎛️ 14. Custom Vocal Preset Modulator Editor * **What it does:** Allows you to design your own custom sci-fi voice modulators using real-time sliders instead of relying on default presets. * **How to configure it:** 1. Go to the **Audio** tab in settings and check **Enable Custom Vocal Modulator**. 2. Tweak the exposed parameters: * **Pitch Shift:** Transpose your voice from 0.5x (deep alien) up to 2.0x (high-pitched). * **Ring Modulator Frequency & Mix:** Inject metallic, robotic textures. * **Flanger Depth, Rate, & Feedback:** Synthesize floating/phaser sweeps. * **Custom Bitcrush:** Discretize your voice down to low-fidelity bit depths (2 to 16 bits). ### 🪐 15. Planetary Distance-Based Radio Delay * **What it does:** Simulates actual radio transmission latency across planetary distances using the speed of light (~3.3ms per kilometer). * **How to configure it:** 1. Go to the **Audio** tab in settings. 2. Check **Enable Planetary Distance-Based Radio Delay**. When transmitting over long distances, you will notice a realistic delay before hearing remote players. ### 📁 16. Custom Radio PTT Chime Uploading * **What it does:** Allows you to override the default key-down and key-up radio chimes with your own custom WAV or MP3 files. * **How to configure it:** 1. Place your custom files in the `Resources/` folder next to the client executable, named `radio_key_down.wav` (or `.mp3`) and `radio_key_up.wav` (or `.mp3`). 2. Open client settings, go to the **Audio** tab, and check **Enable Custom PTT Chimes**. 3. The application will automatically downmix and resample your custom audio on load. ### 🛸 17. HUD 3D Radar Elevation Indicators * **What it does:** Upgrades the tactical mini-radar to show whether speaking players are located above or below your vertical position. * **How to configure it:** This works automatically when coordinate tracking is enabled. If a player speaking is 2 meters or more above or below your vertical position, an arrow (`▲` or `▼`) and the height difference in meters will append next to their blip label (e.g. `Bob (▲ 12m)`). ### 💬 18. In-App Speech Caption Logs Viewer * **What it does:** Displays a scrolling history of decoded proximity, radio, and profile channel captions, as well as offline voice commands, in a dedicated **Speech Captions** tab on the main window. * **How to configure it:** This works automatically. Ensure translation subtitles or voice commands are active, then select the **Speech Captions** tab on the main client console window to view the history (up to 30 past captions with timestamps and sender names). ### 🎙️ 19. Whisper Voice Command Calibration Wizard * **What it does:** Provides a dedicated testing panel to speak commands and preview transcription matching, confidence scores, and actions in real-time. Crucially, when calibration is active, all simulated game keystrokes are suppressed so you do not trigger ship controls during testing. * **How to configure it:** * Go to **Settings** -> **Voice Commands** tab. * Find the **Voice Command Calibration Wizard** panel. * Click **Start Calibration** (the button turns red and reads **Stop Calibration**). * Speak a command (e.g. *"computer, toggle visor"* or *"open doors"*). * The panel displays: * **Detected Text:** The transcribed output from the Whisper model. * **Confidence:** The similarity confidence score. * **Matched Action:** The resolved control binding that would ordinarily be triggered in-game. * Click **Stop Calibration** when done. ### 🤫 20. Whisper Mode (Stealth Comms) * **What it does:** Restricts your proximity voice range dynamically to a tight **10-meter** radius (both client and server) and applies audio filtering to optimize quiet whispering in combat zones. * **How to configure it:** * Toggle Whisper Mode in real-time using the **Alt + W** hotkey (default, customizable in the Hotkeys tab). * The state can also be toggled in the settings window under the **Acoustics** tab. * When active, a `(Whisper)` notice displays on your visor HUD overlay next to the microphone icon. ### 📸 21. Voice-Triggered In-Game Screenshot Capturer * **What it does:** Takes a screenshot of your active Star Citizen window client boundary when you speak a localized command (e.g. `"take screenshot"`, `"capturer ecran"`), saving it locally and flashing a green visor overlay confirmation. * **How to configure it:** * Turn on **Enable Voice Commands** under the General settings tab. * Hold your **Voice Command Key (PTT)** (default `V`), speak the command, and release it. * Captures are stored as PNG files inside the `/Screenshots` directory in the client installation folder. ### 🎙️ 22. Visor HUD Microphone Clipping Indicator * **What it does:** Monitors your microphone level and flashes a red warning border showing `🎙️ OVERGAIN / CLIPPING` on your visor overlay at 2Hz for 800ms when your capture audio clips. * **How to configure it:** * This is fully automated. If your mic is clipping, the warning displays on the HUD overlay. You can adjust your **Microphone Gain (dB)** slider in the Audio settings tab to prevent clipping. ### 📻 23. Custom Radio Squelch & Tone Generator * **What it does:** Restores the radio chime profile selection (Military, Industrial, Alien, Vintage) and adds manual frequency/duration sliders for the mechanical radio sounds. * **How to configure it:** * Go to Settings -> **Acoustics** tab. * Select your radio chirp preset in the **Radio Chime** dropdown. * Tweak **Tone Frequency (Hz)**, **Tone Duration (ms)**, and **Squelch Duration (ms)** sliders to design your custom chimes. ### 🎙️ 24. Local Voice Loopback Diagnostic Mode * **What it does:** Relays your own captured mic voice back through your headphones with a **200ms delay** to let you test and diagnose voice changers and sound levels. * **How to configure it:** * Go to Settings -> **Acoustics** tab. * Check **Local Mic Loopback Diagnostic** to turn on delayed side-tone playback. ### 🔊 25. Noise Gate DSP * **What it does:** Filters out background noise below a configurable volume threshold by suppressing mic audio. * **How to configure it:** * Under Settings -> **Audio** tab, check the **Enable Noise Gate** checkbox. * Use the threshold slider to adjust from -60 dB (more sensitive) to -20 dB (more aggressive). ### 🎙️ 26. Push-to-Talk (PTT) Latch Mode * **What it does:** Allows toggle-style voice transmission rather than holding down a PTT key. * **How to configure it:** * Go to Settings -> **General** or **Hotkeys** tab and check **Enable PTT Latch Mode**. * Press your Proximity or Radio PTT hotkey once to lock the channel open, and press it again to close it. ### 🗣️ 27. Text-To-Speech (TTS) Accessibility Relay * **What it does:** Plays incoming text captions, subtitles, notifications, and game chat exchanges locally to only the player using Windows Speech Synthesis. * **How to configure it:** * Go to Settings -> **Audio** tab and check **Enable Text-to-Speech (TTS) Accessibility Relay**. * Configures local speech synthesis volume and settings directly within the desktop UI. Runs entirely locally for security and privacy. ### 🤖 28. Voice Macro Sequence Executor * **What it does:** Triggers complex series of simulated hardware keystrokes in Star Citizen (such as VTOL toggles, speed limits, landing gear, and landing requests) using simple voice commands (e.g. `"prepare for landing"`). * **How to configure it:** * Ensure voice commands are enabled, hold your Voice Command Key (PTT), and speak a command sequence (e.g., `"computer, prepare for landing"` or `"computer, prepare for combat"`). ### 📞 29. Manufacturer-Specific Hailing Ringtone Profiles * **What it does:** Synthesizes corporate hailing chimes representing major ship manufacturers (Aegis, Anvil, Drake, Origin, RSI). * **How to configure it:** * Go to Settings -> **Audio** tab. Under **Hailing Ringtone Profile**, select a profile from the dropdown list. ### 🎙️ 30. Interactive Audio Calibration Wizard * **What it does:** Records a rolling 5-second audio buffer of the local microphone, applying current voice modulations and playing it back locally for diagnostic testing. * **How to configure it:** * Go to Settings -> **Audio** tab. Click **Record Test Audio** to begin recording, then **Play Test Audio** to play it back. ### 📊 31. Companion App RSSI Canvas Graph * **What it does:** Plots a real-time network diagnostics graph showing RSSI, latency, jitter, and packet loss on the Companion App web interface. * **How to configure it:** * Connect to the Companion App from any browser and click the new **Network** tab to view the scrolling canvas-based network graph. ### 🎙️ 32. Voice Wake-Word Engine * **What it does:** Allows hands-free activation of offline voice commands without holding down a PTT key by transcribing local voice segments and matching the wake-word trigger. * **How to configure it:** * Under Settings -> **General** tab, check the **Enable Wake-Word Engine** checkbox. Speak commands starting with the wake word (e.g., `"Computer, open cargo doors"`). --- ## 📱 Using the Companion App The Companion App allows you to control XuruVOIP from your smartphone, tablet, or secondary monitor browser. 1. **Enable it:** Go to **Settings**, check **Enable Companion HTTP Server**, and set a port (default: `8891`). 2. **Enable Tactical Map Mode (Optional):** Check the box **Enable Tactical Co-Pilot Map (MFD)** (disabled by default) to stream location coordinates and enable the radar screen tab on the companion interface. 3. **Access it:** Open any web browser on your device and type `http://localhost:8891` (if on the same PC) or `http://[Your-PC-IP-Address]:8891` (if on your phone connected to the same Wi-Fi). Alternatively, you can click the **Show QR** button next to the companion port field in Settings to show a connection QR code and copy the exact connection link, letting you easily connect from any phone or tablet on your network. 4. **Features & Layout:** * **🎛️ Controls Tab:** Toggle mic/audio mutes, helmet modulation, PA broadcasts, adjust channel volumes (Proximity, Radio, Profile), select active radio channels, select voice changer profiles, or mock test G-Force/Exertion stress levels. * **🗺️ Tactical Map Tab (MFD):** * Displays a sci-fi glassmorphic radar screen tracking your local position. * Renders other crew members and players inside your same container/zone. * Displays real-time speaking status (pulsating green rings around active speakers). * Includes **Heading-Up** (map rotates with your movement direction) and **North-Up** orientation modes. * Range slider to adjust radar zoom levels from 10 meters up to 1000 meters. * **📊 Network Diagnostics Tab:** Displays a real-time canvas-based network quality graph plotting latency (ms), jitter, packet loss, and simulated RSSI signal strength to monitor stability. * **📱 OLED High-Contrast Theme:** Toggle the OLED button in the app header to switch the interface to a pitch-black (#000000) flat theme. This theme choice is persisted across refreshes using browser localStorage. --- ## 🔌 External Hardware Telemetry (Sim-Pits & Custom Hardware) For players with custom cockpit simulator setups (sim-pits) or external displays, XuruVOIP can broadcast real-time telemetry. 1. **Enable it:** Go to **Settings**, check **Enable Telemetry Broadcast (UDP)**, and set a port (default: `8895`). 2. **How it works:** The client will broadcast a JSON payload over UDP to `127.0.0.1:8895` every 100ms. 3. **Use cases:** Cockpit builders can use simple Arduino, Raspberry Pi, or Stream Deck plugins to read these packets and light up physical LEDs when receiving or transmitting radio messages, or when the suit visor is down. --- ## ❓ Troubleshooting (FAQ) ### My friends cannot hear me! * Make sure your **Microphone (Input Device)** selection matches your active microphone. * If using **PTT**, make sure you are holding the correct key and that the microphone level bar (VU meter) lights up when you speak. * If using **VAD**, try increasing the **VAD Sensitivity** so it triggers more easily. ### The space suit helmet mode does not toggle automatically. * Verify that your game directory path is set correctly in settings. You can click **Auto-Detect** to find it automatically. The app needs access to Star Citizen's `Game.log` file to detect helmet actions automatically. ### The overlay is blocking my clicks in the game. * The HUD overlay is designed to be completely click-through, but make sure Star Citizen is running in **Borderless Windowed** mode (not Exclusive Fullscreen) for the best results.