Home

DreamVoice Documentation

DreamVoice is a high-performance, modular voice and acoustics engine designed for Paper / Purpur 26.1.2+ and Fabric 26.1.2+ powered by Simple Voice Chat (SVC) 2.6.20+. It transforms voice communication in Minecraft with realistic sound occlusion, soundproof rooms, physical audio cassettes, 3D spatial speakers, wiretaps, walkie-talkies, speech-to-text with realtime keyword spotting, file-first DSP voice filters, and a real-time acoustic visualizer.

---

Key Features

• Dual-Platform Architecture: Full first-class support for both Paper / Purpur servers (as a plugin) and Fabric servers (as a mod), sharing an identical high-performance core engine and API.
• VoiceWall Acoustic Engine: Real-time sound occlusion through walls, aperture diffraction around doors, and high-frequency air damping over distance.
• Acoustic Visualizer Mode: Live 3D particle raycasting displaying direct line-of-sight sound paths, wall hits, aperture diffraction routes, and speaker audible bubbles in real time (visible only when holding the visualizer tool in hand).
• Acoustic Rooms & Soundproofing: Define soundproof zones and acoustic presets (Cuboid) with isolation percentages, spatial reverberation, and automatic room voice filters.
• 3D Spatial Speakers: Dual-channel speakers (live voice relay and background music/SFX simultaneously) with static placement or dynamic entity attachment.
• Voice Projections: Decouple the player's voice origin to project from virtual anchors, security CCTV cameras, or drones, with unilateral or bilateral audio.
• Wiretaps & Surveillance: Place hidden listening bugs on blocks or entities, eavesdrop across infinite distance, and record conversations directly to physical cassette items.
• Radios & Transmitters: Frequency-based walkie-talkies with analog band-pass filters, push-to-talk mic clicks, and directional transmitters.
• Audio Recordings & Cassettes: Zero-CPU direct Opus streaming (OpusAudioPlayer) saving 100% transcoding CPU, interactive cassette items with NBT metadata, MP3/OGG/WAV audio export, and precise timeline slicing.
• DSP Voice Filters & File-First Pipeline: 13 built-in filters with hot-reloading from modules/filter/filters/, declarative .yml/.json DSP graphs, and live .java compilation via JDK JavaCompiler.
• Speech-to-Text & Realtime Keyword Spotting (KWS): On-the-fly speech keyword detection powered by Vosk constrained grammar, interactive cassette transcription stations generating written books, and FastAPI / faster-whisper sidecar integration.
• Inter-Mod Communication & Fabric Packets: Comprehensive network packet protocol (@DreamPacket) allowing external mods (e.g., survival crafting, tech devices, spy gadgets) and client addons to control DreamVoice subsystems seamlessly.
• DreamAPI Integration: Native localization via LangService (automatic player locale resolution) and VoiceItemHandler for custom item action bindings.
• Modular Storage & Hot Migration: Clean per-module directory structure (modules/<module>/) with independent auto-save intervals and zero-loss hot migration on startup.

---

Quick Start Guide

1. Requirements

• Minecraft Server running Paper / Purpur 26.1.2+ OR Fabric Loader 0.19.3+ (Minecraft 26.1.2+).
• Java 25 or higher.
• Simple Voice Chat (v2.6.20+ or fabric-2.6.24+26.1.2).
• On Fabric: Fabric API and Fabric Language Kotlin (if applicable).
• Optional: DreamAPI for rich localization and item handler bindings.

2. Installation

For Paper / Purpur Servers:

1. Place DreamVoice-paper-2.0.1.jar into your server's plugins/ directory.
2. Ensure voicechat is installed and properly configured with its UDP port open.
3. Start or restart the server.
4. Verify loading in the server console:

   [DreamVoice] Enabling DreamVoice v2.0.1
   [DreamVoice] Simple Voice Chat compatibility layer initialized.
   

For Fabric Servers:

1. Place DreamVoice-fabric-2.0.1.jar into your server's mods/ directory.
2. Ensure voicechat-fabric and fabric-api are installed in mods/.
3. Start or restart the server.
4. Verify loading in the server console:

   [DreamVoice] Initializing DreamVoice Fabric v2.0.1
   [DreamVoice] Fabric networking packets registered successfully.
   

3. First Verification in Game

• Verify status: /dv status
• Inspect acoustic visualizer: Hold a compass or visualizer tool in your main hand and run /voice visualizer to view real-time particle rays and speaker ranges.
• Test wall acoustics: Stand behind a wall with another player and run /voicewall debug to inspect real-time raycasting and Action Bar diagnostics.
• Test speech models: Run /voice speech models and download an offline model via /voice speech download fr or /voice speech download en.
• Open configuration GUI: Run /voice config to inspect and configure modules visually.

---

Documentation Directory

Section	Description
Commands & Permissions	Full command syntax, argument breakdown, and permission nodes across Paper and Fabric.
Configuration Guide	Modular storage architecture, acoustic physics parameters, and persistence settings.
VoiceWall Acoustic Engine	Sound occlusion modes, aperture diffraction, and Action Bar diagnostics.
Acoustic Rooms & Soundproofing	Cuboid acoustic zones, soundproof presets, reverberation, and automatic room filter stacking.
3D Spatial Speakers	Dual-channel playback, entity tracking, and bulk operations.
Voice Projections	Remote voice anchors, CCTV relays, and bilateral listening.
Wiretaps & Surveillance	Covert bugs, entity surveillance, and live cassette recording.
Radios & Transmitters	Multi-user frequencies, analog filters, and directional transmitters.
Recordings & Cassettes	Direct Opus streaming, .dv format, audio export (MP3/OGG/WAV), and interactive cassette items.
DSP Voice Filters	File-first filters (.yml, .json, .java), exporter engine, and DSP pipeline nodes.
Speech & Keyword Spotting	Realtime Vosk KWS, constrained grammar, transcription stations, and Whisper sidecar.
Developer API Guide	Unified DreamVoiceAPI.get() locator, Maven/Gradle setup, and VoiceItemHandler.
Events & Hooks Reference	Complete catalog of events: Bukkit listeners (Paper) and DreamVoiceEvents.VOICE_EVENT (Fabric).
Network Packets & Protocols	Custom Fabric packet payloads (@DreamPacket) for survival mods, client integrations, and tech devices.
Troubleshooting & FAQ	Common configuration pitfalls, audio fixes, network ports, and permissions.