Difference between revisions of "HPL3/SOMA/Developer Commands"

From Frictional Wiki
< HPL3‎ | SOMA
Jump to navigation Jump to search
m (Short title)
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.}}<br />
 +
{| class="wikitable"
 +
|+
 +
!Argument
 +
!Description
 +
!Default Value
 +
!Example
 +
|-
 +
| -user
 +
|Starts the mod with a different user name.
  
==='''-user'''===
+
This is useful for starting a mod with a different set of save files, as they are saved per-user.
This 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.<br>Default value: <code>Default</code>.
+
|<code>Default</code>
 +
|Soma.exe -user "Default_dev"
 +
|-
 +
| -cfg
 +
|Changes the main config file that is used when starting the mod.
  
Example:<pre>
+
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.
Soma.exe -user "Default_dev"
+
|<code>config/main_init.cfg</code>
</pre>
+
|Soma.exe -cfg "config/main_init_dev.cfg"
 +
|-
 +
| -map
 +
|The game loads a specific map after startup.
  
==='''-cfg'''===
+
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 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.<br>Default value: <code>config/main_init.cfg</code>.
+
|Stated at <code>StartMap->File</code> in <code>main_init.cfg</code>.
 +
|Soma.exe -map "mods/myMod/maps/myMap.hpm"
 +
|-
 +
| -mapfolder
 +
|Starts the game with a specific map folder.
 +
|Stated at StartMap->Folder in <code>main_init.cfg</code>.
 +
|Soma.exe -mapfolder "mods/myMod/maps"
 +
|-
 +
| -mappos
 +
|Sets a specific start position to be used in a map.
  
Example:<pre>
+
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.
Soma.exe -cfg "config/main_init_dev.cfg"
+
|Stated at <code>StartMap->Pos</code> in <code>main_init.cfg.</code>
</pre>
+
|Soma.exe -map "PathToMap/myMap.hpm" -mappos "MyPos"
 
+
|-
==='''-map'''===
+
| -workdir
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.<br>Default value: Stated at <code>MapFile</code> in <code>main_init.cfg</code>.
+
|Which directory the game exe is located. Can be used to change between engine and main redist.{{Warning|This command line argument is useful for the engine developers only!}}
 
+
|''No default value.''
Example:<pre>
+
|''No default value.''
Soma.exe -map "mods/myMod/maps/myMap.hpm"
+
|}
</pre>
 
 
 
==='''-mapfolder'''===
 
This starts the game with a specific map folder.<br>Default value:  Stated at <code>MapFolder</code> in <code>main_init.cfg</code>.
 
 
 
Example:<pre>
 
Soma.exe -mapfolder "mods/myMod/maps"
 
</pre>
 
 
 
==='''-mappos'''===
 
Sets a specific start position to be used in a map. This can be 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.<br>Default value: Stated at <code>StartPos</code> in <code>main_init.cfg</code>.
 
 
 
{{Note|This argument is useful if you run it along with the -map argument.}}
 
 
 
Example:<pre>
 
Soma.exe -map "mods/myMod/maps/myMap.hpm" -mappos "PlayerStartArea_3"
 
</pre>
 
 
 
==='''-workdir'''===
 
Which directory the game exe is located. Can be used to change between engine and main redist.
 
 
 
{{Warning|This command line argument is useful for the engine developers only!}}
 

Revision as of 20:36, 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

Note icon.png You can add multiple arguments and combine them when launching the mod. It doesn't have to be only one argument.


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.
Alert icon.png Warning: This command line argument is useful for the engine developers only!
No default value. No default value.