Shriek

Обновленная версия VoiceLib от Volcano Bay Studios, находящаяся в активной разработке

Реализация технологии распознавания речи, которая позволяет анализировать звук с микрофона и преобразовывать его в текстовые команды! Благодаря интеграции с движком Vosk, система поддерживает работу с несколькими языками, распознавая произносимые вами фразы.

Настройка зависимостей

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

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

Практическое использование

Основной API представлен классом ShriekApi со следующими основными методами:

import com.pryzmm.client.event.EventHandler;
EventHandler.setModel();
// Устанавливает языковую модель с сайта https://alphacephei.com/vosk/models
// Модели различаются по размеру: стандартная vosk-model-small-en-us-0.15 занимает около 40 МБ,
// тогда как большие модели вроде vosk-model-ru-0.10 могут достигать 2.5 ГБ

ShriekApi.registerServerPlayerSpeechListener(Consumer<ServerPlayerTalkEvent> consumer)
// Регистрирует обработчик событий голосовой активности игроков на сервере.
// Событие передает информацию об игроке и произнесенной им фразе.

ShriekApi.registerClientSpeechListener(Consumer<ClientTalkEvent> consumer)
// Обработчик клиентских речевых событий, активируется только на стороне игрока.

ShriekApi.setPrintToChat(boolean printToChat)
// Включает или отключает вывод голосовых команд в чат (по умолчанию выключено).

ShriekApi.setPrintToConsole(boolean printToConsole)
// Аналогичная настройка для консоли Minecraft.

Пример реализации

Настройка реакции сервера на словесную команду - при произнесении слова "ouch" игрок получает эффект возгорания:

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

Полный рабочий пример доступен в репозитории ShriekExample на GitHub.

Важные аспекты безопасности

• При первом запуске мод автоматически загружает языковую модель из интернета. Базовая модель около 40 Мб может вызвать кратковременную приостановку игры во время загрузки.
• Система постоянно записывает и передает звуковые данные на сервер, что позволяет администраторам прослушивать разговоры пользователей.
• Клавиша Push to Mute временно отключает микрофон при нажатии.
• Сторонние модификации могут управлять функцией записи звука.