Difference between revisions of "HPL3/SOMA/Developer Commands"
Line 1: | Line 1: | ||
− | |||
− | |||
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. | 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== | ==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.}} | ||
− | + | ==='''-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>. | ||
− | + | Example:<pre> | |
− | + | Soma.exe -user "Default_dev" | |
− | + | </pre> | |
− | |||
==='''-cfg'''=== | ==='''-cfg'''=== | ||
− | 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. | + | 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>. |
− | <br> | + | |
− | Default value: <code>config/main_init.cfg</code>. | + | Example:<pre> |
+ | Soma.exe -cfg "config/main_init_dev.cfg" | ||
+ | </pre> | ||
==='''-map'''=== | ==='''-map'''=== | ||
− | This | + | 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>. |
− | <br> | ||
− | Default value: Stated at <code> | ||
+ | Example:<pre> | ||
+ | Soma.exe -map "mods/myMod/maps/myMap.hpm" | ||
+ | </pre> | ||
==='''-mapfolder'''=== | ==='''-mapfolder'''=== | ||
− | This | + | This starts the game with a specific map folder.<br>Default value: Stated at <code>MapFolder</code> in <code>main_init.cfg</code>. |
− | <br> | ||
− | Default value: <code> | ||
+ | Example:<pre> | ||
+ | Soma.exe -mapfolder "mods/myMod/maps" | ||
+ | </pre> | ||
==='''-mappos'''=== | ==='''-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>. | |
− | <br> | + | |
− | Default value: <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'''=== | ==='''-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 14:15, 28 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.
Contents
Command Line Arguments
-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.
Default value: Default
.
Example:
Soma.exe -user "Default_dev"
-cfg
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.
Default value: config/main_init.cfg
.
Example:
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.
Default value: Stated at MapFile
in main_init.cfg
.
Example:
Soma.exe -map "mods/myMod/maps/myMap.hpm"
-mapfolder
This starts the game with a specific map folder.
Default value: Stated at MapFolder
in main_init.cfg
.
Example:
Soma.exe -mapfolder "mods/myMod/maps"
-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.
Default value: Stated at StartPos
in main_init.cfg
.
Example:
Soma.exe -map "mods/myMod/maps/myMap.hpm" -mappos "PlayerStartArea_3"
-workdir
Which directory the game exe is located. Can be used to change between engine and main redist.