Candy Logo Copyright © 2025-2026 Candy Arts
Voice Mode
Voice mode plays voice files (or TTS) only: no text, portrait or speaker label is displayed. Lines are spoken by the standalone Voice player: the "voice_player_path" entry of ui_elements_paths. Since nothing is written, the typewriter settings (writing speeds, sync_write_speed_voice) and the text settings (BBCode, speaker name, end-of-line string) don't apply in Voice mode. Engine Settings The following settings are available in the Engine (Candy_Engine.gd):
SettingPurpose
lexicon_voice_modeReplace Lexicon keywords with their "Display" value before the Line is read by TTS ("Simple" TTS mode).
auto_advanceSeconds to wait before automatically advancing to the next Line. -1: Disable (manual advance only). 0: Advance immediately.
auto_advance_per_characterSeconds added to auto_advance for each character the Line would display (e.g. 0.05 adds 5 seconds to a 100-character Line). Ignored when auto_advance is -1.
enable_voicePlay voice files or TTS for Spoken Lines.
await_voice_playbackDisable advancing until voice playback has finished.
default_voice_extensionDefault file extension to use when a voice file name is provided without one.
text_to_speechText-To-Speech: "Off": Don't use Text-To-Speech. "Simple": Use the spoken text (without BBCode tags) for Text-To-Speech. "Advanced": Use the _TTS Variation for Text-To-Speech. Additional TTS modes are created in the tts() hook function (Tts.gd).
tts_advanced_fallbackThe TTS mode to use instead of "Advanced" when a Line has no "_TTS" Variation. Without TTS modes of your own, the only values are "Simple" and "Off".
llm_modeQuery an LLM to write the text to speak.
write_dialogue_historyLog Spoken Lines in the Dialogue History.
UI Settings The following settings are available in the Voice player itself (Voice_Player.gd): Overrides Each of these replaces the Engine setting of the same purpose while its enable_ switch is on (e.g. enable_auto_advance):
SettingOverrides
lexicon_modelexicon_voice_mode
auto_advanceauto_advance
auto_advance_per_characterauto_advance_per_character
enable_voiceenable_voice
await_voice_playbackawait_voice_playback
text_to_speechtext_to_speech
tts_advanced_fallbacktts_advanced_fallback
llm_modellm_mode
write_dialogue_historywrite_dialogue_history
Voice Files This replaces the Engine setting of the same name, unless left empty:
SettingPurpose
default_voice_extensionExtension appended to voice files named without one.
Actor Overrides The following overrides can be assigned to Actors (actors dictionary):
PropertyOverrides
LexiconVoiceModelexicon_voice_mode
DialogueModedialogue_mode
AutoAdvanceauto_advance
AutoAdvancePerCharacterauto_advance_per_character
EnableVoiceenable_voice
AwaitVoicePlaybackawait_voice_playback
TTStext_to_speech
TTSAdvancedFallbacktts_advanced_fallback
LLMllm_mode
WriteDialogueHistorywrite_dialogue_history
Line Overrides The following overrides can be assigned to Spoken Lines:
KeyOverrides
Lexicon_Modelexicon_voice_mode
Dialogue_Modedialogue_mode
Auto_Advanceauto_advance
Auto_Advance_Per_Characterauto_advance_per_character
Enable_Voiceenable_voice
Await_Voice_Playbackawait_voice_playback
TTStext_to_speech
TTS_Advanced_Fallbacktts_advanced_fallback
LLMllm_mode
Write_Dialogue_Historywrite_dialogue_history