HPL3/SOMA/Modding/Creating a Mod

From Frictional Wiki
< HPL3‎ | SOMA‎ | Modding
Revision as of 22:50, 28 July 2020 by TiMan (talk | contribs) (Created page with "{{wip}} This article describes how to create and setup a basic SOMA mod. {{tip|The game comes with two built-in example mods: <code>MinimalAddOnMod</code> and <code>MinimalC...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This article describes how to create and setup a basic SOMA 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

Mod Types

SOMA has two mod types: Stand-Alone mod and Add-On. Technically speaking, there isn't a difference between them. However, a mod type will 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: A mod that makes the player run faster.

Mod Entry File - Common Attributes

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 in the root directory of the mod needs to be created, and its contents will depend on what kind of mod you are creating.