hpl3:tutorials:mod-creation:setting_up_a_mod_entry
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
hpl3:tutorials:mod-creation:setting_up_a_mod_entry [2015/10/14 06:47] luis [Setting up an Add-on entry] |
hpl3:tutorials:mod-creation:setting_up_a_mod_entry [2016/07/06 11:41] (current) thomas [Running a Mod] |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| Any valid entry.hpc file will have at least the following attributes: | Any valid entry.hpc file will have at least the following attributes: | ||
| - | * Version: The version for the entry file. Since new features might be added in the future, this attribute must be set according to the rest of attributes (so that for instance it is not 0.1 when there are attributes that are available in version 1.0) | + | * Version: The version for the entry file. Since new features might be added in the future, this attribute must be set according to the rest of attributes (so that for instance it is not 0.1 when there are attributes that are available in version 1.0) |
| - | * Type: (String) The type for the content the mod is offering. Possible values as of version 1.0 are "AddOn" or "StandAlone". | + | * Type: (String) The type for the content the mod is offering. Possible values as of version 1.0 are "AddOn" or "StandAlone". |
| - | * Title: (String) This sets the title for the mod. Should not be longer than 128 characters, especially if the mod is to be uploaded to Steam Workshop. | + | * Title: (String) This sets the title for the mod. Should not be longer than 128 characters, especially if the mod is to be uploaded to Steam Workshop. |
| - | * Author: (String) This will be shown below the title on the info column in the ModLauncher app. | + | * Author: (String) This will be shown below the title on the info column in the ModLauncher app. |
| - | * Description: (String) A brief description of what the mod is about. Should not exceed 8000 characters for the same reason as title. | + | * Description: (String) A brief description of what the mod is about. Should not exceed 8000 characters for the same reason as title. |
| + | * UID: (String) A string in the form 'provider_name.mod_name'. This is used so other mods can reference this one as dependency. | ||
| + | * Dependencies: (String) A list of UID's separated by commas. The resources in these mods will be available to the game when the current mod is run. | ||
| Keep on reading for specifics on each Mod type. | Keep on reading for specifics on each Mod type. | ||
| Line 56: | Line 58: | ||
| /> | /> | ||
| </code> | </code> | ||
| + | |||
| + | ===== Running a Mod ===== | ||
| + | |||
| + | There are two different ways to run a mod: | ||
| + | |||
| + | * Using the Mod Launcher app: there's a special Mod Launcher program that will scan subscribed content in SteamWorkshop (where applies) and the local "redist\mods" directory. To make your mod entry appear in the launcher's list, it must be located in its own directory under the "\mods" directory. For example, a mod for SOMA in a directory called "my_mod" would need to have the path "C:\Program Files (x86)\Steam\steamapps\common\SOMA\mods\my_mod" | ||
| + | |||
| + | {{:hpl3:tutorials:mod-creation:modlauncher.png?nolink&400}} | ||
| + | |||
| + | * Using the command line: to run a mod directly, you only need to run the game executable passing the "-mod" option followed by the full path to the mod's "entry.hpc" file as arguments. Using this method, the mod can be placed anywhere as long as the path to the "entry.hpc" file passed is correct. For the previous example, given the full path for the mod "my_mod" is "C:\my_mod\", the command line for running it should read like this: | ||
| + | |||
| + | <code> | ||
| + | soma.exe -mod C:\my_mod\entry.hpc | ||
| + | </code> | ||
| + | |||
hpl3/tutorials/mod-creation/setting_up_a_mod_entry.1444805248.txt.gz · Last modified: 2015/10/14 06:47 by luis
