Developer Commands

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth
Revision as of 04:24, 10 November 2020 by Mudbill (talk | contribs) (Made platform agnostic and some clearer formatting.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.

An example of useful arguments to use in a Windows .bat file, to start a mod in developer mode:

AmnesiaRebirth.exe -user Dev -cfg config/main_init_dev.cfg -mod local:MyMod

Command Line Arguments

Note icon.png You can add multiple arguments and combine them when launching the game.
Argument Default Value Description Example
-user Default 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.

-user Default_dev
-cfg config/main_init.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.

-cfg config/main_init_dev.cfg
-mod No default value. 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 local: or steamworkshop: depending on where the mod is sourced from. In most cases you want to use local:, 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.

-mod local:MyMod
-mod steamworkshop:42069
-map Stated at StartMap->File in main_init.cfg. 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.

-map "mods/myMod/maps/myMap.hpm"
-mapfolder Stated at StartMap->Folder in main_init.cfg. Starts the game with a specific map folder. -mapfolder "mods/myMod/maps"
-mappos Stated at StartMap->Pos in main_init.cfg. 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.

-map "PathToMap/myMap.hpm" -mappos "MyPos"
-workdir No default value. 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.