Localization and translations

keys,en,fr,hi
MENU_PLAY,Play,Jouer,खेलें
MENU_SETTINGS,Settings,Paramètres,सेटिंग्स
MENU_QUIT,Quit,Quitter,बाहर निकलें
GREETING,Hello,Bonjour,नमस्ते

extends SceneTree
## The translations of menu.csv, which the project lists in Project Settings > Localization, looked up
## in five locales; then a Button whose text is a key, and a Label that must never be translated.


func _initialize() -> void:
	print("Loaded locales: %s" % ", ".join(TranslationServer.get_loaded_locales()))
	for locale in ["en", "fr", "fr_CA", "hi", "de"]:
		TranslationServer.set_locale(locale)
		print("  %-5s GREETING -> %-8s MENU_SETTINGS -> %-11s NOPE -> %s" % [locale, TranslationServer.translate("GREETING"),
				TranslationServer.translate("MENU_SETTINGS"), TranslationServer.translate("NOPE")])
	await process_frame
	var play := Button.new()
	play.text = "MENU_PLAY"
	var player_name := Label.new()
	player_name.text = "GREETING"
	player_name.auto_translate_mode = Node.AUTO_TRANSLATE_MODE_DISABLED
	root.add_child(play)
	root.add_child(player_name)
	for locale in ["en", "fr"]:
		TranslationServer.set_locale(locale)
		print("%s: the Button's text is %s and it shows %s; the Label with auto-translation off shows %s" % [locale, play.text,
				play.atr(play.text), player_name.atr(player_name.text)])
	quit()

from session import files, run, write

# menu.csv imported as the editor imports it, then listed in the project's translations and looked up.
files("project.godot", "keys/menu.csv=menu.csv", "keys/lookup.gd=lookup.gd")
run("""
godot --headless --quiet --import
ls *.translation
""")
files("project_translations.godot=project.godot")
run("""
godot --headless --no-header --script lookup.gd
""")

$ godot --headless --quiet --import
$ ls *.translation
menu.en.translation
menu.fr.translation
menu.hi.translation
$ godot --headless --no-header --script lookup.gd
Loaded locales: en, fr, hi
  en    GREETING -> Hello    MENU_SETTINGS -> Settings    NOPE -> NOPE
  fr    GREETING -> Bonjour  MENU_SETTINGS -> Paramètres  NOPE -> NOPE
  fr_CA GREETING -> Bonjour  MENU_SETTINGS -> Paramètres  NOPE -> NOPE
  hi    GREETING -> नमस्ते   MENU_SETTINGS -> सेटिंग्स    NOPE -> NOPE
  de    GREETING -> Hello    MENU_SETTINGS -> Settings    NOPE -> NOPE
en: the Button's text is MENU_PLAY and it shows Play; the Label with auto-translation off shows GREETING
fr: the Button's text is MENU_PLAY and it shows Jouer; the Label with auto-translation off shows GREETING

keys,?plural,?context,en,fr
COINS_FOUND,COINS_FOUND_PLURAL,,You found %d coin,Tu as trouvé %d pièce
,,,You found %d coins,Tu as trouvé %d pièces
CLOSE,,door,Close,Fermer
CLOSE,,distance,Close,Proche

# French translation of Lantern Road's shop.
msgid ""
msgstr ""
"Language: fr\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

msgid "You found %d key"
msgid_plural "You found %d keys"
msgstr[0] "Tu as trouvé %d clé"
msgstr[1] "Tu as trouvé %d clés"

msgctxt "door"
msgid "Open"
msgstr "Ouvrir"

msgctxt "shop"
msgid "Open"
msgstr "Ouvert"

extends SceneTree
## Translations from two formats side by side: items.csv, imported into one .translation per language,
## and fr.po, loaded as it is. Both use plural forms and contexts.


func _initialize() -> void:
	for path in ["res://items.en.translation", "res://items.fr.translation", "res://fr.po"]:
		var translation: Translation = load(path)
		TranslationServer.add_translation(translation)
		print("%s: a %s for locale %s" % [path.get_file(), translation.get_class(), translation.locale])
	for locale in ["en", "fr"]:
		TranslationServer.set_locale(locale)
		var counts: PackedStringArray = []
		for n in [0, 1, 2]:
			counts.append(TranslationServer.translate_plural("COINS_FOUND", "COINS_FOUND_PLURAL", n) % n)
		print("%s, from the CSV: %s" % [locale, " | ".join(counts)])
		print("    CLOSE for a door: %s; CLOSE for a distance: %s" % [TranslationServer.translate("CLOSE", "door"),
				TranslationServer.translate("CLOSE", "distance")])
	TranslationServer.set_locale("fr")
	var keys: PackedStringArray = []
	for n in [0, 1, 3]:
		keys.append(TranslationServer.translate_plural("You found %d key", "You found %d keys", n) % n)
	print("fr, from the PO file: %s" % " | ".join(keys))
	print("    Open for a door: %s; Open for a shop: %s" % [TranslationServer.translate("Open", "door"), TranslationServer.translate("Open", "shop")])
	quit()

from session import files, run

# A CSV with plural and context columns, imported, and a gettext PO file, loaded as it is.
files("project.godot", "files/items.csv=items.csv", "files/fr.po=fr.po", "files/two_formats.gd=two_formats.gd")
run("""
godot --headless --quiet --import
ls *.translation
godot --headless --no-header --script two_formats.gd
""")

$ godot --headless --quiet --import
$ ls *.translation
items.en.translation
items.fr.translation
$ godot --headless --no-header --script two_formats.gd
items.en.translation: a Translation for locale en
items.fr.translation: a Translation for locale fr
fr.po: a Translation for locale fr
en, from the CSV: You found 0 coins | You found 1 coin | You found 2 coins
    CLOSE for a door: Close; CLOSE for a distance: Close
fr, from the CSV: Tu as trouvé 0 pièce | Tu as trouvé 1 pièce | Tu as trouvé 2 pièces
    CLOSE for a door: Fermer; CLOSE for a distance: Proche
fr, from the PO file: Tu as trouvé 0 clé | Tu as trouvé 1 clé | Tu as trouvé 3 clés
    Open for a door: Ouvrir; Open for a shop: Ouvert

extends SceneTree
## One quest message in three languages, built two ways: from translated fragments joined in English
## order, and from one translated sentence with named placeholders. The translations are made in code
## here to keep the example short; a game keeps them in its CSV or PO files.

const MESSAGES := {
	"en": {"QUEST_DONE": "{player} found {item} in {place}", "FOUND": "found", "IN": "in"},
	"fr": {"QUEST_DONE": "{player} a trouvé {item} dans {place}", "FOUND": "a trouvé", "IN": "dans"},
	"hi": {"QUEST_DONE": "{player} को {place} में {item} मिला", "FOUND": "मिला", "IN": "में"},
}
const WORDS := {
	"en": {"item": "the lantern", "place": "the cave"},
	"fr": {"item": "la lanterne", "place": "la grotte"},
	"hi": {"item": "लालटेन", "place": "गुफा"},
}


func _initialize() -> void:
	for locale: String in MESSAGES:
		var translation := Translation.new()
		translation.locale = locale
		for key: String in MESSAGES[locale]:
			translation.add_message(key, MESSAGES[locale][key])
		TranslationServer.add_translation(translation)
	for locale: String in MESSAGES:
		TranslationServer.set_locale(locale)
		var item: String = WORDS[locale].item
		var place: String = WORDS[locale].place
		var joined := "Asha " + TranslationServer.translate("FOUND") + " " + item + " " + TranslationServer.translate("IN") + " " + place
		var named := String(TranslationServer.translate("QUEST_DONE")).format({"player": "Asha", "item": item, "place": place})
		print("%s  joined: %s" % [locale, joined])
		print("    named:  %s" % named)
	quit()

from session import files, run

# One quest message in English, French and Hindi, joined from fragments and built with named placeholders.
files("project.godot", "plurals/placeholders.gd=placeholders.gd")
run("""
godot --headless --no-header --script placeholders.gd
""")

$ godot --headless --no-header --script placeholders.gd
en  joined: Asha found the lantern in the cave
    named:  Asha found the lantern in the cave
fr  joined: Asha a trouvé la lanterne dans la grotte
    named:  Asha a trouvé la lanterne dans la grotte
hi  joined: Asha मिला लालटेन में गुफा
    named:  Asha को गुफा में लालटेन मिला