Creating a Mod

From Frictional Wiki
< HPL3‎ | SOMA‎ | Modding
Revision as of 15:13, 7 October 2020 by TiMan (talk | contribs) (→‎Special Attributes)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This article describes in detail how to create, setup and structure your mod.

Icon tip.png Tip: The game comes with two built-in example mods: MinimalAddOnMod and MinimalCustomMapMod. You can copy them or use them as reference for creating your own mod.

Icon tip.png Tip: You can to use the SOMA Mod Manager to create and configure your mod. However, it is possible create and add the entry file manually.

Mod Types

SOMA has two mod types: Stand-Alone mod and Add-On. Technically speaking, the only difference between them is that an Add-On can be run along with a Stand-Alone mod. However, a mod type shall be picked according to the nature of the mod you make, for contentions sake.

Stand-Alone Mod

A Stand-Alone mod describes a mod of extensive game modification: Custom assets, Custom scripts and even overrides of existing game scripts. If your mod is going to have any maps in it, it's probably a Stand-Alone mod.

Add-On Mod

A Add-On mod describes a mod with of specific or limited game modification: Minor config, graphical or script changes that tweaks an existing feature of the game. If your mod touches on small feature, it's probably an Add-On mod. For example: An Add-On that adds a Russian translation to the game.

Mod Structure

A typical mod structure (folders and files) may look like this:

├── config/
   ├── lang/
      ├── english.lang
   ├── main_init.cfg
├── maps/
├── entry.hpc
├── resources.cfg

The mod structure may change and have more or less files, depends on your mod type, but it's important to have entry.hpc and resources.cfg for every mod.

Mod Entry File

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 application or simply be started by the game. This means that an XML file with name entry.hpc needs to be created in the root directory of the mod, and its contents will depend on what kind of mod you are creating.

Setting up the Entry File

Icon tip.png Tip: It is recommended to copy one of the sample mods provided with the game and edit the files, instead of doing this manually. This way, you won't miss anything by mistake.

There are two ways to set up the entry file. Either:

  1. Create a file named entry.hpc in your mod's root folder.
  2. Paste the following content into the file and save:
    <?xml version="1.0" encoding="UTF-8"?>
    <Content Version="1.0"
    	Title="Your mod name here"
    	Author="Your name here"
    	Description="Mod description here"

Change Type to AddOn if necessary.

Common Attributes

Any valid entry.hpc file (like the one shown above), will have at least the following attributes:

Version The version for the mod, since the mod might get updated in the future.
Type The type for the content the mod is offering. Possible values are "AddOn" or "StandAlone".
Title This sets the title for the mod. It should not be longer than 128 characters, especially if the mod is to be uploaded to the Steam Workshop.
Author The creator(s) of the mod. This will be shown below the title on the info column in the ModLauncher application.
Description The description of the mod. Should not exceed 8000 characters for the same reason as the title.
LauncherPic The file to be used as a thumbnail picture for the ModLauncher application.
InitCfg The relative path to the file which information when initializing the mod. The default value is "config/main_init.cfg" and usually shouldn't be changed.

Special Attributes

There are special attributes which can be added to a mod entry file in order to enable optional functionalities:

UID A string in the form "provider_name.mod_name". This is used so other mods can reference your mod as a Mod Dependency
Dependencies A list of UIDs separated by commas. The resources in these mods will be available to the game when the current mod is running.

Mod Configuration Files

In addition to the mod entry file, the mod needs to be correctly configured in order to load resources such as maps, script, sounds, sounds, etc (As seen in the Mod Structure diagram).

Read the following articles in order to understand how to set up and configure them:

It is recommended to copy the files from the mods provided with the game and modify them, instead of creating them on your own.

Running the Mod

There are two different ways to run a mod:

ModLauncher Application: The Mod Launcher is an application which can launch SOMA mods, along with addons. Running the mod via the application does not enable any dev features, and therefore should be mostly used only when testing the final version of the mod, before releasing it.

Main article: SOMA Mod Launcher

Command Line: To run a mod directly with dev features enabled, you only need to run the game executable passing the "-mod" argument followed by the full path to the mod's "entry.hpc" file. Using this method, the mod can be placed anywhere as long as the path to the "entry.hpc" file passed is correct. This method should be used throughout the development of your mod.


Soma.exe -mod "C:\my_mod\entry.hpc"

There are more arguments which can be added to the command line. It is recommended to create a .bat file which will launch the mod.

Icon tip.png Tip: The SOMA Mod Manager can generate a mod launch .bat file automatically with the necessary arguments to run your mod properly.

Main article: Developer Commands

What's Next

Now that the mod is set up, you may proceed to set up a Modding Environment for your game, and learn how to use the Developer Debug Menu. it is also recommended to set up an online repository. More articles are available in the main SOMA modding category.

See Also