Setup Modding Environment

From Frictional Wiki
< HPL3‎ | SOMA‎ | Modding
Jump to navigation Jump to search

In order to have a smooth modding development experience, SOMA is needed to be configured into proper development environment.

Note icon.png Each section described in this article can either be configured manually (creating or editing the files yourself) or to be configured automatically, using the SOMA Mod Manager application.

Setting up the Editors

Your mod might have custom assets. In order to make the editors (Level Editor, Model Editor, etc) to load your mod's assets, it needs to be configured into a special mode called "WIP Mod".

Icon tip.png Tip: Even if your mod doesn't have any custom assets, it's a good practice to configure the Level Editor anyway, just so you won't have to deal with it in the future should you decide to add custom assets.

WIP Mod - Manual Configuration

  1. Navigate to My Documents/HPL3. You need to open one of the editors at least once in order to see the HPL3 folder inside your document folder.
  2. Inside that folder, create a file called WIPMod.cfg.
  3. Paste the following into the file, and save:
<WIPmod Path="Full_Path_To_Mod/entry.hpc" />

(Of course, you will have to change the path in order to suit your own location of the mod).

WIP Mod - Automatic Configuration

You can use the SOMA Mod Manager in order to perform an automatic sync of the editors to your mod, which pretty much does the manual step for you.

Final Step

Alert icon.png Warning: Currently, this step can to be done only manually. Do not skip it.

If your mod indeed has custom assets, you need to make sure the editors can add them to their look up list.

  1. In your mod's folder, create a new folder and name it editor.
  2. Inside that folder, create a file called lookupdirs.cfg.
  3. Create a new <Directories> xml tag inside the file.
  4. Add a list of directories which include your custom assets. The directory has to be associated with a category. The allowed categories are:
    • StaticObjects
    • Entities
    • Billboards
    • Particles
    • Sounds

Example file:

	<Dir Category="StaticObjects" Path="assets/static_objects" />
	<Dir Category="Entities" Path="assets/entities" />
	<Dir Category="Billboards" Path="assets/billboards" />
	<Dir Category="Particles" Path="assets/particles" />
	<Dir Category="Sounds" Path="assets/sounds" />

If all the above is done correctly, a (Working on mod) text should appear on the title bar of HPL3 editors when run.