🎙️ DreamVoice

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

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, 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 (e.g. Danganronpa), and Narrative Minigames, it bridges the gap between Minecraft mechanics and real-world audio physics and speech recognition.

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 now trigger in-game events by speaking keywords out loud, analyze recorded tapes on lecterns to generate written books, and export audio into MP3/OGG/WAV files.

✨ 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: Sound naturally travels through open doors, windows, and bends around corners.
• Visual Particle Debugging: Check raycast sound propagation in real-time with visual particles and action bar stats via /voicewall debug [player].

🏰 2. Acoustic Rooms & Soundproof Zones

• Soundproof & Reverberant Zones: Define spatial cuboids with custom isolation percentages (isolation_pct) 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) upon entering specific rooms.

🗣️ 3. 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 the VoiceKeywordSpokenEvent for custom roleplay spells, voice-activated doors, passphrases, and minigame mechanics.
• Smart Audio Gating: RMS noise gate (min_energy_threshold) and automatic phonetic buffer clearance on pauses (silence_reset_ms) 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 (Material.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.

📢 4. 3D Locational Speakers

• 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.

👻 5. 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.

🕵️ 6. 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!

📼 7. Audio Cassettes & Multi-Format Audio Export

• Record live voice conversations or stream audio from external MP3 links.
• 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.

📻 8. Walkie-Talkies & Radio Channels

• Connect players to specific radio frequency channels for team tactical comms, police dispatch, or survival walkie-talkies.
• Configurable end-of-transmission Roger Beep sound effects and customizable audio filters.

🎛️ 9. Dynamic DSP Voice Filters & Dynamic Pipelines

• 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.

🎒 10. DreamAPI Integration & Modular Storage

• VoiceItemHandler: Seamlessly bind voice filters or radio channels to custom items (armor equip, held items, right-click triggers).
• Modular Storage: Clean per-module directory layout under plugins/DreamVoice/modules/ with independent auto-save schedules.
• Full Localization: Integrated with DreamAPI's LangService for per-player client locale resolution.

🕹️ Quick Commands Reference

📦 Installation

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

💻 Developer API

DreamVoice includes a comprehensive public API to build custom addons, register dynamic voice filters, and handle speech events.

📦 Gradle (JitPack)

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

dependencies {
  compileOnly 'com.github.Dreamin-MC.DreamVoice:api:2.0.0'
}

📦 Maven (JitPack)

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

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

repositories {
  maven {
    name = "GitHubPackages"
    url = uri("https://maven.pkg.github.com/Dreamin-MC/DreamVoice")
    credentials {
      username = System.getenv("GITHUB_ACTOR") ?: project.findProperty("gpr.user") ?: ""
      password = System.getenv("GITHUB_TOKEN") ?: project.findProperty("gpr.token") ?: ""
    }
  }
}

dependencies {
  compileOnly 'fr.dreamin:dreamvoice-api:2.0.0'
}

📄 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