I18N.pl - Revision history

Geep: In Intro, correct "fm_translate.pl" to "I18N.pl". Add missing step to make strings folder & copy english.lang

2025-06-19T02:02:47Z

In Intro, correct "fm_translate.pl" to "I18N.pl". Add missing step to make strings folder & copy english.lang

← Older revision		Revision as of 02:02, 19 June 2025
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	The script ~~fm_translate~~.pl separates the main FM data from all the texts and other assets that need to be changed in order for translation. It can either transform an English FM, or match an English FM to other languages.		The script I18N.pl separates the main FM data from all the texts and other assets that need to be changed in order for translation. It can either transform an English FM, or match an English FM to other languages.

	== Requirements ==		== Requirements ==
Line 7:		Line 7:
	* Perl. For Windows, use [http://strawberryperl.com/ Strawberry Perl].		* Perl. For Windows, use [http://strawberryperl.com/ Strawberry Perl].
	* The script from [http://bloodgate.com/mirrors/tdm/pub/scripts/ Bloodgate].		* The script from [http://bloodgate.com/mirrors/tdm/pub/scripts/ Bloodgate].
	* The language files under '''<tt>strings/*.lang</tt>'''		* The TDM-distribution language files under '''<tt>strings/*.lang</tt>'''

	== Usage ==		== Usage ==
Line 25:		Line 25:
	chdir c:\I18N\I18N.pl		chdir c:\I18N\I18N.pl

			* Make a "\strings\" subdirectory, and copy TDM's "english.lang" there (and any other .lang files for which you have myfm_<lang>.pk4 versions).
	* Run the script (we assume here you have only the english version:)		* Run the script (we assume here you have only the english version:)

Line 48:		Line 49:
	cd ~/I18N/I18N.pl		cd ~/I18N/I18N.pl

			* Make a "/strings/" subdirectory, and copy TDM's "english.lang" there (and any other .lang files for which you have myfm_<lang>.pk4 versions).
	* Run the script (we assume here you have only the english version:)		* Run the script (we assume here you have only the english version:)

Frost Salamander: redo Perl download link step - direct download link didn't work for some reason. Also specify the file name you need to download.

2022-09-09T09:16:08Z

redo Perl download link step - direct download link didn't work for some reason. Also specify the file name you need to download.

← Older revision		Revision as of 09:16, 9 September 2022
Line 16:		Line 16:

	* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot		* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot
	* Download ~~this ZIP file:~~ [http://bloodgate.com/mirrors/tdm/pub/scripts/~~I18N_script~~.~~zip]~~		* Download '''I18N_script.zip''' from [http://bloodgate.com/mirrors/tdm/pub/scripts/ here].
	* Extract the contents of this file to somewhere, f.i. <tt>'''C:\'''</tt>, so that you now have there an I18N directory with a directory ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.		* Extract the contents of this file to somewhere, f.i. <tt>'''C:\'''</tt>, so that you now have there an I18N directory with a directory ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
	* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")		* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")
Line 39:		Line 39:

	* Install Perl (it is probably already installed)		* Install Perl (it is probably already installed)
	* Download ~~this ZIP file:~~ [http://bloodgate.com/mirrors/tdm/pub/scripts/~~I18N_script~~.~~zip]~~		* Download '''I18N_script.zip''' from [http://bloodgate.com/mirrors/tdm/pub/scripts/ here].
	* Extract the contents of this file to somewhere, f.i. <tt>'''/home/yourusernamehere/'''</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.		* Extract the contents of this file to somewhere, f.i. <tt>'''/home/yourusernamehere/'''</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
	* Open this directory in your favourite file manager, and copy your FM's PK4 file to it (for example '''<tt>myfm.pk4</tt>''')		* Open this directory in your favourite file manager, and copy your FM's PK4 file to it (for example '''<tt>myfm.pk4</tt>''')

Grayman: /* README.txt and darkmod.txt */

2018-01-08T02:42:37Z

README.txt and darkmod.txt

← Older revision		Revision as of 02:42, 8 January 2018
Line 83:		Line 83:
	=== README.txt and darkmod.txt ===		=== README.txt and darkmod.txt ===

	Due to [http://bugs.~~angua~~.at/view.php?id=3012 bug #3012] README.txt and darkmod.txt cannot yet be translated.		Due to [http://bugs.thedarkmod.com/view.php?id=3012 bug #3012] README.txt and darkmod.txt cannot yet be translated.

	== FAQ ==		== FAQ ==

Tels: update after coments by grayman

2012-07-07T09:32:43Z

update after coments by grayman

← Older revision		Revision as of 09:32, 7 July 2012
Line 10:		Line 10:

	== Usage ==		== Usage ==

			In the following examples we will use ''myfm'' in place of your FM name:

	=== Windows ===		=== Windows ===
Line 15:		Line 17:
	* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot		* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot
	* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]		* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]
	* Extract the contents of this file to somewhere, f.i. <tt>'''C:\'''</tt>, so that you now have there an I18N directory with a ~~file~~ ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.		* Extract the contents of this file to somewhere, f.i. <tt>'''C:\'''</tt>, so that you now have there an I18N directory with a directory ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
	* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")		* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")
	* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.		* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.
Line 21:		Line 23:
	* Navigate to the directory you have uncompressed the script to, e.g. by typing		* Navigate to the directory you have uncompressed the script to, e.g. by typing

	chdir c:\I18N		chdir c:\I18N\I18N.pl

	* Run the script (we assume here you have only the english version:)		* Run the script (we assume here you have only the english version:)
Line 30:		Line 32:

	<pre>		<pre>
	C:\I18N\output\myfm.pk4		C:\I18N\I18N.pl\output\myfm.pk4
	C:\I18N\output\myfm_l10n.pk4		C:\I18N\I18N.pl\output\myfm_l10n.pk4
	</pre>		</pre>

Line 44:		Line 46:
	* Navigate to the directory you have uncompressed the script to, e.g. by typing		* Navigate to the directory you have uncompressed the script to, e.g. by typing

	cd ~/I18N		cd ~/I18N/I18N.pl

	* Run the script (we assume here you have only the english version:)		* Run the script (we assume here you have only the english version:)
Line 53:		Line 55:

	<pre>		<pre>
	output/myfm.pk4		./output/myfm.pk4
	output/myfm_l10n.pk4		./output/myfm_l10n.pk4
	</pre>		</pre>

	== The FM dictionaries ==		== The FM dictionaries ==

	Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string templates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.		Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string templates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file (named ''myfm_l10n.pk4''), they can be found inside this file under the directory '''strings/fm/'''.

	See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.		See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.

	== Bugs ==		== Bugs ==

			=== GUI files ===

	Currently GUI files are not parsed, and thus their strings not entered into the FM dictionary. Mainly this means you need to manually edit '''guis/maps/FMNAME.gui''' and replace things like:		Currently GUI files are not parsed, and thus their strings not entered into the FM dictionary. Mainly this means you need to manually edit '''guis/maps/FMNAME.gui''' and replace things like:
Line 76:		Line 80:

	{{infobox\|Also note that the main PK4 file should '''always''' contain a copy of the strings/fm/english.lang file, so that people who do not have the _l10n.pk4 file can still play the FM.}}		{{infobox\|Also note that the main PK4 file should '''always''' contain a copy of the strings/fm/english.lang file, so that people who do not have the _l10n.pk4 file can still play the FM.}}

			=== README.txt and darkmod.txt ===

			Due to [http://bugs.angua.at/view.php?id=3012 bug #3012] README.txt and darkmod.txt cannot yet be translated.

	== FAQ ==		== FAQ ==

Grayman: /* The FM dictionaries */

2012-07-06T17:52:37Z

The FM dictionaries

← Older revision		Revision as of 17:52, 6 July 2012
Line 59:		Line 59:
	== The FM dictionaries ==		== The FM dictionaries ==

	Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string ~~temlates~~ like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.		Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string templates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.

	See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.		See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.

Tels: typos

2011-11-28T21:07:39Z

typos

← Older revision		Revision as of 21:07, 28 November 2011
Line 15:		Line 15:
	* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot		* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot
	* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]		* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]
	* Extract the contents of this file to somewhere, f.i. <tt>'''C:\</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.		* Extract the contents of this file to somewhere, f.i. <tt>'''C:\'''</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
	* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")		* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")
	* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.		* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.
Line 38:		Line 38:
	* Install Perl (it is probably already installed)		* Install Perl (it is probably already installed)
	* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]		* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]
	* Extract the contents of this file to somewhere, f.i. <tt>'''/home/yourusernamehere/</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.		* Extract the contents of this file to somewhere, f.i. <tt>'''/home/yourusernamehere/'''</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
	* Open this directory in your favourite file manager, and copy your FM's PK4 file to it (for example "myfm.pk4")		* Open this directory in your favourite file manager, and copy your FM's PK4 file to it (for example '''<tt>myfm.pk4</tt>''')
	* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.		* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named <tt>'''myfm_italian.pk4'''</tt> which is '''the same version of your FM, but in Italian''', then copy it there, too.
	* Open a console		* Open a console
	* Navigate to the directory you have uncompressed the script to, e.g. by typing		* Navigate to the directory you have uncompressed the script to, e.g. by typing
Line 76:		Line 76:

	{{infobox\|Also note that the main PK4 file should '''always''' contain a copy of the strings/fm/english.lang file, so that people who do not have the _l10n.pk4 file can still play the FM.}}		{{infobox\|Also note that the main PK4 file should '''always''' contain a copy of the strings/fm/english.lang file, so that people who do not have the _l10n.pk4 file can still play the FM.}}

			== FAQ ==

			=== Do I need different languages of my FM? ===

			No, the script can also just use the English version. But the English version is mandatory, you cannot just use a French FM!

			=== How must the PK4 files be named? ===

			The names can be anything, they are not important.

			=== Do I need to increase the version of my FM? ===

			The FM database on thedarkmod.com uses an arbitrary integer to denote the current version, everytime this is incremented, users which have the same FM with a lesser number get asked to upgrade it.

			However, it is a wise idea to increase the version in your README, too, because that is the one that users will refer to when talking about your FM.

			=== My mission has image files with text on it. How do I translate them? ===

			See this article [[I18N - Translating Fan Missions\|Translating Fan Missions]].

			=== Who can do the translation? ===

			Anybody who wants to. There is a [[I18N_-_List_of_TDM_translators\|list of translators]], these people might be able to help you.

	== See also ==		== See also ==
Line 82:		Line 106:
	* [[I18N - Translating Fan Missions\|Translating Fan Missions]]		* [[I18N - Translating Fan Missions\|Translating Fan Missions]]
	* [http://strawberryperl.com/ Strawberry Perl].		* [http://strawberryperl.com/ Strawberry Perl].
	* [http://bloodgate.com/mirrors/tdm/pub/scripts/ The script itself]		* [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip The script itself]

	{{editing}}		{{editing}}

Tels: update

2011-11-28T20:56:40Z

update

← Older revision		Revision as of 20:56, 28 November 2011
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	The script fm_translate.pl separates the main FM data from all the texts and other assets that need to be changed in order for translation.		The script fm_translate.pl separates the main FM data from all the texts and other assets that need to be changed in order for translation. It can either transform an English FM, or match an English FM to other languages.

	== Requirements ==		== Requirements ==
Line 11:		Line 11:
	== Usage ==		== Usage ==

	On a console (a "DOS Window" under ~~Windows)~~:		=== Windows ===

			* Install Perl from [http://strawberryperl.com/ Strawberry Perl]. You may need to reboot
			* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]
			* Extract the contents of this file to somewhere, f.i. <tt>'''C:\</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
			* Open this directory in Explorer, and copy your FM's PK4 file to it (for example "myfm.pk4")
			* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.
			* Open a console aka a "DOS Window" (see [http://www.computerhope.com/issues/chdos.htm here] if you do not know how to do this)
			* Navigate to the directory you have uncompressed the script to, e.g. by typing

			chdir c:\I18N

			* Run the script (we assume here you have only the english version:)

			perl I18N.pl --english myfm.pk4

			The output packages will be created under output, as:

	<pre>		<pre>
	~~perl fm_translate.pl --english fms/outpost/outpost~~.pk4 ~~--french fms/avant_poste~~.pk4		C:\I18N\output\myfm.pk4
			C:\I18N\output\myfm_l10n.pk4
	</pre>		</pre>

			=== Linux ===

			* Install Perl (it is probably already installed)
			* Download this ZIP file: [http://bloodgate.com/mirrors/tdm/pub/scripts/I18N_script.zip]
			* Extract the contents of this file to somewhere, f.i. <tt>'''/home/yourusernamehere/</tt>, so that you now have there an I18N directory with a file ''I18N.pl'' in it. The text below assumes you have choosen that path. If not, replace it everywhere it occurs.
			* Open this directory in your favourite file manager, and copy your FM's PK4 file to it (for example "myfm.pk4")
			* If you have other versions of your FM in a different language, copy them there, too. For instance if you have a file named "myfm_italian.pk4" which is '''the same version of your FM, but in Italian''', then copy it there, too.
			* Open a console
			* Navigate to the directory you have uncompressed the script to, e.g. by typing

			cd ~/I18N

			* Run the script (we assume here you have only the english version:)

			perl I18N.pl --english myfm.pk4

	The output packages will be created under output, as:		The output packages will be created under output, as:

	<pre>		<pre>
	output/~~outpost~~.pk4		output/myfm.pk4
	output/~~outpost_i18n~~.pk4		output/myfm_l10n.pk4
	</pre>		</pre>

	=== The FM dictionaries ===		== The FM dictionaries ==

	Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string temlates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.		Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string temlates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.

Tels: update

2011-11-27T11:30:14Z

update

← Older revision		Revision as of 11:30, 27 November 2011
Line 29:		Line 29:

	See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.		See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.

			== Bugs ==

			Currently GUI files are not parsed, and thus their strings not entered into the FM dictionary. Mainly this means you need to manually edit '''guis/maps/FMNAME.gui''' and replace things like:

			text "Mission Loading"

			with

			text "#str_02236" // Mission Loading

			If there are other texts in it, like "Loading finished", and these cannot be found in strings/all.lang in the TDM core, then you need to use numbers above 20000 (best use 20100 and above) and then also add the strings into the '''strings/fm/english.lang''' etc. file.

			{{infobox\|Also note that the main PK4 file should '''always''' contain a copy of the strings/fm/english.lang file, so that people who do not have the _l10n.pk4 file can still play the FM.}}

	== See also ==		== See also ==

Tels: fix link

2011-10-21T16:28:28Z

fix link

← Older revision		Revision as of 16:28, 21 October 2011
Line 28:		Line 28:
	Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string temlates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.		Once the script is finished, it will replace as much hard-coded strings like "Silver Key" with string temlates like "#str_20000" and place these in a FM-specific dictionary. These dictionaries are put into a sep. PK4 file under the directory '''strings/fm/'''.

	See '''[[~~Internationalization#FM_specific_dictionaries~~\|here]]''' for examples and how to translate these files.		See '''[[I18N - Translating Fan Missions\|here]]''' for examples and how to translate these files.

	== See also ==		== See also ==

	* [[Internationalization]] - Main article		* [[Internationalization]] - Main article
			* [[I18N - Translating Fan Missions\|Translating Fan Missions]]
	* [http://strawberryperl.com/ Strawberry Perl].		* [http://strawberryperl.com/ Strawberry Perl].
	* [http://bloodgate.com/mirrors/tdm/pub/scripts/ The script itself]		* [http://bloodgate.com/mirrors/tdm/pub/scripts/ The script itself]

	{{editing}}		{{editing}}

Tels: add note about string files

2011-10-13T17:55:09Z

add note about string files

← Older revision		Revision as of 17:55, 13 October 2011
Line 7:		Line 7:
	* Perl. For Windows, use [http://strawberryperl.com/ Strawberry Perl].		* Perl. For Windows, use [http://strawberryperl.com/ Strawberry Perl].
	* The script from [http://bloodgate.com/mirrors/tdm/pub/scripts/ Bloodgate].		* The script from [http://bloodgate.com/mirrors/tdm/pub/scripts/ Bloodgate].
			* The language files under '''<tt>strings/*.lang</tt>'''

	== Usage ==		== Usage ==