Voice commands

Since 0.0.5 you can talk to the Great Sage. With a microphone, say his name and your request; with the keyboard, /sage followed by the request does exactly the same thing. Recognition runs entirely offline, on your own machine: no account, no server, no sound ever leaves your computer. The Sage answers in Japanese, in his own voice, and the subtitle follows your game language.

Requirements

• Carry the Great Sage (or a Raphael). Without it, neither the microphone nor /sage answers: "No answer. You do not carry the Great Sage."
• The sageInterface gamerule on (the default). See Gamerules.
• For the microphone: voice input turned on, and the recognition library (Vosk) with your language's model. /sage needs none of that.

Setting it up

1. Turn voice input on

In the Sage menu → Settings → Voice input, or voiceInput in greatsage-client.toml:

2. Pick your language

The first time you carry the Great Sage in a world, after five quiet seconds (no announcement, no open screen), a window asks which language you will speak to him in. Your game language is suggested first. Pick with the mouse, the arrow keys and Enter, or the number keys; Later or Escape puts the question off until the next launch. You can change the language at any time in Settings ("Recognition language"). Until one is chosen, he listens in English.

3. The download

As soon as voice input is no longer off, the mod fetches what is missing into .minecraft/greatsage-voice/, in the background, without blocking the game:

• the recognition library (Vosk 0.3.45 and JNA 5.13.0, ≈ 27 MB, only once), taken from Maven Central and checked against a known fingerprint before anything loads it;
• your language's model, from the official Vosk website.

A small progress bar shows up (even on the title screen) and the chat keeps you posted; at the end: "Great Sage can hear you." If voice stays off, nothing is ever downloaded. To install everything by hand, set voiceAutoDownload to false.

French and Spanish arrived in 0.0.6; Portuguese, Turkish, Vietnamese and Korean in 0.0.7 (early access).

Talking to the Sage

Wake word mode (wake)

Say "Great Sage" (or another wake word) then your request, in one breath if you like: "Great Sage, what is my race". The Sage gathers in small in the corner of the screen, a sound cue plays (voiceFeedback), and a listening ring empties during the listening window: listenWindowTicks, 120 ticks (6 seconds), extended as long as you keep talking. The request goes out after about 1.2 seconds of silence.

The config wake words (wakeWords: great sage, wise one, sage) are added to your language's own; a word the model does not know is ignored.

Push-to-talk mode (pushToTalk)

First bind the "Speak to Great Sage" key (unbound by default, Great Sage category in Controls). Hold it, say your request (the wake word is optional), let go: the request goes out right after. No ring: the Sage only appears with his answer. This is the mode that gets along best with a voice chat mod.

By keyboard: /sage

/sage <request> takes exactly the same path as the voice, with no microphone or library: /sage what is my existence value. On its own, /sage shows the usage and how many requests are understood. English is always understood, whatever language you picked.

What he understands

219 commands in eight families: your state, your skills and analyses, the creature you are looking at, your surroundings, your inventory and Predator's stomach, combat, and the mod itself. The full list, with what each one does: Voice command list.

• No exact wording needed: he tolerates rephrasing, stumbles and the odd wrong word.
• The grammar is built from your skills, the species you have observed and your inventory: he does not have to recognise the whole modpack, only what concerns you.
• A stop word ("stop", "disable"…) can never trigger a command that turns something on.
• Skill names follow the game language: a game in English with French recognition will struggle with "Predator".
• Below voiceConfidence (0.55), he would rather say "I did not understand." than guess.

Shutting him up

• "be quiet" cuts his voice; the panic key (Delete) stops everything, listening included.
• During a conversation, his spontaneous remarks stay silent.
• To hear nothing at all: Voice input set to off.

Settings

All except wakeWords can be changed on the Settings page. See also Configuration.