Shriek

An actively maintained version of VoiceLib from Volcano Bay Studios

A speech recognition implementation that processes microphone input and converts it to text commands! Thanks to integration with the Vosk engine, the system supports multiple languages, recognizing phrases you speak.

Dependency Setup

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
    }
}

dependencies {
    modImplementation "maven.modrinth:shriek:1.1.01+fabric"
}

Practical Usage

The main API is represented by the ShriekApi class with the following core methods:

import com.pryzmm.client.event.EventHandler;
EventHandler.setModel();
// Sets the language model from https://alphacephei.com/vosk/models
// Models vary in size: the standard vosk-model-small-en-us-0.15 takes about 40 MB,
// while larger models like vosk-model-ru-0.10 can reach 2.5 GB

ShriekApi.registerServerPlayerSpeechListener(Consumer<ServerPlayerTalkEvent> consumer)
// Registers server-side player speech event handler.
// The event provides player information and spoken phrase.

ShriekApi.registerClientSpeechListener(Consumer<ClientTalkEvent> consumer)
// Client-side speech event handler, activates only on player's side.

ShriekApi.setPrintToChat(boolean printToChat)
// Enables or disables voice command output in chat (disabled by default).

ShriekApi.setPrintToConsole(boolean printToConsole)
// Similar setting for Minecraft console.

Implementation Example

Server response setup for voice command - when player says "ouch", they get fire effect:

ShriekApi.registerServerPlayerSpeechListener((serverPlayerTalkEvent -> {
    if (serverPlayerTalkEvent.getText().contains("ouch"))
        serverPlayerTalkEvent.getPlayer().igniteForSeconds(2);
}));

Full working example is available in ShriekExample repository on GitHub.

Important Security Considerations

• On first launch, the mod automatically downloads language model from internet. The basic 40 MB model may cause temporary game freeze during loading.
• The system constantly records and transmits audio data to server, allowing administrators to monitor user conversations.
• Push to Mute key temporarily disables microphone when pressed.
• Third-party modifications can control recording functionality.