🎙️ DreamVoice

The ultimate spatial audio, acoustic physics & speech intelligence expansion for Simple Voice Chat on Minecraft (Paper & Fabric)!

Bring real sound physics, soundproof rooms, offline AI speech recognition, keyword spotting, 3D directional speakers, covert spy microphones, walkie-talkie radios, hot-loadable DSP voice filters, real-time acoustic visualizer, and playable audio cassette tapes directly into your Minecraft server.

---

🌟 What is DreamVoice?

DreamVoice transforms proximity voice chat into a truly immersive, next-generation audio experience. Designed for Roleplay servers, Survival SMPs, Investigation & Mystery games, and Narrative Minigames, it bridges the gap between Minecraft mechanics and real-world audio physics and speech recognition.

With full first-class support for both Paper / Purpur servers (as a plugin) and Fabric servers (as a mod), sound no longer magically passes through thick walls—it bends around open doorways, muffles through solid materials, attenuates inside soundproof rooms, and interacts realistically with the environment.

Players can trigger in-game events by speaking keywords out loud, analyze recorded tapes on lecterns to generate written books, inspect acoustics in real-time with an in-game 3D visualizer, and export audio into MP3/OGG/WAV files. External survival and tech mods can even create craftable speakers, spy bugs, walkie-talkies, and cassette players that interface seamlessly with DreamVoice.

---

✨ Core Features

🧱 1. Realistic Sound Physics & Soundproof Walls (VoiceWall)

• Smart Sound Occlusion: Sound realistically stops or muffles behind solid stone, wood, glass, and metal blocks (STRICT_BLOCK or REALISTIC).
• Acoustic Pathfinding & Diffraction: Sound naturally travels through open doors, windows, and bends around corners.
• High-Frequency Air Damping: Distant voices naturally lose high frequencies, sounding warmer and muffled through open air over distance.
• Visual Particle Debugging: Check raycast sound propagation in real-time with visual particles and action bar stats via /voicewall debug [player].

👁️ 2. Real-Time 3D Acoustic Visualizer (/voice visualizer)

• Live 3D Raycasting: Renders dynamic particle streams in real-time showing line-of-sight sound paths, wall collision impacts, aperture diffraction routes, and speaker audible coverage spheres.
• Performance-Conscious Hand-Held Mode: To protect client FPS and eliminate visual clutter, particles render only when the inspecting player holds the visualizer tool (Compass) in their main hand.

🏰 3. Acoustic Rooms & Soundproof Zones

• Soundproof & Reverberant Zones: Define spatial cuboids with custom isolation percentages (isolationPct) and reverb parameters (decay, roomSizeMs, wetGain).
• Acoustic Presets: Comes with built-in presets (soundproof, studio, cathedral, bunker).
• Dynamic Filter Stacking: Automatically applies vocal effects (e.g., muffled, echo, cave reverb) upon entering specific rooms and removes them upon exit.

🗣️ 4. Speech Recognition & Real-Time Keyword Spotting (KWS)

• Real-Time Keyword Spotting: Lightweight background keyword detection powered by offline Vosk models with constrained grammar ([unk], zero hallucinations).
• Voice-Activated Events: Triggers events for custom roleplay spells, voice-activated doors, passphrases, and minigame mechanics.
• Smart Audio Gating: RMS noise gate (minEnergyThreshold) and automatic phonetic buffer clearance on pauses (silenceResetMs) to eliminate phantom detections.
• Interactive Cassette Transcription Stations: Right-click a Lectern or Jukebox with an audio cassette to analyze speech and receive a paginated Written Book with timestamps and speaker names.
• Hybrid Engine: Works 100% offline inside the JVM (Vosk) or can offload transcription to an external Whisper Sidecar container.

📢 5. 3D Locational Speakers & Physical Broadcasts

• Place directional 3D speakers anywhere in your world at static coordinates.
• Attach to Entities: Mount speakers to moving vehicles, drones, ArmorStands, or NPCs!
• Dual Channels: Speak through a microphone while playing background music/sound effects simultaneously with zero collision.
• Podium & Intercom Broadcasts: Broadcast points route voices within a capture radius to target speakers or across the whole server.

👻 6. Voice Projections & Security Cameras

• Project your voice remotely to any target block or moving entity.
• Hear what the camera or remote point hears—ideal for CCTV security cameras, intercoms, surveillance drones, or magical projections.

🕵️ 7. Covert Wiretaps & Spy Bugs

• Plant hidden microphones at secret coordinates or mount a bug directly on an NPC or player.
• Listen in real-time to secret conversations or record them directly to an in-game cassette tape!
• Cross-Module Propagation: Wiretaps realistically intercept voices emitted from voice projections.

📼 8. Audio Cassettes & Multi-Format Audio Export

• Record live voice conversations with zero-CPU direct Opus streaming (OpusAudioPlayer).
• Generates a physical Cassette item that players can hold and play with a right-click or load into 3D speakers.
• Async Audio Export: Export any session recording directly into MP3, OGG, or WAV files via /record export.
• Timeline Slicing: Extract specific segments or the final N seconds from any recording (/record slice).

📻 9. Walkie-Talkies & Radio Channels

• Connect players to specific radio frequency channels for team tactical comms, police dispatch, or survival walkie-talkies.
• Authentic analog band-pass filter (300 Hz - 3400 Hz) with push-to-talk mic clicks.
• Directional Transmitters: Point-to-point voice transmission with customizable ranges.

🎛️ 10. Dynamic DSP Voice Filters & File-First Pipeline

• Transform player voices on the fly with 13 built-in filters (alien, cave, deep, disguise, gasmask, ghost, helium, megaphone, muffled, radio, robot, telephone, underwater).
• Hot-Reloadable Files (.yml, .json, .java):
  • Declarative DSP pipelines (lowpass, highpass, gain, overdrive, ring_modulator, delay/echo).
  • On-the-fly JDK compilation for custom .java filter source files.
• Filter Exporter: Export active filters into pipeline YAML/JSON or Java source files (/voice filter export).
• Built-in Soft-Knee Dynamic Limiter prevents microphone clipping and distortion.

🛠️ 11. Interactive Configuration GUI (/voice config)

• Open a full visual GUI dashboard to configure and monitor all modules without touching config files.
• Interactive tool (Echo Shard) to target entities, blocks, or positions in real-time.

📡 12. Fabric Network Packets & Inter-Mod Ecosystem

• 40+ custom packets (@DreamPacket) allowing third-party survival, tech, and companion mods to create and control speakers, wiretaps, radios, cassettes, and filters without hard compile dependencies.

---

🕹️ Quick Commands Reference

Command	Description
/dv status	Displays system status and active module counts
/voice config	Opens the interactive visual configuration GUI
/voice visualizer [toggle|on|off]	Toggles 3D acoustic visualizer (hand-held tool required)
/dv reload [all|config|data]	Reloads configuration, saved data, or both
/voicewall mode <strict|realistic|off>	Changes soundproof wall physics mode
/voicewall debug [player]	Toggles visual particle sound path diagnostics
/voice room list / /voice room info <id>	Lists and inspects acoustic rooms
/voice room reload	Reloads acoustic room presets and definitions
/voice filter list / /voice filter reload	Lists active voice filters and reloads files
/voice filter export <filter> <yml|json|java>	Exports a voice filter to YAML, JSON, or Java
/voice speech download <lang>	Downloads an official speech recognition model (small or big)
/voice speech models / /voice speech setmodel <id>	Lists installed speech models and sets active model
/voice speech transcribe <id> [book|chat]	Transcribes a voice recording into a book or chat
/voice speech debug	Toggles realtime speech & keyword debug notifications
/speaker create <name> [dist] [mode]	Creates a 3D speaker at your position
/speaker play <name> <source>	Plays audio, recording, or web URL through the speaker
/speaker link <name> [player]	Links player microphone to broadcast through speaker
/wiretap create <name> [dist]	Places a covert wiretap listening bug
/wiretap listen <name>	Connects a player to live wiretap eavesdropping
/wiretap record <name>	Records secret audio and creates a cassette
/projection create <name> [target]	Creates a voice projection / body anchor
/radio join <channel> / /radio leave	Tunes into or leaves a radio frequency channel
/transmitter toggle / /transmitter add <player>	Manages point-to-point voice transmitter
/record start <name> / /record stop <name>	Records voice and saves .dv binary capture
/record cassette <name>	Gives a physical, playable Cassette item
/record export <id> <mp3|ogg|wav> [file]	Exports a recording to MP3, OGG, or WAV

---

📦 Installation

For Paper / Purpur Servers:

1. Make sure your server runs Paper or Purpur (version 26.1.2+ with Java 25+).
2. Install Simple Voice Chat (2.6.20+).
3. Drop DreamVoice.jar into your server's plugins/ directory.
4. Restart your server.

For Fabric Servers:

1. Make sure your server runs Fabric Loader 0.19.3+ for Minecraft 26.1.2+ with Java 25+.
2. Install Fabric API and Simple Voice Chat Fabric.
3. Drop DreamVoice-fabric-2.0.1.jar into your server's mods/ directory.
4. Restart your server.

---

💻 Developer API

DreamVoice includes a unified public API (DreamVoiceAPI.get()) to build custom plugins, Fabric mods, and minigames.

📦 Gradle Kotlin DSL (build.gradle.kts)

repositories {
    mavenCentral()
    maven("https://jitpack.io")
    maven("https://repo.papermc.io/repository/maven-public/")
}

dependencies {
    compileOnly("com.github.Dreamin-MC.DreamVoice:api:2.0.1")
}

📦 Gradle Groovy (build.gradle)

repositories {
    mavenCentral()
    maven { url = "https://jitpack.io" }
    maven { url = "https://repo.papermc.io/repository/maven-public/" }
}

dependencies {
    compileOnly "com.github.Dreamin-MC.DreamVoice:api:2.0.1"
}

📦 Fabric Mod Setup (Fabric Loom)

repositories {
    mavenCentral()
    maven { url = "https://jitpack.io" }
}

dependencies {
    modCompileOnly "com.github.Dreamin-MC.DreamVoice:api:2.0.1"
}

📦 Maven (pom.xml)

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
    <repository>
        <id>papermc</id>
        <url>https://repo.papermc.io/repository/maven-public/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.Dreamin-MC.DreamVoice</groupId>
        <artifactId>api</artifactId>
        <version>2.0.1</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

---

📄 License & Links

• Source Code: GitHub - Dreamin-MC/DreamVoice
• Official Wiki & Guides: DreamVoice Wiki
• JavaDoc API: GitHub Pages - DreamVoice API
• License: GNU General Public License v3.0