Frictional Game Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

<h1>Setting up a Mod Entry</h1> <div class="level1"> <p> When creating a mod, be it a simple add-on or a fully fledged total conversion, an entry file is needed so that the mod can be listed by the ModLauncher app or simply be started by the game. </p> <p> This means that you need to create an XML file with name entry.hpc in the root directory for your mod, and its contents will depend on what kind of mod you are creating. </p> </div> <h2>Common Attributes</h2> <div class="level2"> <p> Any valid entry.hpc file will have at least the following attributes: </p> <ul> <li class="level1"> 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)</li> <li class="level2"> Type: (String) The type for the content the mod is offering. Possible values as of version 1.0 are "AddOn" or "StandAlone".</li> <li class="level2"> 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.</li> <li class="level2"> Author: (String) This will be shown below the title on the info column in the ModLauncher app.</li> <li class="level2"> Description: (String) A brief description of what the mod is about. Should not exceed 8000 characters for the same reason as title.</li> <li class="level2"> UID: (String) A string in the form 'provider_name.mod_name'. This is used so other mods can reference this one as dependency.</li> <li class="level2"> 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.</li> </ul> <p> Keep on reading for specifics on each Mod type. </p> </div> <h2>Setting up an Add-on entry</h2> <div class="level2"> <p> This section explains the specifics for setting up entry.hpc files for add-on mod type. </p> <ul> <li class="level1"> ResourcesCfg: (String) This tells the game where to look for the additional resources configuration file. If not set, the default 'resources.cfg' file located in the mod root directory will be used. Note that this file must exist for the mod to work.</li> <li class="level1"> LanguageFolder: (String) This tells the game where to look for additional language files when the add-on is launched. Should be a path relative to the mod root directory. This value is optional: if your add-on does not add any language entries, then there's no need to have it.</li> </ul> <p> Here's a sample sample entry.hpc file for a minimal add-on entry (download mod <a href="/lib/exe/fetch.php?media=hpl3:tutorials:mod-creation:minimaladdonmod.zip" class="media mediafile mf_zip" title="hpl3:tutorials:mod-creation:minimaladdonmod.zip (22.1 KB)">here</a>) </p> <pre class="code xml">< ?xml version="1.0" encoding="UTF-8"?> < Content Version="1.0" Type="AddOn" Title="[SAMPLE] Minimal Add-on Mod" Author="Your name here" Description="This is a minimal setup for creating add-on mods."   LanguageFolder="config/lang" /> </pre><p> </p> </div> <h2>Setting up a StandAlone entry</h2> <div class="level2"> <p> This section explains the specifics for setting up entry.hpc files for Stand-alone mod type. </p> <ul> <li class="level1"> LauncherPic: (String) Points to an image file that will be displayed on the details column in the ModLauncher app. Should be a path relative to the mod root directory.</li> <li class="level1"> InitCfg: (String) Points to a configuration XML file that will set a list of initialization values including save directory, script modules config, and so on. Should be a path relative to the mod root directory. </li> </ul> <p> Here's a sample sample entry.hpc file for a minimal custom map entry (download mod <a href="/lib/exe/fetch.php?media=hpl3:tutorials:mod-creation:minimalcustommapmod.zip" class="media mediafile mf_zip" title="hpl3:tutorials:mod-creation:minimalcustommapmod.zip (18.2 KB)">here</a>) </p> <pre class="code xml">< ?xml version="1.0" encoding="UTF-8"?> < Content Version="1.0" Type="StandAlone" Title="[SAMPLE] Minimal custom map mod" Author="Your name here" Description="This is a minimal setup for creating custom maps"   LauncherPic="LauncherPic.png" InitCfg="config/main_init.cfg" /> </pre><p> </p> </div> <h2>Running a Mod</h2> <div class="level2"> <p> There are two different ways to run a mod: </p> <ul> <li class="level1"> 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"</li> </ul> <p> <img src="/lib/exe/fetch.php?w=400&tok=38bc9c&media=hpl3:tutorials:mod-creation:modlauncher.png" class="media" alt="" width="400" /> </p> <ul> <li class="level1"> 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:</li> </ul> <pre class="code">soma.exe -mod C:\my_mod\entry.hpc </pre><p> </p> </div>