CurseForge · Minecraft mod
VoiceLib
Minecraft Text To Speech Library
Quick answer
Which VoiceLib release should I use?
voicelib-fabric-1.0.0.jar targets 1.21.1 with Fabric. The project page does not say whether this file belongs on the client, dedicated server, or both. All 2 required mods have matching files.
Where it goes
Is VoiceLib required on the client, server, or both?
The project page does not say whether this file belongs on the client, dedicated server, or both.
The source does not explicitly classify this release as client-only or server-only.
What else does voicelib-fabric-1.0.0.jar need?
voicelib-fabric-1.0.0.jar. Change the file and its required mods may change too.
Install Architectury API, Fabric API first. We found matching files for this game-version and loader setup. 1 comes through another mod in the chain.
1 extra mod was pulled in by another dependency. Indented rows show who needs each one. We only count dependency files that match this setup. A file for another loader does not fill the gap.
Before you install it
Add VoiceLib without breaking your instance.
Built for voicelib-fabric-1.0.0.jar. Pick another file and the loader, install side or required mods may change.
- 01
Stick to this file
Use voicelib-fabric-1.0.0.jar. It targets 1.21.1 with Fabric; another release may have different loader, side or dependency requirements.
- 02
Bring the mods it needs
Install Architectury API, Fabric API first. We found matching files for this game-version and loader setup. 1 comes through another mod in the chain.
- 03
Put it on the correct side
The project page does not say whether this file belongs on the client, dedicated server, or both.
- 04
Pick the file you checked
Use the “Get this file” button beside voicelib-fabric-1.0.0.jar. It opens that exact file at the source.
About this project
What does VoiceLib add?
VoiceLib
Minecraft text to speech library
Usage
VoiceLibApi is the class for the API. The following are the methods you will be using
VoiceLibApi.registerServerPlayerSpeechListener(Consumer<ServerPlayerTalkEvent> consumer)
This method registers a ServerPLayerTalkEvent Consumer. Whenever a player speaks,
This event will be fired. The ServerPlayerTalkEvent provides the player, and a string of what they said.
VoiceLibApi.registerClientSpeechListener(Consumer<ClientTalkEvent> consumer)
This method registers a ClientTalkEvent Consumer. This method is only fired on the client.
Whenever the user speaks, this will be fired.
VoiceLibApi.setPrintToChat(boolean printToChat)
This is only on the client. This sets whether or not to
print client speak events to chat. (Default False)
VoiceLibApi.setPrintToConsole(boolean printToConsole)
Same as printToChat but for the console instead. (Default False)
All methods have java docs for information on their usages.
Example
This method makes it so if any player on the server says "ouch" they light on fire
VoiceLibApi.registerServerPlayerSpeechListener((serverPlayerTalkEvent -> {
if (serverPlayerTalkEvent.getText().contains("ouch"))
serverPlayerTalkEvent.getPlayer().igniteForSeconds(2);
}));
You can also see this in VoiceLibExample
Security
There are a few things to note with this mod,
- The mod automatically downloads a vosk model from the internet on the first launch, it is about 40MB
- This mod by default, constantly records and sends all text data to the server. This means a bad actor could listen in on your conversations (But only in text as audio is not sent to the server)
- The push to talk key is inverted by default, this means pressing it turns OFF your microphone
- Other mods can forcefully enable always on recording, they can also disable it (See VoiceLibClient)
Project description from CurseForge.
Pick your setup
VoiceLib by Minecraft version and loader
Choose the version and loader you play, then open the matching release.
1.21.1
2 loader buildsCheck the dependencies, then try the file in a copied instance before changing a world you care about.
Recent files
VoiceLib versions and loaders
voicelib-fabric-1.0.0.jar
19 Aug 2024
voicelib-neoforge-1.0.0.jar
19 Aug 2024
Looking for an older file? The official CurseForge project page is in Resources.
