Difference between revisions of "HPL3/SOMA/Developer Commands"
Line 4: | Line 4: | ||
==Command Line Arguments== | ==Command Line Arguments== | ||
− | {{Note|You can add multiple arguments and combine them when launching the mod. It doesn't have to be only one argument.}} | + | {{Note|You can add multiple arguments and combine them when launching the mod. It doesn't have to be only one argument.}} |
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
Line 17: | Line 17: | ||
This is useful for starting a mod with a different set of save files, as they are saved per-user. | This is useful for starting a mod with a different set of save files, as they are saved per-user. | ||
|<code>Default</code> | |<code>Default</code> | ||
− | |Soma.exe -user "Default_dev" | + | |<code>Soma.exe -user "Default_dev"</code> |
|- | |- | ||
| -cfg | | -cfg | ||
Line 24: | Line 24: | ||
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. | 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>config/main_init.cfg</code> | ||
− | |Soma.exe -cfg "config/main_init_dev.cfg" | + | |<code>Soma.exe -cfg "config/main_init_dev.cfg"</code> |
|- | |- | ||
| -map | | -map | ||
Line 31: | Line 31: | ||
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. | 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>. | |Stated at <code>StartMap->File</code> in <code>main_init.cfg</code>. | ||
− | |Soma.exe -map "mods/myMod/maps/myMap.hpm" | + | |<code>Soma.exe -map "mods/myMod/maps/myMap.hpm"</code> |
|- | |- | ||
| -mapfolder | | -mapfolder | ||
|Starts the game with a specific map folder. | |Starts the game with a specific map folder. | ||
|Stated at StartMap->Folder in <code>main_init.cfg</code>. | |Stated at StartMap->Folder in <code>main_init.cfg</code>. | ||
− | |Soma.exe -mapfolder "mods/myMod/maps" | + | |<code>Soma.exe -mapfolder "mods/myMod/maps"</code> |
|- | |- | ||
| -mappos | | -mappos | ||
Line 43: | Line 43: | ||
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. | 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> | |Stated at <code>StartMap->Pos</code> in <code>main_init.cfg.</code> | ||
− | |Soma.exe -map "PathToMap/myMap.hpm" -mappos "MyPos" | + | |<code>Soma.exe -map "PathToMap/myMap.hpm" -mappos "MyPos"</code> |
|- | |- | ||
| -workdir | | -workdir |
Revision as of 20:38, 31 July 2020
When launching your 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
Argument | Description | Default Value | Example |
---|---|---|---|
-user | Starts the mod with a different user name.
This is useful for starting a mod with a different set of save files, as they are saved per-user. |
Default
|
Soma.exe -user "Default_dev"
|
-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. |
config/main_init.cfg
|
Soma.exe -cfg "config/main_init_dev.cfg"
|
-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 StartMap->File in main_init.cfg .
|
Soma.exe -map "mods/myMod/maps/myMap.hpm"
|
-mapfolder | Starts the game with a specific map folder. | Stated at StartMap->Folder in main_init.cfg .
|
Soma.exe -mapfolder "mods/myMod/maps"
|
-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 StartMap->Pos in main_init.cfg.
|
Soma.exe -map "PathToMap/myMap.hpm" -mappos "MyPos"
|
-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. |