client setup - FreshSupaSulley/CensorCraft GitHub Wiki

Warning

If you're looking to change server settings (like the list of forbidden words), you're in the wrong place! See the server setup page.

Prerequisites

This is a forge mod distributed through CurseForge. Make sure you have it installed!

This mod should run on most operating systems and architectures. In case it doesn't work for you, please open an issue.

Installation

Install CensorCraft here. Upon adding CensorCraft, CurseForge should automatically install simple voice chat as well. You'll get an error message if simple voice chat wasn't found or if there's a mismatching version issue.

Getting the best results

Make sure simple voice chat only activates when you're speaking by keeping the microphone away from any white noise. This way, you can minimize "hallucinations" when transcription results come back with random words from blank audio. Also, the latency is set to a fairly generous 1000ms, but change it to best match your computer's speed (see latency below).

Configuration

You can configure client-side settings in one of two ways:

Mod config menu

Designed for quick changes in-game. Syncs to censorcraft-client.toml. Here's how to access it:

step 1 step 2

censorcraft-client.toml

You can alternatively set the settings in this file, located at curseforge/minecraft/Instances/your_instance/config/censorcraft-client.toml. Not all settings in this file are shown in the mod config menu. Only tweak the transcription-related settings if you know what you're doing.

Config settings

Here's some of the config settings you're most likely to change:

Show transcriptions

By default, CensorCraft displays the speech-to-text results live on your screen. If you'd rather not see this, you can disable it anytime.

Latency

TL;DR: lower latency = faster results

Behind the scenes, CensorCraft breaks apart your live audio feed into individual recordings to transcribe your voice. Latency represents the delay (in milliseconds) between recordings. Lower latency means there are more recordings to process, and if your computer can keep up, you will get transcription results back faster. Raising the latency means you will get results back more slowly. Tinker with this value to get it just right for your machine.

⚠️ **GitHub.com Fallback** ⚠️