This tutorial covers the setup of localization files for your mods, which will enable you to move all your text out of your SBC definitions. This is good practice but more importantly also allows you to include translations of your mod within the mod itself - without a need to create and maintain a second mod.
- An editor capable of correctly displaying RESX files - for example Visual Studio Community 2019
- Empty MyTexts.resx file
- MyTexts.sbl language definition file
Download the empty MyTexts.resx
and the MyTexts.sbl
file. Place them as follows:
[YOURMOD]\Data\Localization\MyTexts.resx
[YOURMOD]\Data\Localization\MyTexts.sbl
Next, open MyTexts.resx
and you should see something like this:
Within your SBC's DisplayName
or Description
-tags, you can now place any string as a variable to connect it to a text bit saved within the RESX-file. This is done by wrapping the string into {LOC:
and }
:
<DisplayName>{LOC:My_Cool_String}</DisplayName>
Now add that same string to the Name
-column in the MyTexts.resx
-file. Place the text you want to show ingame into the Value
-column:
My_Cool_String | My Block Name
In order to include translations in your mod, add a correctly named MyTexts
-files for the respective language in your mod:
Also add the corresponding SBL-file for the language to your mod.
Ensure that the Name
-column always stays the same, but replace the strings within the Value
-column with the translation of the string in the respective language. When a player selects a certain language ingame, the correct translations should immediately be used.