Stringtable.xml

From Bohemia Interactive Community
Jump to: navigation, search

Stringtable.xml

String tables are used to make internationalization easier for the game. They are used in addons, missions, and scripts, and are located in the root of the mission or addon folders.

Any strings that are used in the game can be kept separate from the code, and can therefore easily be edited and expanded into different languages. Instead of using strings directly in the code, you are using a variable. This variable will then contain the actual string, read from stringtable.xml, with the language that's being read depending on the game settings.

Example Format
<?xml version="1.0" encoding="utf-8" ?>
<Project name="Any Name">
	<Package name="Mission One">
		<Container name="Some Words">
			<Key ID="str_myTag_Yes">
				<Original>yes</Original>
				<English>yes</English>
				<Czech>ano</Czech>
				<French>oui</French>
				<German>ja</German>
				<Italian>sì</Italian>
				<Polish>tak</Polish>
				<Portuguese>sim</Portuguese>
				<Russian>да</Russian>
				<Spanish>sí</Spanish>
				<Korean></Korean>
				<Japanese>はい</Japanese>
                <Chinesesimp></Chinesesimp>
                <Chinese>是(繁體)</Chinese>
			</Key>
			<Key ID="str_myTag_No">
				<Original>no</Original>
			</Key>
		</Container>
		<Container name="Another Container">
			<Key ID="str_myTag_another_key">
				<Original></Original>
			</Key>
			<Key ID="str_myTag_formatted">
				<Original>Hello, %1.</Original>
			</Key>
			<Key ID="str_myTag_structured">
				<Original>Some text &amp;lt;t color='%1'&amp;gt;%2&amp;lt;/t&amp;gt;</Original>
			</Key>
		</Container>
	</Package>
</Project>

Good practice:

  • Replace myTag in str_myTag_someKey with your OFPEC tag or other means of personal identification so other addon and mission string names won't collide, potentially breaking your mission
  • Package and container names appear to only be for organizational use; use them for your own sanity
Stringtable.xml must be saved with UTF-8 Encoding for international characters to display and save correctly!


Naming Key IDs

If you are planning to use your stringtable.xml with scripts only, there are no rules in regards to naming format of Key IDs. localize and isLocalized will work with any name, as long as it matches Key ID name in stringtable.xml. For example:

// stringtable.xml
<?xml version="1.0" encoding="utf-8" ?>
<Project name="Any Name">
	<Package name="Mission One">
		<Container name="Some Words">
			<Key ID="myCrazyNameTag">
				<Original>wuga wuga</Original>
			</Key>
		</Container>
	</Package>
</Project>

// some script hint str isLocalized "myCrazyNameTag"; // true hint str localize "myCrazyNameTag"; // "wuga wuga"

However, if you are also going to use stringtable.xml with configs, you must use special prefix $STR (dollar sign $ followed by uppercase STR) to reference Key ID in config. The Key IDs in stringtable.xml will have to start with "str" or "STR" accordingly, case doesn't matter here.

🛈
By convention, an underscore _ is added to the prefix STR_ ($STR_). It provides clarity and makes stringtable.xml universally compatible with both scripts and configs.

For example:

// stringtable.xml
<?xml version="1.0" encoding="utf-8" ?>
<Project name="Any Name">
	<Package name="Mission One">
		<Container name="Some Words">
			<Key ID="STR_myKey">
				<Original>Hey there</Original>
			</Key>
		</Container>
	</Package>
</Project>
// config entry
class Test
{
	word = $STR_myKey;
};

hint str getText (configFile >> "Test" >> "word"); // "Hey there"


Supported languages

Arma 3

  • English
  • Czech
  • French
  • Spanish
  • Italian
  • Polish
  • Portuguese
  • Russian
  • German
  • Korean (region exclusive)
  • Japanese (region exclusive)
  • Chinese 繁體中文 (Chinese Traditional)
  • Chinesesimp 简体中文 (Chinese Simplified)
  • Turkish
  • Swedish
  • Slovak
  • SerboCroatian
  • Norwegian
  • Icelandic
  • Hungarian
  • Greek
  • Finnish
  • Dutch

Arma 2: Operation Arrowhead

  • English
  • Czech
  • French
  • Spanish
  • Italian
  • Polish
  • Russian
  • German


Usage

Scripts

A string from Stringtable.xml can be retrieved and used in a script by using the localize command:

hint localize "str_myTag_Yes";

"Marker1" setMarkerTextLocal localize "str_myTag_SeizeTheTown";

hint format [ localize "str_myTag_formatted", "Dave" ]; // "Hello, Dave."
// str_myTag_formatted:		<Original>Hello, %1.</Original>


The stringtable can also hold Structured Text xml tags, if the tag characters < > are encoded as &lt; < and &gt; > see: HTML Entities

hint parseText format [ localize "str_myTag_structured", "#FF0000", "with Color!" ]; //show 'with Color!' in Red   // str_myTag_structured: <English>Some text &lt;t color='%1'&gt;%2&lt;/t&gt;</English> // after format & parseText: Some text <t color='#FF0000'>with Color!</t>


Description.ext

Stringtable values can be used in the Description.ext config by typing the key as such, $STR_myTag_keyName , and without quotation marks; these will be replaced by the preprocessor:

onLoadName = $STR_myTag_missionName; onLoadMission = $STR_myTag_loadMissionText; overviewText = $STR_myTag_overviewText; overviewPicture = $STR_myTag_overviewImage;


Dialogs

As with Description.ext, the preprocessor will replace the values in configs as long as the key name is formatted correctly (see above) :

class RscText_1012: RscText { idc = 1012; text = $STR_myTag_someLabelText; tooltip = $STR_myTag_someTip; … };


CfgRadio

Stringtable entries can also be used for sounds and radio sentences in CfgRadio, also residing in Description.ext:

class CfgRadio { sounds[] = {}; class RadioMsg1 { name = ""; sound[] = { $STR_myTag_sound_RadioMsg1, db-100, 1.0 }; title = $STR_myTag_RadioMsg1; }; }; // str_myTag_sound_RadioMsg1: <English>\sound\radiomsg1_en.ogg</English> // <Czech>\sound\radiomsg1_cz.ogg</Czech> // str_myTag_RadioMsg1: <English>I am ready for your orders.</English>


Multiplayer

Multiplayer scripts should consider their translation implementation when clients and server are likely in varied localizations, and be mindful of text commands with global effect (such as setMarkerText for example).

Example of client-side translation: // Server-side if (isServer) then { ["str_myTag_myMessage","TAG_fnc_localHint"] call BIS_fnc_MP; // Arma 2 ["str_myTag_myMessage"] remoteExecCall ["TAG_fnc_localHint"]; // Arma 3 };

// Client-side TAG_fnc_localHint = { if (hasInterface) then { hintSilent parseText (localize _this); // Arma 2 hintSilent parseText (_this call BIS_fnc_localize); // Arma 3 }; };


See also BIS_fnc_localize (since Arma 3).