Back to mods
WhisperLib project artwork

Modrinth · Minecraft mod

WhisperLib

A fork of VoskLib that uses WhisperAI instead of VOSK for voice recognition

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which WhisperLib release matches 1.20.2 Forge?

Updated 8 months ago
beta file 1.0.0
Game version 1.20.1, 1.20.2, 1.20.3
Loader Forge

WhisperLib 1.0.0 targets 1.20.1, 1.20.2, 1.20.3 with Forge. It must be installed on the client. Do not install it on the dedicated server. No extra mods listed for this file.

Where it goes

Is WhisperLib required on the client, server, or both?

It must be installed on the client. Do not install it on the dedicated server.

Client Required
Dedicated server Not supported
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This file is marked client-only.

What else does WhisperLib 1.0.0 need?

1.0.0 on 1.20.2 Forge. Every mod below is checked against that same setup.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add WhisperLib without breaking your instance.

Built for WhisperLib 1.0.0 on 1.20.2 Forge. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.0.0. It targets 1.20.1, 1.20.2, 1.20.3 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    It must be installed on the client. Do not install it on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.0.0. It opens that exact file at the source.

About this project

What does WhisperLib add?

🎤 WhisperLib

An Event-based voice recognition mod that uses WhisperAI to transcript audio to text. Forked from VoskLib.


✨ Features

  1. Offline Recognition: Uses WhisperAI offline. No audio is sent to servers!
  2. Completely Client-side: The mod does not run WhisperAI to any Minecraft server.
  3. Built-in Model Manager: The mod includes a built-in Model Manager.
  4. Dynamic Loading: Displays avaliable models from HuggingFace.
  5. Adjustable Microphone Settings: Added settings screen to adjust mic related settings that wasn't in VoskLib yet.
  6. Security Feature: Immediately gets you notified when WhisperLib is listening.

📦 Installation for Users

  1. Download this mod from Curseforge.
  2. Launch the game and click Mods button.
  3. Locate WhisperLib and press Config.
  4. Select your model and press Download.
  5. After downloading, click your downloaded model.
  6. Pres Save & Exit.

That's it.


🔨 Installation for Developers

  1. Locate build.gradle.

  2. Add the following:

    dependencies {
        // ...your dependencies
        // Make sure it's in our Runtime (Do not shade these libraries)
        implementation 'io.github.givimad:whisper-jni:1.7.1'
        runtimeOnly 'io.github.givimad:whisper-jni:1.7.1'
    
        // Include the dev mod jar
        implementation fg.deobf(files("libs/whisperlib--dev.jar"))
    }
    
  3. Build the project and check if there's any issues.

  4. If there's, you can contact me via Curseforge PMs or GitHub issues.


🔌 WhisperLib API

// Start Listening
VoiceManager.startListening();

// Stop Listening
VoiceManager.stopListening();

WhisperLib and VoskLib are posting their results in Forge Event Bus at Client-side.

@Mod.EventBusSubscriber(modid = "examplemod", bus = Mod.EventBusSubscriber.Bus.FORGE, value = Dist.CLIENT)
public class VoiceEvents {
    @SubscribeEvent
    public static void onResult(WhisperVoiceResult event) {
        // Get the full text. 
        String result = event.getText();

        if (result.toLowerCase().contains("hello")) {
            System.out.println("Hi!");
        }

        // Use the following method to exclude messages like:
        // [MUSIC], [upbeat music], etc. (does not exclude *laughing*)

        String filteredText = event.getSpokenText();
        // do more processing...
    }
}

📜 Credits


Project description from Modrinth.

Pick your setup

WhisperLib by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

6 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

WhisperLib versions and loaders

1 of 1 releases match

Looking for an older file? The official Modrinth project page is in Resources.