HPL3/Launch Configuration - Revision history

Crater: Added new Amnesia: The Bunker StartMap syntax

2023-07-15T18:31:02Z

Added new Amnesia: The Bunker StartMap syntax

TiMan at 17:55, 25 August 2020

2020-08-25T17:55:25Z

TiMan: /* Variables */

2020-08-25T14:31:39Z

Variables

TiMan: /* Attributes */

2020-08-25T14:10:02Z

Attributes

TiMan: /* Attributes */

2020-08-25T14:07:26Z

Attributes

TiMan: /* Launch Configuration File */

2020-08-25T13:41:26Z

Launch Configuration File

TiMan: /* Launch Configuration File */

2020-08-25T13:22:49Z

Launch Configuration File

TiMan: /* Minimal Configuration */

2020-08-25T13:21:16Z

Minimal Configuration

TiMan: Created page with "When a mod is launched, some initialization occurs and the game is configured before the mod shows up. This article explains how to configure the startup of a mod. == Launch..."

2020-08-25T13:21:05Z

Created page with "When a mod is launched, some initialization occurs and the game is configured before the mod shows up. This article explains how to configure the startup of a mod. == Launch..."

New page

When a mod is launched, some initialization occurs and the game is configured before the mod shows up. This article explains how to configure the startup of a mod.

== Launch Configuration File ==
In order to make the mod launch, we need to list some configurations and settings that affect the initialization of the mod. All of the configurations are listed inside a single XML file, called <code>main_init.cfg</code>. The file should be located inside the <code>config</code> folder of the mod. When launching a mod, either via debug mode or via the game, the mod will first read the data from this file.

=== Minimal Configuration ===
These are the minimal settings that should be inside a <code>main_init.cfg</code> file:

{{expandBox|
<syntaxhighlight lang="xml">
<Directories
MainSaveFolder = "Save Folder Name"
GameLanguageFolder = "config/lang/"
/>

<Variables
GameName = "Mod Name"
/>

<StartMap
File = "map_name.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
</syntaxhighlight>}}

=== Extended Configuration ===
These are the full settings that can be inside a <code>main_init.cfg</code> file in order to apply further customization:

<syntaxhighlight lang="xml">
<ConfigFiles
Resources = "resources.cfg"
Materials = "materials.cfg"
SoundData = "sounddata.cfg"

Game = "config/game.cfg"

DefaultUserSettings = "config/default_user_settings.cfg"
DefaultUserKeys = "config/default_user_keys.cfg"

DefaultBaseLanguage = "base_english.lang"
DefaultGameLanguage = "english.lang"

Modules = "config/Modules.cfg"
EntityTypes = "config/EntityTypes.cfg"
Effects = "config/Effects.cfg"
PlayerStates = "config/PlayerStates.cfg"
/>

<Directories
MainSaveFolder = "Main"

BaseLanguageFolder = "config/"
GameLanguageFolder = "config/lang_main/"
/>

<Variables
GameName = "SOMA"
/>

<MainMenu
File="main_menu.hpm"
Folder="maps/"
Pos=""
/>

<StartMap
File = "00_00_intro.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
</syntaxhighlight>

{{Note|it is recommended to not change most of the settings, and only edit things that should really be customized for your mod, such as mod name, save folder name, etc.}}

=== Attributes ===

@@ Line 1: / Line 1: @@
 When a mod is launched, some initialization occurs and the game is configured before the mod shows up. This article explains how to configure the startup of a mod.
@@ Line 137: / Line 138: @@
 |The [[HPL3/Areas/PlayerStart Area|primary start position]] of the map.
 |}

@@ Line 70: / Line 70: @@
 ===Attributes===
 ----
-==== ConfigFiles ====
+====ConfigFiles====
 {| class="wikitable"
-! Attribute !! Description
+!Attribute!!Description
 |-
 |Resources
@@ Line 102: / Line 102: @@
 |}
-==== Directories ====
+====Directories====
 {| class="wikitable"
-! Attribute !! Description
+!Attribute!!Description
 |-
 |MainSaveFolder
+|The name of the folder which the save files will be placed into.
 |-
 |BaseLanguageFolder
+|The name of the folder where [[HPL3/Language Configuration|base_english.lang]] is located at.
 |-
 |GameLanguageFolder
+|The name of the folder where [[HPL3/Language Configuration|english.lang]] is located at.
 |}
-==== Variables ====
+====Variables====
 {| class="wikitable"
-! Attribute !! Description
+!Attribute!!Description
 |-
 |GameName
+|The name of the mod. Will appear at the title of the game and at the task bar.
 |}
-==== StartMap ====
+====StartMap====
 {| class="wikitable"
-! Attribute !! Description
+!Attribute!!Description
 |-
 |File
+|The name of the map file + file extension (<code>.hpm</code>).
 |-
 |Folder
+|The name of the map folder.
 |-
 |Pos
+|The [[HPL3/Areas/PlayerStart Area|primary start position]] of the map.
 |}

@@ Line 69: / Line 69: @@
 ===Attributes===
+----
 ==== ConfigFiles ====
 {| class="wikitable"
 |Resources
 |Points to the [[HPL3/Resources Configuration|resources configuration]] file.
@@ Line 102: / Line 104: @@
 ==== Directories ====
 {| class="wikitable"
 |MainSaveFolder
+|
@@ Line 114: / Line 118: @@
 ==== Variables ====
 {| class="wikitable"
 |GameName
+|
@@ Line 120: / Line 126: @@
 ==== StartMap ====
 {| class="wikitable"
 |File
+|

@@ Line 32: / Line 32: @@
 	Materials = "materials.cfg"
 	SoundData = "sounddata.cfg"
 	DefaultBaseLanguage = "base_english.lang"
@@ Line 72: / Line 69: @@
 ===Attributes===
 {| class="wikitable"
+|Resources
+|Points to the [[HPL3/Resources Configuration|resources configuration]] file.
 |-
+|Materials
+|Points to the material configuration file.
 |-
+|SoundData
+|Points to the sound data configuration file.
 |-
+|DefaultBaseLanguage
+|Points to the default base [[HPL3/Language Configuration|language file]].
 |-
+|DefaultGameLanguage
+|Points to the default game [[HPL3/Language Configuration|language file]].
 |-
+|Modules
+|Points to the [[HPL3/Modules Configuration|modules file]].
 |-
+|EntityTypes
+|Points to [[HPL3/Entities/Entity Types|entity types]] configuration file.
 |-
+|Effects
+|Points to the effects configuration file.
 |-
+|PlayerStates
+|
 |-
+|BaseLanguageFolder
+|
 |-
+|
+|
-|-
+|}
-−
+==== StartMap ====
-|-
+{| class="wikitable"
+|File
+|
 |-
+|Folder
+|
 |-
+|Pos
+|
 |}

@@ Line 24: / Line 24: @@
 />
 </syntaxhighlight>
 ===Extended Configuration===

@@ Line 1: / Line 1: @@
 When a mod is launched, some initialization occurs and the game is configured before the mod shows up. This article explains how to configure the startup of a mod.
-== Launch Configuration File ==
+==Launch Configuration File==
 In order to make the mod launch, we need to list some configurations and settings that affect the initialization of the mod. All of the configurations are listed inside a single XML file, called <code>main_init.cfg</code>. The file should be located inside the <code>config</code> folder of the mod. When launching a mod, either via debug mode or via the game, the mod will first read the data from this file.
-=== Minimal Configuration ===
+===Minimal Configuration===
 These are the minimal settings that should be inside a <code>main_init.cfg</code> file:
@@ Line 24: / Line 24: @@
 </syntaxhighlight>
-=== Extended Configuration ===
+===Extended Configuration===
 These are the full settings that can be inside a <code>main_init.cfg</code> file in order to apply further customization:
@@ Line 32: / Line 32: @@
 	Materials = "materials.cfg"
 	SoundData = "sounddata.cfg"
 	DefaultUserSettings = "config/default_user_settings.cfg"
@@ Line 55: / Line 53: @@
 <Variables
-	GameName = "SOMA"
+	GameName = "Mod Name"
 />
@@ Line 65: / Line 63: @@
 <StartMap
-	File = "00_00_intro.hpm"
+	File = "map_name.hpm"
 	Folder = "maps/"
 	Pos = "PlayerStartArea_1"
@@ Line 73: / Line 71: @@
 {{Note|it is recommended to not change most of the settings, and only edit things that should really be customized for your mod, such as mod name, save folder name, etc.}}
-=== Attributes ===
+===Attributes===

@@ Line 7: / Line 7: @@
 These are the minimal settings that should be inside a <code>main_init.cfg</code> file:
 <syntaxhighlight lang="xml">
 <Directories
@@ Line 23: / Line 22: @@
 	Pos = "PlayerStartArea_1"
 />
-</syntaxhighlight>}} {{clr}}
+</syntaxhighlight>
 === Extended Configuration ===