VoskLib

A library mod that ports VOSK to Minecraft

# 🎙️ VoskLib

VoskLib is a high-performance, offline voice recognition library for Minecraft Forge 1.20.1

✨ Features

• 100% Offline: No API keys or internet connection required for recognition.
• Dual Modes: Switch between Literal Mode (wide vocabulary) and Grammar Mode (constrained lists).
• In-Game Model Manager: Download and manage Vosk models directly from the mod config menu with a built-in progress bar.
• Thread Safe: Background audio processing automatically synchronized with the Minecraft main thread.
• Developer Friendly: Easy-to-use events for partial and final speech results.

🛠️ Installation for Users

1. Install Minecraft Forge 1.20.1.
2. Drop the jar file into your `mods` folder.
3. Download a Model:

• Open the game and go to Mods -> VoskLib -> Config.
• Select a model (Small, Medium, or Large) and click Download.
• VoskLib will handle the download and extraction automatically.

⌨️ Keybinds

• V (Default): Toggles voice recognition on/off.
• _Configurable in the standard Controls menu under the “Vosk Voice Library” category._

💻 Developer API

To use VoskLib in your project, add it to your `build.gradle` and start listening for events.

1\. Handling Speech Results

VoskLib fires events on the Forge Event Bus. These events are already executed on the Main Thread, so you can safely interact with the player or world.

@SubscribeEvent
public void onVoiceResult(VoskVoiceEvent.Result event) {
    String text = event.getResult().toLowerCase();

    if (text.contains("fireball")) {
        // Your logic: Summon a fireball in front of the player
    }
}

@SubscribeEvent
public void onPartialSpeech(VoskVoiceEvent.Partial event) {
    // Useful for real-time UI subtitles
    String partial = event.getResult();
}

2. Controlling the State

You can request VoskLib to start or stop listening by using:

String[] spells = {"ignite", "freeze", "thunder", "heal"};
VoskManager.createRecognition(spells); // Create Recognition for Grammar Mode (High Accuracy for specific words)
VoskManager.createRecognition(); // Create Recognition for Literal Mode (General Dictation)

VoskManager.startListening(); // Start Listening
VoskManager.stopListening(); // Stop Listening

📜 Credits

• Vosk API: Developed by Alpha Cephei.
• Mod Author: Infinity Two.