Localization of any texts
Most games use localization according to the key principle, that is, a key is needed to describe a specific text, but I suggest a better option, although this option is not suitable for those who have voice acting in games, it’s easier through the key.
The key, or more precisely the key word, is the word by which it will be determined which text is needed, and then the search for the selected language takes place. Example keyword: scene_Escape_from_jail_Ethan_dialog_with_Mary_3 , yes, something like this will be the key, if your game has many scenes, a great storyline. I propose to immediately write a phrase in one of the languages, most often English or one that the programmer is fluent in. By the way, since all the phrases of the current language and the main language will lie in the RAM, this will be more productive than getting each time from the file, for larger games, you can slightly modify the file for each scene.
In the steps below, the static Lang class will be used, in which all searches for words / phrases will occur. Let's declare a class by connecting the libraries we need:
And so, it’s impossible to do without a standard library, since we’ll get the file from resources, you can also upload it in any convenient way, but it’s more convenient and practical. System libraries are needed to connect the list, the dictionary and work with files from the editor. The UnityEditor library is needed only to update the file during the first recording of the phrase, since after a quick restart, all the phrases will not always be loaded, but with the help of this library we will be able to solve this problem. The class stores two static fields, even if the file name is, in our case, the path is a folder with resources, and the file name can be any.
')
Now you need to add lists to store all used language and dictionary.
The LangIndex field will hold the index of the current language relative to the entry in the file. In the list of languages - all languages used in the file will be recorded. The dictionary will store all phrases in the main language and in the current language.
It is necessary to add initialization of the above described class fields.
The challenge when playing in the editor should contain two main parameters, which is the language that phrases should be translated now, and which language will be the main one, all other parameters are the language parameters that should be contained in the file, these parameters are needed only during the first run, when the file has not yet been created (and it is not necessary to delete it afterwards), otherwise, if you need to add some language, you need to copy everything from the file, delete the file, and re-run the code in the editor or write it yourself in the file.
In the code above, the SystemLanguageParse (...) method is used which simply translates the language names from the string type into SystemLanguage (this method will be lower).
Let us dwell on the method of addition:
Since this method will be used only when starting from the editor, we can easily use the system utility to overwrite the file, as well as update the modified files using the Refresh () method. Between these actions, just add a phrase to the dictionary, so as to protect yourself from re-writing in the same session.
By the way, I forgot to say that the phrases will be stored in a .csv file, which will allow us to comfortably translate phrases in Excele. Now we need to add a good method for us that will allow us to change the language:
And so, we came to the most important method, which will receive the phrase in the main language, and give it to the right user:
This method simply accepts a phrase in the main language, then iterates through all that is in the dictionary, finding such a phrase by key it gives us the values of this key, which is a phrase in the language we need. You can use this method with a simple line of code:
Now the phrase in the required language will fall into the str line, if suddenly it is missing, then the phrase specified in the parameters, that is, Hello world, will fall.
This method can be slightly improved, but it would be possible to take arguments to fill in:
Now this method can be called as before:
But now our method has a formatted output, using comma-separated parameters:
As I wrote above, the file uses .csv extensions that allow you to do everything in Excel, but not everything is so simple, the problem of C-Sharp and Excel is that they understand Cyrillic in different encoding, Excel only understands the UTF-8-BOM encoding or the one that our PL does not understand, we should use only UTF-8 in it, although the unit editor will understand UTF-8-BOM, in the code two identical words on different encodings (UTF-8 and UTF-8- BOM) will not be equal, which will lead to the constant addition of the same words in our file.
We can encode files using the free NotePad ++ by downloading it from off. site. Editing a file will not bring you any problem; you can even use a text editor, the same note-pad or even our programming environment to add one word.
The main thing to remember: UTF-8-BOM - to work in Excel, UTF-8 to work with code, do not forget.
What is a key and why is it needed?
The key, or more precisely the key word, is the word by which it will be determined which text is needed, and then the search for the selected language takes place. Example keyword: scene_Escape_from_jail_Ethan_dialog_with_Mary_3 , yes, something like this will be the key, if your game has many scenes, a great storyline. I propose to immediately write a phrase in one of the languages, most often English or one that the programmer is fluent in. By the way, since all the phrases of the current language and the main language will lie in the RAM, this will be more productive than getting each time from the file, for larger games, you can slightly modify the file for each scene.
How everything will be arranged
In the steps below, the static Lang class will be used, in which all searches for words / phrases will occur. Let's declare a class by connecting the libraries we need:
using UnityEngine; using System.Collections.Generic; // list and dictionary #if UNITY_EDITOR using UnityEditor; using System.IO; // created file in editor #endif public class Lang { private const string Path = "/Resources/"; // path to resources folder private const string FileName = "Language"; // file name with phrases } And so, it’s impossible to do without a standard library, since we’ll get the file from resources, you can also upload it in any convenient way, but it’s more convenient and practical. System libraries are needed to connect the list, the dictionary and work with files from the editor. The UnityEditor library is needed only to update the file during the first recording of the phrase, since after a quick restart, all the phrases will not always be loaded, but with the help of this library we will be able to solve this problem. The class stores two static fields, even if the file name is, in our case, the path is a folder with resources, and the file name can be any.
')
Now you need to add lists to store all used language and dictionary.
private static int LangIndex; // variable to store the index of the current language private static List<SystemLanguage> languages = new List<SystemLanguage>(); // having languages in game private static Dictionary<string, string> Phrases = new Dictionary<string, string>(); // keys and values The LangIndex field will hold the index of the current language relative to the entry in the file. In the list of languages - all languages used in the file will be recorded. The dictionary will store all phrases in the main language and in the current language.
It is necessary to add initialization of the above described class fields.
Code
It will immediately use the built-in directives so as not to make unnecessary actions after compiling the application. The call to Lang.Starting (...) should be something like this:
public static bool isStarting // bool for check starting { get; private set; } public static SystemLanguage language // return current language { get; private set; } #if UNITY_EDITOR public static void Starting(SystemLanguage _language, SystemLanguage default_language = SystemLanguage.English, params SystemLanguage[] _languages) // write languages without main language, it self added #else public static void Starting(SystemLanguage _language = SystemLanguage.English) // main language - only for compilation #endif { #if UNITY_EDITOR if (!File.Exists(Application.dataPath + Path + FileName + ".csv")) // if file wasn't created { File.Create(Application.dataPath + "/Resources/" + FileName + ".csv").Dispose(); // create and lose link File.WriteAllText(Application.dataPath + "/Resources/" + FileName + ".csv", SetLanguage(default_language, _languages)); // write default text with index } #endif string[] PhrasesArr = Resources.Load<TextAsset>(FileName).text.Split('\n'); // temp var for write in dicrionary string[] string_languages = PhrasesArr[0].Split(';'); // string with using languages int _length = string_languages.Length - 1; for (int i = 0; i < _length; i++) { languages.Add(SystemLanguageParse(string_languages[i])); // string language to SystemLanguage } LangIndex = FindIndexLanguage(_language); // index with current language for (int i = 0; i < PhrasesArr.Length; i++) // add keys and value { string[] temp_string = PhrasesArr[i].Split(';'); if (temp_string.Length > LangIndex) Phrases.Add(temp_string[0], temp_string[LangIndex]); else Phrases.Add(temp_string[0], temp_string[0]); } isStarting = true; } It will immediately use the built-in directives so as not to make unnecessary actions after compiling the application. The call to Lang.Starting (...) should be something like this:
#if !UNITY_EDITOR Lang.Starting(LANGUAGE); #else Lang.Starting(LANGUAGE, SystemLanguage.English, SystemLanguage.Russian, SystemLanguage.Ukrainian); #endif private static int FindIndexLanguage(SystemLanguage _language) // finding index or current language { int _index = languages.IndexOf(_language); if (_index == -1) // if language not found return 0; // return main language return _index; } #if UNITY_EDITOR private static void Add(string AddString) // add phrases only form editor { File.AppendAllText(Application.dataPath + "/Resources/" + FileName +".csv", AddString + "\n"); // rewrite text to file Phrases.Add(AddString, AddString); // add phrase to dicrionary AssetDatabase.Refresh(); // refresh file } #endif #if UNITY_EDITOR private static string SetLanguage(SystemLanguage default_language, params SystemLanguage[] _languages) // set first string to file { string ret_string = ""; ret_string += default_language + ";"; foreach (SystemLanguage _language in _languages) { ret_string += _language + ";"; } return ret_string + "!@#$%\n"; // for last index } #endif The challenge when playing in the editor should contain two main parameters, which is the language that phrases should be translated now, and which language will be the main one, all other parameters are the language parameters that should be contained in the file, these parameters are needed only during the first run, when the file has not yet been created (and it is not necessary to delete it afterwards), otherwise, if you need to add some language, you need to copy everything from the file, delete the file, and re-run the code in the editor or write it yourself in the file.
In the code above, the SystemLanguageParse (...) method is used which simply translates the language names from the string type into SystemLanguage (this method will be lower).
Let us dwell on the method of addition:
#if UNITY_EDITOR private static void Add(string AddString) // add phrases only form editor { File.AppendAllText(Application.dataPath + "/Resources/" + FileName +".csv", AddString + "\n"); // rewrite text to file Phrases.Add(AddString, AddString); // add phrase to dicrionary AssetDatabase.Refresh(); // refresh file } #endif Since this method will be used only when starting from the editor, we can easily use the system utility to overwrite the file, as well as update the modified files using the Refresh () method. Between these actions, just add a phrase to the dictionary, so as to protect yourself from re-writing in the same session.
By the way, I forgot to say that the phrases will be stored in a .csv file, which will allow us to comfortably translate phrases in Excele. Now we need to add a good method for us that will allow us to change the language:
public static void ChangeLanguage(SystemLanguage _language) // change language { string[] PhrasesArr = Resources.Load<TextAsset>(FileName).text.Split('\n'); // load all text from file LangIndex = FindIndexLanguage(_language); Phrases.Clear(); // clear dictionary with phrases for (int i = 1; i < PhrasesArr.Length; i++) { string[] temp_string = PhrasesArr[i].Split(';'); if (temp_string.Length > LangIndex) Phrases.Add(temp_string[0], temp_string[LangIndex]); else Phrases.Add(temp_string[0], temp_string[0]); } } And so, we came to the most important method, which will receive the phrase in the main language, and give it to the right user:
public static string Phrase(string DefaultPhrase) // translate phrase, args use to formating string { #if UNITY_EDITOR if (!isStarting) // if not starting { throw new System.Exception("Forgot initialization.Use Lang.Starting(...)"); // throw exception } #endif string temp_EnglishPhrase = DefaultPhrase; // temp variable for try get value if (Phrases.TryGetValue(DefaultPhrase, out DefaultPhrase)) // if value has been found { return temp_EnglishPhrase; } #if UNITY_EDITOR Add(temp_EnglishPhrase); // add phrase if value hasn't been found #endif return temp_EnglishPhrase; } This method simply accepts a phrase in the main language, then iterates through all that is in the dictionary, finding such a phrase by key it gives us the values of this key, which is a phrase in the language we need. You can use this method with a simple line of code:
string str = Lang.Phrase("Hello world"); Now the phrase in the required language will fall into the str line, if suddenly it is missing, then the phrase specified in the parameters, that is, Hello world, will fall.
This method can be slightly improved, but it would be possible to take arguments to fill in:
public static string Phrase(string DefaultPhrase, params string[] args) // translate phrase, args use to formating string { #if UNITY_EDITOR if (!isStarting) // if not starting { throw new System.Exception("Forgot initialization.Use Lang.Starting(...)"); // throw exception } #endif string temp_EnglishPhrase = DefaultPhrase; // temp variable for try get value if (Phrases.TryGetValue(DefaultPhrase, out DefaultPhrase)) // if value has been found { if (args.Length == 0) return DefaultPhrase; return string.Format(DefaultPhrase, args); } #if UNITY_EDITOR Add(temp_EnglishPhrase); // add phrase if value hasn't been found #endif if (args.Length == 0) return temp_EnglishPhrase; return string.Format(temp_EnglishPhrase, args); } Now this method can be called as before:
string str = Lang.Phrase("Hello world"); But now our method has a formatted output, using comma-separated parameters:
string str = Lang.Phrase("Hello {0} from {1}", "world", "habr"); Phrase translations
As I wrote above, the file uses .csv extensions that allow you to do everything in Excel, but not everything is so simple, the problem of C-Sharp and Excel is that they understand Cyrillic in different encoding, Excel only understands the UTF-8-BOM encoding or the one that our PL does not understand, we should use only UTF-8 in it, although the unit editor will understand UTF-8-BOM, in the code two identical words on different encodings (UTF-8 and UTF-8- BOM) will not be equal, which will lead to the constant addition of the same words in our file.
We can encode files using the free NotePad ++ by downloading it from off. site. Editing a file will not bring you any problem; you can even use a text editor, the same note-pad or even our programming environment to add one word.
Summary code
using UnityEngine; using System.Collections.Generic; // list and dictionary #if UNITY_EDITOR using UnityEditor; using System.IO; // created file in editor #endif public class Lang { private const string Path = "/Resources/"; // path to resources folder private const string FileName = "Language"; // file name with phrases private static int NumberOfLanguage; // variable to store the index of the current language private static List<SystemLanguage> languages = new List<SystemLanguage>(); // having languages in game private static Dictionary<string, string> Phrases = new Dictionary<string, string>(); // keys and values private static SystemLanguage language; // current language #if UNITY_EDITOR public static void Starting(SystemLanguage _language, SystemLanguage default_language, params SystemLanguage[] _languages) // write languages without main language, it self added #else public static void Starting(SystemLanguage _language = SystemLanguage.English) // main language - only for compilation #endif { #if UNITY_EDITOR if (!File.Exists(Application.dataPath + Path + FileName + ".csv")) // if file wasn't created { File.Create(Application.dataPath + "/Resources/" + FileName + ".csv").Dispose(); // create and lose link File.WriteAllText(Application.dataPath + "/Resources/" + FileName + ".csv", SetLanguage(default_language, _languages)); // write default text with index } #endif string[] PhrasesArr = Resources.Load<TextAsset>(FileName).text.Split('\n'); // temp var for write in dicrionary string[] string_languages = PhrasesArr[0].Split(';'); // string with using languages int _length = string_languages.Length - 1; for (int i = 0; i < _length; i++) { languages.Add(SystemLanguageParse(string_languages[i])); // string language to SystemLanguage } NumberOfLanguage = FindIndexLanguage(_language); // index with current language for (int i = 0; i < PhrasesArr.Length; i++) // add keys and value { string[] temp_string = PhrasesArr[i].Split(';'); if (temp_string.Length > NumberOfLanguage) Phrases.Add(temp_string[0], temp_string[NumberOfLanguage]); else Phrases.Add(temp_string[0], temp_string[0]); } isStarting = true; } public static bool isStarting // bool for check starting { get; private set; } public static SystemLanguage Language // return current language { get { return language; } } public static string Phrase(string DefaultPhrase, params string[] args) // translate phrase, args use to formating string { #if UNITY_EDITOR if (!isStarting) // if not starting { throw new System.Exception("Forgot initialization.Use Lang.Starting(...)"); // throw exception } #endif string temp_EnglishPhrase = DefaultPhrase; // temp variable for try get value if (Phrases.TryGetValue(DefaultPhrase, out DefaultPhrase)) // if value has been found { if (args.Length == 0) return DefaultPhrase; return string.Format(DefaultPhrase, args); } #if UNITY_EDITOR Add(temp_EnglishPhrase); // add phrase if value hasn't been found #endif if (args.Length == 0) return temp_EnglishPhrase; return string.Format(temp_EnglishPhrase, args); } public static void ChangeLanguage(SystemLanguage _language) // change language { string[] PhrasesArr = Resources.Load<TextAsset>(FileName).text.Split('\n'); // load all text from file NumberOfLanguage = FindIndexLanguage(_language); Phrases.Clear(); // clear dictionary with phrases for (int i = 1; i < PhrasesArr.Length; i++) { string[] temp_string = PhrasesArr[i].Split(';'); if (temp_string.Length > NumberOfLanguage) Phrases.Add(temp_string[0], temp_string[NumberOfLanguage]); else Phrases.Add(temp_string[0], temp_string[0]); } } private static int FindIndexLanguage(SystemLanguage _language) // finding index or current language { int _index = languages.IndexOf(_language); if (_index == -1) // if language not found return 0; // return main language return _index; } #if UNITY_EDITOR private static void Add(string AddString) // add phrases only form editor { File.AppendAllText(Application.dataPath + "/Resources/" + FileName + ".csv", AddString + "\n"); // rewrite text to file Phrases.Add(AddString, AddString); // add phrase to dicrionary AssetDatabase.Refresh(); // refresh file } #endif #if UNITY_EDITOR private static string SetLanguage(SystemLanguage default_language, params SystemLanguage[] _languages) // set first string to file { string ret_string = ""; ret_string += default_language + ";"; foreach (SystemLanguage _language in _languages) { ret_string += _language + ";"; } return ret_string + "!@#$%\n"; // for last index } #endif private static SystemLanguage SystemLanguageParse(string _language) // just parse from string to SystemLanguage { switch (_language) { case "English": return SystemLanguage.English; case "Russian": return SystemLanguage.Russian; case "Ukrainian": return SystemLanguage.Ukrainian; case "Polish": return SystemLanguage.Polish; case "French": return SystemLanguage.French; case "Japanese": return SystemLanguage.Japanese; case "Chinese": return SystemLanguage.Chinese; case "Afrikaans": return SystemLanguage.Afrikaans; case "Arabic": return SystemLanguage.Arabic; case "Basque": return SystemLanguage.Basque; case "Belarusian": return SystemLanguage.Belarusian; case "Bulgarian": return SystemLanguage.Bulgarian; case "ChineseSimplified": return SystemLanguage.ChineseSimplified; case "ChineseTraditional": return SystemLanguage.ChineseTraditional; case "Czech": return SystemLanguage.Czech; case "Danish": return SystemLanguage.Danish; case "Dutch": return SystemLanguage.Dutch; case "Estonian": return SystemLanguage.Estonian; case "Faroese": return SystemLanguage.Faroese; case "Finnish": return SystemLanguage.Finnish; case "German": return SystemLanguage.German; case "Greek": return SystemLanguage.Greek; case "Hebrew": return SystemLanguage.Hebrew; case "Hungarian": return SystemLanguage.Hungarian; case "Icelandic": return SystemLanguage.Icelandic; case "Indonesian": return SystemLanguage.Indonesian; case "Italian": return SystemLanguage.Italian; case "Korean": return SystemLanguage.Korean; case "Latvian": return SystemLanguage.Latvian; case "Lithuanian": return SystemLanguage.Lithuanian; case "Norwegian": return SystemLanguage.Norwegian; case "Portuguese": return SystemLanguage.Portuguese; case "Romanian": return SystemLanguage.Romanian; case "SerboCroatian": return SystemLanguage.SerboCroatian; case "Slovak": return SystemLanguage.Slovak; case "Slovenian": return SystemLanguage.Slovenian; case "Spanish": return SystemLanguage.Spanish; case "Swedish": return SystemLanguage.Swedish; case "Thai": return SystemLanguage.Thai; case "Turkish": return SystemLanguage.Turkish; case "Vietnamese": return SystemLanguage.Vietnamese; } return SystemLanguage.Unknown; } } The main thing to remember: UTF-8-BOM - to work in Excel, UTF-8 to work with code, do not forget.
Source: https://habr.com/ru/post/446844/
All Articles