Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Localization using spreadsheets

Spreadsheets are one of the most common formats for localizing games. In Godot, spreadsheets are supported through the CSV format. This guide explains how to work with CSVs.

The CSV files must be saved with UTF-8 encoding without a byte order mark.

Aviso

By default, Microsoft Excel will always save CSV files with ANSI encoding rather than UTF-8. There is no built-in way to do this, but there are workarounds as described here.

We recommend using LibreOffice or Google Sheets instead.

Formatação

Arquivos CSV devem ser formatados da seguinte forma:

chaves	<lang1>	<lang2>	<langN>
KEY1	string	string	string
KEY2	string	string	string
KEYN	string	string	string

The "lang" tags must represent a language, which must be one of the valid locales supported by the engine, or they must start with an underscore (_), which means the related column is served as comment and won't be imported. The KEY tags must be unique and represent a string universally. By convention, these are usually in uppercase to differentiate them from other strings. These keys will be replaced at runtime by the matching translated string. Note that the case is important: KEY1 and Key1 will be different keys. The top-left cell is ignored and can be left empty or having any content. Here's an example:

chaves	en	es	ja
SAUDAÇÃO	Olá, amigo!	Hola, Amigo!	こんにちは
PERGUNTAR	Como você está?	Como está?	元気ですか
DESPEDIDA	Adeus	Adiós	さようなら
CITAÇÃO	"Hello" said the man.	"Hola" dijo el hombre.	「こんにちは」男は言いました

O mesmo exemplo é mostrado abaixo como um arquivo de texto simples separado por vírgula, que deve ser o resultado da edição acima em uma planilha. Ao editar a versão de texto simples, certifique-se de fechar com aspas duplas qualquer mensagem que contenha vírgula, quebras de linha ou aspas duplas, para que as vírgulas não sejam analisadas como delimitadores, quebras de linha não criam novas entradas e aspas duplas não são tratadas como caracteres de fechamento. Certifique-se de evitar quaisquer aspas duplas que uma mensagem pode conter, precedendo-as com outra aspas dupla. Alternativamente, você pode selecionar outro delimitador do que a vírgula nas opções de importação.

keys,en,es,ja
GREET,"Hello, friend!","Hola, amigo!",こんにちは
ASK,How are you?,Cómo está?,元気ですか
BYE,Goodbye,Adiós,さようなら
QUOTE,"""Hello"" said the man.","""Hola"" dijo el hombre.",「こんにちは」男は言いました

Specifying plural forms

Since Godot 4.6, it is possible to specify plural forms in CSV files.

This is done by adding a column named ?plural anywhere in the table (except on the first column, which is reserved for translation keys). By convention, it's recommended to place it on the second column. Note that in the example below, the key column is the one that contains English localization.

en,?plural,fr,ru,ja,zh
?pluralrule,,nplurals=2; plural=(n >= 2);,,
There is %d apple,There are %d apples,Il y a %d pomme,Есть %d яблоко,リンゴが%d個あります,那里有%d个苹果
,,Il y a %d pommes,Есть %d яблока,,
,,,Есть %d яблок,,

Nota

Automatic Control translation is not supported when using plural forms. You must translate the string manually using tr_n().

Specifying translation contexts

Since Godot 4.6, it is possible to specify translation contexts in CSV files. This can be used to disambiguate identical source strings that have different meanings. While this is generally not needed when using translation keys LIKE_THIS, it's useful when using plain English text as translation keys.

This is done by adding a column named ?context column anywhere in the table (except on the first column, which is reserved for translation keys). By convention, it's recommended to place it on the second column, or after ?plural if it's also used. Note that in the example below, the key column is the one that contains English localization.

en,?context,fr,ru,ja,zh
Letter,Alphabet,Lettre,Буква,字母,字母
Letter,Message,Courrier,Письмо,手紙,信件

Nota

Automatic Control translation is not supported when using context. You must translate the string manually using tr() or tr_n().

Importador de CSV

O Godot tratará arquivos CSV como traduções por padrão. Ele irá importá-los e gerar um ou mais arquivos de recursos de tradução comprimidos ao lado dele.

A importação também adicionará a tradução à lista de traduções para carregar quando o jogo for iniciado, especificado em project.godot (ou nas configurações do projeto). Godot permite carregar e remover traduções em tempo de execução também.

Select the .csv file and access the Import dock to define import options. You can toggle the compression of the imported translations, and select the delimiter to use when parsing the CSV file.

Be sure to click Reimport after any change to these options.

Loading the CSV file as a translation

Once a CSV file is imported, it is not automatically registered as a translation source for the project. Remember to follow the steps described in Configurando a tradução importada so that the translation is actually used when running the project.