HPL3/Language Configuration - Revision history

TiMan: /* Editing Language Files */

2020-11-06T20:34:44Z

Editing Language Files

TiMan: /* Setting Up Language Files */

2020-11-06T20:33:56Z

Setting Up Language Files

TiMan: /* Overriding Existing Language File Categories */

2020-08-26T14:04:53Z

Overriding Existing Language File Categories

TiMan: /* Overriding Existing Language File Categories */

2020-08-26T13:45:37Z

Overriding Existing Language File Categories

TiMan at 13:41, 26 August 2020

2020-08-26T13:41:09Z

TiMan at 18:08, 25 August 2020

2020-08-25T18:08:43Z

TiMan: Created page with "When displaying any kind of text on the screen in a mod (For example, when picking up a note to reading it), the mod refers to a file in which that text information is stored..."

2020-08-25T17:52:39Z

Created page with "When displaying any kind of text on the screen in a mod (For example, when picking up a note to reading it), the mod refers to a file in which that text information is stored..."

New page

When displaying any kind of text on the screen in a mod (For example, when picking up a note to reading it), the mod refers to a file in which that text information is stored in. That file is called a '''language file'''. Each language has their own language files. So if your mod has English and Czech translations, you will have English and Czech language files.

{{note|Any category content that is placed inside your language file will override the category content of the main game's language file. If you do not need to change the content of a certain category in your language file, do not copy it.}}

@@ Line 62: / Line 62: @@
 ==Editing Language Files==
-{{wip}}
+{{constructionNotice|This is a work in progress section.}}
 The best way to create, edit, and modify language entries and language files, is to use the Language Editor. This editor comes with the game installation and is named <code>LangEditor.exe</code>.

@@ Line 60: / Line 60: @@
    </CATEGORY>
 </syntaxhighlight>The game will use our custom <code>GameOver</code> category instead of the category from the main game language file, because we override it in our language file.
 [[Category:Modding]]
 [[Category:English]]

@@ Line 8: / Line 8: @@
 The content of a language files is divided into '''categories''', each category holds language '''entries'''. A language entry holds the actual text information. The following is an example of a simple language file:<syntaxhighlight lang="xml">
 <LANGUAGE>
-       <MyLanguageCategory>
+       <Category Name="HelloWorld">
             <Entry Name="HelloWorld">Hello World!</Entry>
-       </MyLanguageCategory>
+       </Category >
 </LANGUAGE>
 </syntaxhighlight>
@@ Line 20: / Line 20: @@
 |Each language file begins and closes with a <code><LANGUAGE></code> tag.
 |-
-|MyLanguageCategory
+|Category
-|A category named <code>MyLangaugeCategory</code>. You can name categories however you want, but if the name of the category is the same of an existing category in the main game's language file, that category will be overridden by yours.
+|A language category. Inside, all of the language entries will be listed.
 |-
 |Entry
 |A language entry tag. This holds the actual text information <code>Hello World!</code>
 |-
-|Name
+|Entry Name
 |The name of the entry. Each entry needs to have a name attribute so the game will be able to read the text from it.
 |}
@@ Line 41: / Line 44: @@
 '''The file should be located inside the mod's <code>config/lang</code> folder, unless specified otherwise in the [[HPL3/Launch Configuration|Launch Configuration file]].'''
-=== Overriding Existing Language File Categories ===
+===Overriding Existing Language File Categories===
-It is possible to override game
+It is possible to override the main game's language categories and entries. It is useful if you want to change default values for certain text, or if you want to add new entries to a category. To override a main game language category simply create the same category in your own language file.
-{{note|Any category content that is placed inside your language file will override the category content of the main game's language file. If you do not need to change the content of a certain category in your language file, do not copy it.}}
+{{note|If you do not need to change the content of a certain category in your language file, do not copy it.}}
 [[Category:Modding]]
 [[Category:English]]

@@ Line 42: / Line 42: @@
 === Overriding Existing Language File Categories ===
 {{note|Any category content that is placed inside your language file will override the category content of the main game's language file. If you do not need to change the content of a certain category in your language file, do not copy it.}}
 [[Category:Modding]]
 [[Category:English]]

@@ Line 1: / Line 1: @@
 {{shortPageTitle}}
-When displaying any kind of text on the screen (For example, when picking up a note and reading it), the mod refers to a file in which that text information is stored in. That file is called a '''language file'''. Each language has their own language files. For example, if your mod has English and Czech translations, you will have separate English and Czech language files.
+When displaying any kind of text on the screen (For example, when picking up a note and reading it), the mod refers to a file in which that text information is stored in. That file is called a '''language file'''. Each language has their own language files. For example, if your mod has English and Czech translations, you will have separate English and Czech language files.{{note|Not every mod requires a language file. Only if your mod has notes, messages, translations and so on, it should have its own language file.}}
-{{note|Not every mod requires a language file. Only if your mod has notes, messages, translations and so on, it should have its own language file.}}
+==Setting Up Language Files==
-== Setting Up Language Files ==
+When configuring a language for a mod, you need to have two separate files: a base language file, and a main language file. For example, if your mod has English and Czech languages, you will have 4 language files in total. A language file's extension ends with <code>.lang</code>
-=== Base Language File ===
+'''The file should be located inside the mod's <code>config</code> folder, unless specified otherwise in the [[HPL3/Launch Configuration|Launch Configuration file]].'''
-{{note|Any category content that is placed inside your language file will override the category content of the main game's language file. If you do not need to change the content of a certain category in your language file, do not copy it.}}
+===Main Language File===
-{{tip|Look at the structure of the main game's language files and try to mimic that in your own language file. There is no need to re-invent the wheel or guess how to properly structure it if the main game already offers a solution for that.}}
+'''The file should be located inside the mod's <code>config/lang</code> folder, unless specified otherwise in the [[HPL3/Launch Configuration|Launch Configuration file]].'''
-=== Main Language File ===
+=== Overriding Existing Language File Categories ===
 [[Category:Modding]]
 [[Category:English]]

← Older revision		Revision as of 18:08, 25 August 2020
Line 1:		Line 1:
−	When displaying any kind of text on the screen ~~in a mod~~ (For example, when picking up a note to reading it), the mod refers to a file in which that text information is stored in. That file is called a '''language file'''. Each language has their own language files. So if your mod has English and Czech translations, you will have English and Czech language files.	+	{{wip}}
		+
		+	{{shortPageTitle}}
		+	When displaying any kind of text on the screen (For example, when picking up a note and reading it), the mod refers to a file in which that text information is stored in. That file is called a '''language file'''. Each language has their own language files. For example, if your mod has English and Czech translations, you will have separate English and Czech language files.
		+
		+	{{note\|Not every mod requires a language file. Only if your mod has notes, messages, translations and so on, it should have its own language file.}}
		+
		+	== Setting Up Language Files ==
		+
		+
		+	=== Base Language File ===

	{{note\|Any category content that is placed inside your language file will override the category content of the main game's language file. If you do not need to change the content of a certain category in your language file, do not copy it.}}		{{note\|Any category content that is placed inside your language file will override the category content of the main game's language file. If you do not need to change the content of a certain category in your language file, do not copy it.}}
		+
		+	{{tip\|Look at the structure of the main game's language files and try to mimic that in your own language file. There is no need to re-invent the wheel or guess how to properly structure it if the main game already offers a solution for that.}}
		+
		+	=== Main Language File ===
		+
		+	[[Category:Modding]]
		+	[[Category:English]]