Difference between revisions of "HPL3/Launch Configuration"
< HPL3
Jump to navigation
Jump to search
| 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. | 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. | 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: | These are the minimal settings that should be inside a <code>main_init.cfg</code> file: | ||
| Line 24: | Line 24: | ||
</syntaxhighlight> | </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: | 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" | Materials = "materials.cfg" | ||
SoundData = "sounddata.cfg" | SoundData = "sounddata.cfg" | ||
| − | |||
| − | |||
DefaultUserSettings = "config/default_user_settings.cfg" | DefaultUserSettings = "config/default_user_settings.cfg" | ||
| Line 55: | Line 53: | ||
<Variables | <Variables | ||
| − | GameName = " | + | GameName = "Mod Name" |
/> | /> | ||
| Line 65: | Line 63: | ||
<StartMap | <StartMap | ||
| − | File = " | + | File = "map_name.hpm" |
Folder = "maps/" | Folder = "maps/" | ||
Pos = "PlayerStartArea_1" | 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.}} | {{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=== |
| + | {| class="wikitable" | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |} | ||
Revision as of 14:41, 25 August 2020
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.
Contents
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 main_init.cfg. The file should be located inside the config 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 main_init.cfg file:
<Directories
MainSaveFolder = "Save Folder Name"
GameLanguageFolder = "config/lang/"
/>
<Variables
GameName = "Mod Name"
/>
<StartMap
File = "map_name.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
Extended Configuration
These are the full settings that can be inside a main_init.cfg file in order to apply further customization:
<ConfigFiles
Resources = "resources.cfg"
Materials = "materials.cfg"
SoundData = "sounddata.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 = "Mod Name"
/>
<MainMenu
File="main_menu.hpm"
Folder="maps/"
Pos=""
/>
<StartMap
File = "map_name.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
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.