Get translations working at runtime and add option to select locale in Main Panel

Author: jonnydgreen

addons/parley/assets/Generate.svg

@@ -0,0 +1,38 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://dymfq1lumomnh"
+path="res://.godot/imported/Generate.svg-c453b998a82ad5f3f2fd9b38bce67edb.ctex"
+metadata={
+"has_editor_variant": true,
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/parley/assets/Generate.svg"
+dest_files=["res://.godot/imported/Generate.svg-c453b998a82ad5f3f2fd9b38bce67edb.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=true
+editor/convert_colors_with_editor_theme=true

addons/parley/assets/Generate.svg.import

@@ -0,0 +1,38 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://es7k6io6r0lm"
+path="res://.godot/imported/Translation.svg-c3e1761c64f8d5efb11ee1054cec6a6c.ctex"
+metadata={
+"has_editor_variant": true,
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/parley/assets/Translation.svg"
+dest_files=["res://.godot/imported/Translation.svg-c3e1761c64f8d5efb11ee1054cec6a6c.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=true
+editor/convert_colors_with_editor_theme=true

addons/parley/assets/Translation.svg

@@ -40,9 +40,7 @@ func start(p_ctx: ParleyContext, p_dialogue_sequence_ast: ParleyDialogueSequence
 	is_waiting_for_input = false
 	ctx = p_ctx
 	dialogue_sequence_ast = p_dialogue_sequence_ast
-	# TODO: remove
-	ctx.start_of_run = true
-	var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast, p_start_node if p_start_node else null)
+	var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.init(ctx, dialogue_sequence_ast, p_start_node if p_start_node else null)
 	current_node_asts = run_result.node_asts
 	dialogue_sequence_ast = run_result.dialogue_sequence
 	run_result.free() # Needed to ensure that everything is correctly freed up at exit

addons/parley/assets/Translation.svg.import

@@ -22,4 +22,4 @@ func _ready() -> void:
 func _render() -> void:
 	if dialogue_text_label:
 		var character: ParleyCharacter = dialogue_node.resolve_character()
-		dialogue_text_label.text = "[b]%s[/b] – %s" % [character.name if character.name != '' else 'Unknown', dialogue_node.text]
+		dialogue_text_label.text = "[b]%s[/b] – %s" % [tr(character.name) if character.name != '' else 'Unknown', dialogue_node.text]

addons/parley/components/default_balloon.gd

@@ -8,20 +8,23 @@ class_name ParleyDialogueNodeEditor extends ParleyBaseNodeEditor
 var character_store: ParleyCharacterStore: set = _set_character_store
 @export var character: String = "": set = _set_character
 @export var dialogue: String = "": set = _set_dialogue
+@export var text_translation_key: String = "": set = _set_text_translation_key
 
 
 @onready var character_selector: OptionButton = %CharacterSelector
 @onready var dialogue_editor: TextEdit = %DialogueEditor
+@onready var text_translation_key_editor: ParleyTranslationKeyEditor = %TranslationKeyEditor
 
 
-signal dialogue_node_changed(id: String, character: String, dialogue: String)
+signal dialogue_node_changed(id: String, character: String, dialogue: String, text_translation_key: String)
 #endregion
 
 
 #region LIFECYCLE
 func _ready() -> void:
 	set_title()
 	_render_dialogue()
+	_render_text_translation_key_editor(true)
 	_render_character_options()
 	if character_store:
 		ParleyUtils.signals.safe_connect(character_store.changed, _on_character_store_changed)
@@ -48,6 +51,11 @@ func _set_dialogue(new_dialogue: String) -> void:
 func _set_character(new_character: String) -> void:
 	character = new_character
 	_render_character()
+
+
+func _set_text_translation_key(new_text_translation_key: String) -> void:
+	text_translation_key = new_text_translation_key
+	_render_text_translation_key_editor()
 #endregion
 
 
@@ -57,6 +65,14 @@ func _render_dialogue() -> void:
 		dialogue_editor.text = dialogue
 
 
+func _render_text_translation_key_editor(on_ready: bool = false) -> void:
+	if text_translation_key_editor:
+		if text_translation_key_editor.key != text_translation_key:
+			text_translation_key_editor.key = text_translation_key
+		if on_ready:
+			text_translation_key_editor.label = &"Text Translation Key: "
+
+
 func _render_character_options() -> void:
 	if not character_selector:
 		return
@@ -94,5 +110,15 @@ func _on_character_store_changed() -> void:
 
 
 func _emit_dialogue_node_changed() -> void:
-	dialogue_node_changed.emit(id, character, dialogue)
+	dialogue_node_changed.emit(id, character, dialogue, text_translation_key)
+
+
+func _on_translation_key_editor_key_changed(new_key: String) -> void:
+	text_translation_key = new_key
+	_emit_dialogue_node_changed()
+
+
+func _on_translation_key_editor_key_generation_requested() -> void:
+	text_translation_key = ParleyUtils.translation.generate_key(dialogue, dialogue_sequence_ast, node_ast, 'text')
+	_emit_dialogue_node_changed()
 #endregion

addons/parley/components/dialogue/dialogue_container.gd

@@ -1,12 +1,14 @@
-[gd_scene load_steps=3 format=3 uid="uid://bx0l648bpqw70"]
+[gd_scene load_steps=4 format=3 uid="uid://bx0l648bpqw70"]
 
 [ext_resource type="Script" uid="uid://b0qfehwjd3bm7" path="res://addons/parley/components/dialogue/dialogue_node_editor.gd" id="1_ad3ky"]
 [ext_resource type="PackedScene" uid="uid://m3v11vm16l8y" path="res://addons/parley/components/node/node_editor.tscn" id="1_okdx1"]
+[ext_resource type="PackedScene" uid="uid://n4t3w6dhkt6a" path="res://addons/parley/components/editor/translation_key.tscn" id="3_wbci0"]
 
 [node name="DialogueNodeEditor" instance=ExtResource("1_okdx1")]
 script = ExtResource("1_ad3ky")
 character = ""
 dialogue = ""
+text_translation_key = ""
 type = 0
 
 [node name="TitleLabel" parent="TitleContainer/TitlePanelContainer/TitleMarginContainer/TitlePartsContainer" index="0"]
@@ -21,8 +23,8 @@ text = "Character: "
 
 [node name="CharacterSelector" type="OptionButton" parent="BodyMarginContainer/BodyScrollContainer/BodyContainer/CharacterSelectorContainer" index="1"]
 unique_name_in_owner = true
-layout_mode = 2
 custom_minimum_size = Vector2(150, 0)
+layout_mode = 2
 size_flags_horizontal = 3
 text_overrun_behavior = 3
 clip_text = true
@@ -43,5 +45,11 @@ size_flags_vertical = 3
 placeholder_text = "Dialogue goes here.."
 wrap_mode = 1
 
+[node name="TranslationKeyEditor" parent="BodyMarginContainer/BodyScrollContainer/BodyContainer" index="2" instance=ExtResource("3_wbci0")]
+unique_name_in_owner = true
+layout_mode = 2
+
 [connection signal="item_selected" from="BodyMarginContainer/BodyScrollContainer/BodyContainer/CharacterSelectorContainer/CharacterSelector" to="." method="_on_character_selector_item_selected"]
 [connection signal="text_changed" from="BodyMarginContainer/BodyScrollContainer/BodyContainer/DialogueEditorContainer/DialogueEditor" to="." method="_on_dialogue_editor_text_changed"]
+[connection signal="key_changed" from="BodyMarginContainer/BodyScrollContainer/BodyContainer/TranslationKeyEditor" to="." method="_on_translation_key_editor_key_changed"]
+[connection signal="key_generation_requested" from="BodyMarginContainer/BodyScrollContainer/BodyContainer/TranslationKeyEditor" to="." method="_on_translation_key_editor_key_generation_requested"]

addons/parley/components/dialogue/dialogue_node_editor.gd

@@ -0,0 +1,40 @@
+[gd_scene load_steps=4 format=3 uid="uid://n4t3w6dhkt6a"]
+
+[ext_resource type="Script" uid="uid://bbk5c0urv1ug" path="res://addons/parley/components/editor/translation_key_editor.gd" id="1_nxxod"]
+[ext_resource type="Texture2D" uid="uid://dymfq1lumomnh" path="res://addons/parley/assets/Generate.svg" id="2_15ow8"]
+[ext_resource type="Texture2D" uid="uid://c4qx01xbrjp7h" path="res://addons/parley/assets/Edit.svg" id="3_wy1by"]
+
+[node name="TranslationKeyEditor" type="VBoxContainer"]
+size_flags_vertical = 3
+script = ExtResource("1_nxxod")
+
+[node name="TranslationKeyLabel" type="Label" parent="."]
+unique_name_in_owner = true
+layout_mode = 2
+
+[node name="TranslationKeyEditorContainer" type="HBoxContainer" parent="."]
+layout_mode = 2
+
+[node name="TranslationKeyEditor" type="LineEdit" parent="TranslationKeyEditorContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+size_flags_horizontal = 3
+tooltip_text = "Set the translation key for the associated field"
+editable = false
+
+[node name="GenerateTranslationKeyButton" type="Button" parent="TranslationKeyEditorContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+tooltip_text = "Generate the translation key for this Node AST. Be cautious when regenerating this as it is likely to affect existing translations."
+icon = ExtResource("2_15ow8")
+
+[node name="EditTranslationKeyButton" type="Button" parent="TranslationKeyEditorContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+tooltip_text = "Edit the translation key for this Node AST. Be cautious when changing this as it is likely to affect existing translations."
+toggle_mode = true
+icon = ExtResource("3_wy1by")
+
+[connection signal="text_changed" from="TranslationKeyEditorContainer/TranslationKeyEditor" to="." method="_on_translation_key_editor_text_changed"]
+[connection signal="pressed" from="TranslationKeyEditorContainer/GenerateTranslationKeyButton" to="." method="_on_generate_translation_key_button_pressed"]
+[connection signal="toggled" from="TranslationKeyEditorContainer/EditTranslationKeyButton" to="." method="_on_edit_translation_key_button_toggled"]

addons/parley/components/dialogue/dialogue_node_editor.tscn

@@ -0,0 +1,85 @@
+# Copyright 2024-2025 the Bisterix Studio authors. All rights reserved. MIT license.
+
+@tool
+class_name ParleyTranslationKeyEditor extends VBoxContainer
+
+
+#region DEFS
+var label: String = "": set = _set_label
+var key: String = "": set = _set_key
+
+
+@onready var translation_key_label: Label = %TranslationKeyLabel
+@onready var translation_key_editor: LineEdit = %TranslationKeyEditor
+@onready var generate_translation_key_button: Button = %GenerateTranslationKeyButton
+@onready var edit_translation_key_button: Button = %EditTranslationKeyButton
+
+
+signal key_changed(new_key: String)
+signal key_generation_requested()
+#endregion
+
+
+#region LIFECYCLE
+func _ready() -> void:
+	_render_label()
+	_render_key(true)
+	_render_edit_translation_key_button(true)
+	_render_generate_translation_key_button(true)
+#endregion
+
+
+#region SETTERS
+func _set_key(new_key: String) -> void:
+	key = new_key
+	_render_key()
+
+
+func _set_label(new_label: String) -> void:
+	label = new_label
+	_render_label()
+#endregion
+
+
+#region RENDERERS
+func _render_label() -> void:
+	if translation_key_label:
+		translation_key_label.text = label
+
+func _render_key(on_ready: bool = false) -> void:
+	if translation_key_editor:
+		if translation_key_editor.text != key:
+			translation_key_editor.text = key
+		if on_ready:
+			translation_key_editor.tooltip_text = &"Set the translation key for the associated field"
+			translation_key_editor.editable = false
+
+
+func _render_edit_translation_key_button(on_ready: bool = false) -> void:
+	if edit_translation_key_button:
+		if on_ready:
+			edit_translation_key_button.tooltip_text = &"Edit the translation key for this Node AST. Be cautious when changing this as it is likely to affect existing translations."
+			edit_translation_key_button.button_pressed = false
+
+
+func _render_generate_translation_key_button(on_ready: bool = false) -> void:
+	if generate_translation_key_button:
+		if on_ready:
+			generate_translation_key_button.tooltip_text = &"Generate the translation key for this Node AST. Be cautious when regenerating this as it is likely to affect existing translations."
+#endregion
+
+
+#region SIGNALS
+func _on_translation_key_editor_text_changed(new_text: String) -> void:
+	key = new_text
+	key_changed.emit(key)
+
+
+func _on_generate_translation_key_button_pressed() -> void:
+	key_generation_requested.emit()
+
+
+func _on_edit_translation_key_button_toggled(toggled_on: bool) -> void:
+	if translation_key_editor:
+		translation_key_editor.editable = toggled_on
+#endregion