Arma Reforger:Mod Localisation - Revision history

Lou Montana: Some wiki formatting

2024-10-08T14:08:47Z

Some wiki formatting

Lou Montana: Text replacement - "[[OFPEC_tags" to "[[Scripting Tags"

2024-10-02T11:01:41Z

Text replacement - "[[OFPEC_tags" to "[[Scripting Tags"

← Older revision		Revision as of 13:01, 2 October 2024
Line 32:		Line 32:
	\|-		\|-
	\| [[Image:armareforger-localization-set-filename.png]]		\| [[Image:armareforger-localization-set-filename.png]]
	\| 2. Set the name of the file. It's highly recommended to use some [[~~OFPEC_tags~~\|unique tag]] in front of the file name (f.e. ''samplenewcar_localization.st'') to avoid GUID clashes.		\| 2. Set the name of the file. It's highly recommended to use some [[Scripting Tags\|unique tag]] in front of the file name (f.e. ''samplenewcar_localization.st'') to avoid GUID clashes.
	\|-		\|-
	\| [[Image:armareforger-localization-set-class.png]]		\| [[Image:armareforger-localization-set-class.png]]

Reyhard: /* Registering localization table */

2022-10-24T12:10:41Z

Registering localization table

← Older revision		Revision as of 14:10, 24 October 2022
Line 123:		Line 123:
	== Registering localization table ==		== Registering localization table ==

			[[Image:armareforger-localization-workbench-options-add.png\|right]]
	Next step is registering of localization table in game project file. To do so, navigate to '''Workbench → Options'''		Next step is registering of localization table in game project file. To do so, navigate to '''Workbench → Options'''

	[[Image:armareforger-localization-workbench-settings.png]]		[[Image:armareforger-localization-workbench-settings.png]]

	~~[[Image:armareforger-localization-workbench-options-add.png\|right]]~~

	# Make sure that you are editing correct game project by checking which addon is shown in '''drop down menu (1)'''. In this case it's '''SampleMod_NewCar'''		# Make sure that you are editing correct game project by checking which addon is shown in '''drop down menu (1)'''. In this case it's '''SampleMod_NewCar'''
Line 138:		Line 137:
	# Select '''runtime stringtable file (8)''' appropriate to the language code which was created in previous step. In this case code is en_us, so String Table Runtime is ''samplenewcar_localization.en_us.conf''		# Select '''runtime stringtable file (8)''' appropriate to the language code which was created in previous step. In this case code is en_us, so String Table Runtime is ''samplenewcar_localization.en_us.conf''

	~~{{Clear}}~~
	If all steps were performed correctly, new string table should be now ready to be used!		If all steps were performed correctly, new string table should be now ready to be used!

			{{Clear}}

	Restart of the workbench might be necessary to initialize new string tables properly.		{{Feature\|important\|Restart of the workbench might be necessary to initialize new string tables properly.}}


	== Localizing assets ==		== Localizing assets ==

Reyhard: /* Creating new localization files */

2022-10-24T12:08:38Z

Creating new localization files

← Older revision		Revision as of 14:08, 24 October 2022
Line 13:		Line 13:
	[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]		[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]
	New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[#Localization_targets_table\|Localization Targets Table]]).{{Clear}}		New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[#Localization_targets_table\|Localization Targets Table]]).{{Clear}}
	[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|~~347x347px~~]]		[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|532x532px]]
	If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.		If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.

Reyhard: /* Creating new localization files */

2022-10-24T12:08:11Z

Creating new localization files

← Older revision		Revision as of 14:08, 24 October 2022
Line 12:		Line 12:
	{{Feature\|informative\|This is '''recommended method'''}}		{{Feature\|informative\|This is '''recommended method'''}}
	[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]		[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]
	New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[~~Arma Reforger:Mod Localisation~~\|Localization Targets Table]]).{{Clear}}		New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[#Localization_targets_table\|Localization Targets Table]]).{{Clear}}
	[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|347x347px]]		[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|347x347px]]
	If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.		If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.

	In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to [[~~Arma Reforger:Mod Localisation~~\|Register Localization Table]] segment{{Clear}}		In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to [[#Registering_localization_table\|Register Localization Table]] segment{{Clear}}

	=== Manual method ===		=== Manual method ===

Reyhard at 12:06, 24 October 2022

2022-10-24T12:06:45Z

← Older revision		Revision as of 14:06, 24 October 2022
Line 10:		Line 10:

	=== Creating new localization files ===		=== Creating new localization files ===
	{{Feature\|informative\|~~See~~ [[~~Arma Reforger~~:~~Diag Menu~~\|~~Diag Menu~~]] ~~for more information.}}~~New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - ~~Localizationtargetstable~~ ).		{{Feature\|informative\|This is '''recommended method'''}}
			[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]
			New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[Arma Reforger:Mod Localisation\|Localization Targets Table]]).{{Clear}}
			[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|347x347px]]
	If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.		If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.

	In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to ~~Registeringlocalizationtable~~ segment		In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to [[Arma Reforger:Mod Localisation\|Register Localization Table]] segment{{Clear}}

	=== Manual method ===		=== Manual method ===

Reyhard: /* Manual method */

2022-10-24T12:00:13Z

Manual method

← Older revision		Revision as of 14:00, 24 October 2022
Line 18:		Line 18:
	=== Manual method ===		=== Manual method ===
	{{Feature\|important\|This method is obsolete and is no longer recommended}}		{{Feature\|important\|This method is obsolete and is no longer recommended}}
			<spoiler>

	==== Creating new string stable ====		==== Creating new string stable ====
Line 61:		Line 62:
	In next dialog, fill name of that new run time string table (i.e. ''samplenewcar_localization.en_us.conf'')''.'' Once that step is completed, a new window will appear, asking you to '''choose a class''' of new config - this time '''StringTableRuntime''' should be used.		In next dialog, fill name of that new run time string table (i.e. ''samplenewcar_localization.en_us.conf'')''.'' Once that step is completed, a new window will appear, asking you to '''choose a class''' of new config - this time '''StringTableRuntime''' should be used.

	Depending on how many languages are supposed to be translated, repeat above steps till all translation variants are created.		Depending on how many languages are supposed to be translated, repeat above steps till all translation variants are created.</spoiler>

	=== Localization targets table ===		=== Localization targets table ===

Reyhard: update localization string table

2022-10-24T11:59:43Z

update localization string table

← Older revision		Revision as of 13:59, 24 October 2022
Line 9:		Line 9:
	Creating of new string table (.st) file is described on String Editor - New *.st file page and below is quick rehearsal of those instructions		Creating of new string table (.st) file is described on String Editor - New *.st file page and below is quick rehearsal of those instructions

	=== Creating new string stable ===		=== Creating new localization files ===
			{{Feature\|informative\|See [[Arma Reforger:Diag Menu\|Diag Menu]] for more information.}}New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - Localizationtargetstable ).

			If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.

			In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to Registeringlocalizationtable segment

			=== Manual method ===
			{{Feature\|important\|This method is obsolete and is no longer recommended}}

			==== Creating new string stable ====

	{\| class="wikitable"		{\| class="wikitable"
Line 25:		Line 35:
	\|}		\|}

	=== Setting basic parameters ===		==== Setting basic parameters ====

	If those steps above were performed successfully, a new '''localization_MyAddon.st''' should be now visible in '''Resource Manager''' asset browser.		If those steps above were performed successfully, a new '''localization_MyAddon.st''' should be now visible in '''Resource Manager''' asset browser.
Line 42:		Line 52:
	[[Image:armareforger-localization-stringtable-empty.png]]		[[Image:armareforger-localization-stringtable-empty.png]]

	=== Adding runtime string tables ===		==== Adding runtime string tables ====

	[[Image:armareforger-localization-create-config.png\|right]]		[[Image:armareforger-localization-create-config.png\|right]]
Line 52:		Line 62:

	Depending on how many languages are supposed to be translated, repeat above steps till all translation variants are created.		Depending on how many languages are supposed to be translated, repeat above steps till all translation variants are created.

	~~Below is small table showing various localization targets shortcuts~~

	=== Localization targets table ===		=== Localization targets table ===

			Below is small table showing various localization targets shortcuts
	{\| class="wikitable"		{\| class="wikitable"
	\| '''en_us'''		\| '''en_us'''

Lou Montana: Fix

2022-07-30T18:34:49Z

Fix

← Older revision		Revision as of 20:34, 30 July 2022
Line 198:		Line 198:
	{{Feature\|informative\|Please utilize '''LocaleEditBox''' when exposing variables in script		{{Feature\|informative\|Please utilize '''LocaleEditBox''' when exposing variables in script

	<enforce>[Attribute(uiwidget: UIWidgets.LocaleEditBox, defvalue: "#AR-Editor_Hint_Intro_Title")]		<enforce>
	protected LocalizedString m_sIntroHintTitle;</enforce>}}		[Attribute(uiwidget: UIWidgets.LocaleEditBox, defvalue: "#AR-Editor_Hint_Intro_Title")]
			protected LocalizedString m_sIntroHintTitle;
			</enforce>
			}}

	== Testing result in-game ==		== Testing result in-game ==

Lou Montana: Text replacement - "" to ""

2022-07-30T18:20:59Z

Text replacement - "</syntaxhighlight >" to "</enforce>"

← Older revision		Revision as of 20:20, 30 July 2022
Line 199:		Line 199:

	<enforce>[Attribute(uiwidget: UIWidgets.LocaleEditBox, defvalue: "#AR-Editor_Hint_Intro_Title")]		<enforce>[Attribute(uiwidget: UIWidgets.LocaleEditBox, defvalue: "#AR-Editor_Hint_Intro_Title")]
	protected LocalizedString m_sIntroHintTitle;</~~syntaxhighlight~~ >}}		protected LocalizedString m_sIntroHintTitle;</enforce>}}

	== Testing result in-game ==		== Testing result in-game ==

← Older revision		Revision as of 14:08, 24 October 2022
Line 12:		Line 12:
	{{Feature\|informative\|This is '''recommended method'''}}		{{Feature\|informative\|This is '''recommended method'''}}
	[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]		[[File:armareforger-localization-workbench-create-new.png\|right\|frameless\|544x544px]]
	New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[~~Arma Reforger:Mod Localisation~~\|Localization Targets Table]]).{{Clear}}		New localization files - string table and runtime string tables - can be simply created via '''File → New''' option (alternatively, Ctrl+N shortcut can be used). Once activated, a new pop up window will appear and ask you to provide file name and location of new localization files. After it is confirmed with '''OK''' button, '''String Editor''' will create new '''.st file''' and '''runtime configs for all languages''' available in-game (see this table for list of languages - [[#Localization_targets_table\|Localization Targets Table]]).{{Clear}}
	[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|347x347px]]		[[File:armareforger-localization-workbench-create-new-files.png\|right\|frameless\|347x347px]]
	If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.		If you don't plan to translate your addon into all languages (see , you can '''safely remove unnecessary config files''' and recreate them at later point manually.

	In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to [[~~Arma Reforger:Mod Localisation~~\|Register Localization Table]] segment{{Clear}}		In any case, at this stage it is possible to move forward and register both '''string table''' and '''runtime stringtable configs''' in Workbench options. To do so, skip to [[#Registering_localization_table\|Register Localization Table]] segment{{Clear}}

	=== Manual method ===		=== Manual method ===