HPL3/Amnesia: Rebirth/Developer Commands - Revision history

Mudbill: Made platform agnostic and some clearer formatting.

2020-11-10T03:24:01Z

Made platform agnostic and some clearer formatting.

Mudbill at 03:16, 10 November 2020

2020-11-10T03:16:13Z

Mudbill: Updated description for -mod argument and added Steam Workshop example.

2020-11-10T03:15:20Z

Updated description for -mod argument and added Steam Workshop example.

TiMan at 14:57, 6 November 2020

2020-11-06T14:57:25Z

TiMan: Created page with "{{ShortPageTitle}} When launching a game or a mod via a Command Prompt (CMD .bat file), you can pass optional arguments which will affect the way the mod is loaded by the game..."

2020-11-06T14:53:24Z

Created page with "{{ShortPageTitle}} When launching a game or a mod via a Command Prompt (CMD .bat file), you can pass optional arguments which will affect the way the mod is loaded by the game..."

New page

{{ShortPageTitle}}
When launching a game or a mod via a Command Prompt (CMD .bat file), you can pass optional arguments which will affect the way the mod is loaded by the game. It can be useful for mods which require custom assets and scripts, or if you want to customize it further than that.

==Command Line Arguments==
{{Note|You can add multiple arguments and combine them when launching the game. It doesn't have to be only one argument.}}
{| class="wikitable"
|+
!Argument
!Description
!Default Value
!Example
|-
|user
|Starts the game with a different user name.

This is useful for starting a game / mod with a different set of save files, as they are saved per-user.
|<code>Default</code>
|<code>AmnesiaRebirth.exe -user Default_dev</code>
|-
|cfg
|Changes the main config file that is used when starting the mod.

This is useful if the relative path of the config file inside your mod folder is different and you want to point to your file.
|<code>config/main_init.cfg</code>
|<code>AmnesiaRebirth.exe -cfg config/main_init_dev.cfg</code>
|-
|mod
|Points to a mod entry file and launches the mod instead of the main game. Use this if you want to run your mod in dev mode.
This argument requires a full path of the game / mod directory.
|''No default value.''
|<code>AmnesiaRebirth.exe -mod "C:\AmnesiaRebirth\mods\myMod\entry.hpc"</code>
|-
|map
|The game loads a specific map after startup.

This is useful if you want to load a specific map quickly or if you want to skip the "load map" option in the debug menu.
|Stated at <code>StartMap->File</code> in <code>main_init.cfg</code>.
|<code>AmnesiaRebirth.exe -map "mods/myMod/maps/myMap.hpm"</code>
|-
|mapfolder
|Starts the game with a specific map folder.
|Stated at StartMap->Folder in <code>main_init.cfg</code>.
|<code>AmnesiaRebirth.exe -mapfolder "mods/myMod/maps"</code>
|-
|mappos
|Sets a specific start position to be used in a map.

This is useful if you want to test your map from a specific position or if you want to skip the "jump to start pos" option in the debug menu.
|Stated at <code>StartMap->Pos</code> in <code>main_init.cfg.</code>
|<code>AmnesiaRebirth.exe -map "PathToMap/myMap.hpm" -mappos "MyPos"</code>
|-
|workdir
|Which directory the game exe is located. Can be used to change between engine and main redist.
'''This command line argument is useful for the engine developers only!'''
|''No default value.''
|''No default value.''
|}

@@ Line 29: / Line 29: @@
 This argument begins with either <code>local:</code> or <code>steamworkshop:</code> depending on where the mod is sourced from. In most cases you want to use <code>local:</code>, since this is mostly for mod developers. After this first keyword immediately follows the name of the mod folder or the Steam Workshop ID of the mod.
 |''No default value.''
-|<code>AmnesiaRebirth.exe -mod local:myMod</code><code>AmnesiaRebirth.exe -mod steamworkshop:42069</code>
+|<code>AmnesiaRebirth.exe -mod local:myMod</code><br><code>AmnesiaRebirth.exe -mod steamworkshop:42069</code>
 |-
 |map

@@ Line 26: / Line 26: @@
 |-
 |mod
-|Points to a mod entry file and launches the mod instead of the main game. Use this if you want to run your mod in dev mode.
+|Launches a mod instead of the main game. Use this if you want to run your mod in dev mode.
-This argument requires a full path of the game / mod directory.
+This argument begins with either <code>local:</code> or <code>steamworkshop:</code> depending on where the mod is sourced from. In most cases you want to use <code>local:</code>, since this is mostly for mod developers. After this first keyword immediately follows the name of the mod folder or the Steam Workshop ID of the mod.
 |''No default value.''
-|<code>AmnesiaRebirth.exe -mod local:myMod</code>
+|<code>AmnesiaRebirth.exe -mod local:myMod</code><code>AmnesiaRebirth.exe -mod steamworkshop:42069</code>
 |-
 |map

@@ Line 1: / Line 1: @@
 {{ShortPageTitle}}
-When launching a game or a mod via a Command Prompt (CMD .bat file), you can pass optional arguments which will affect the way the mod is loaded by the game. It can be useful for mods which require custom assets and scripts, or if you want to customize it further than that.
+When launching a game or a mod via the command line, you can pass optional arguments which will affect the way the game is loaded. It can be useful for mods which require custom assets and scripts, or if you want to customize it further than that.
 ==Command Line Arguments==
-{{Note|You can add multiple arguments and combine them when launching the game. It doesn't have to be only one argument.}}
+{{Note|You can add multiple arguments and combine them when launching the game.}}
 {| class="wikitable"
 !Argument
 !Description
 !Example
 |-
-|user
+|<code>-user</code>
 |Starts the game with a different user name.
 This is useful for starting a game / mod with a different set of save files, as they are saved per-user.
-|<code>Default</code>
+|<code>-user Default_dev</code>
 |-
-|cfg
+|<code>-cfg</code>
 |Changes the main config file that is used when starting the mod.
 This is useful if the relative path of the config file inside your mod folder is different and you want to point to your file.
-|<code>config/main_init.cfg</code>
+|<code>-cfg config/main_init_dev.cfg</code>
 |-
-|mod
+|<code>-mod</code>
 |Launches a mod instead of the main game. Use this if you want to run your mod in dev mode.
 This argument begins with either <code>local:</code> or <code>steamworkshop:</code> depending on where the mod is sourced from. In most cases you want to use <code>local:</code>, since this is mostly for mod developers. After this first keyword immediately follows the name of the mod folder or the Steam Workshop ID of the mod.
-|''No default value.''
+|<code>-mod local:MyMod</code><br><code>-mod steamworkshop:42069</code>
 |-
-|map
+|<code>-map</code>
 |The game loads a specific map after startup.
 This is useful if you want to load a specific map quickly or if you want to skip the "load map" option in the debug menu.
-|Stated at <code>StartMap->File</code> in <code>main_init.cfg</code>.
+|<code>-map "mods/myMod/maps/myMap.hpm"</code>
 |-
-|mapfolder
+|<code>-mapfolder</code>
 |Starts the game with a specific map folder.
-|Stated at StartMap->Folder in <code>main_init.cfg</code>.
+|<code>-mapfolder "mods/myMod/maps"</code>
 |-
-|mappos
+|<code>-mappos</code>
 |Sets a specific start position to be used in a map.
 This is useful if you want to test your map from a specific position or if you want to skip the "jump to start pos" option in the debug menu.
-|Stated at <code>StartMap->Pos</code> in <code>main_init.cfg.</code>
+|<code>-map "PathToMap/myMap.hpm" -mappos "MyPos"</code>
 |-
-|workdir
+|<code>-workdir</code>
 |Which directory the game exe is located. Can be used to change between engine and main redist.
 '''This command line argument is useful for the engine developers only!'''
 |''No default value.''
 |}