HPL3/SOMA/Modding/Setup Modding Environment - Revision history

Crater: Removed the asset/ prefix in the example lookupdirs.cfg file as its STUPID. also added missing DetailMeshes asset category

2024-05-08T16:54:34Z

Removed the asset/ prefix in the example lookupdirs.cfg file as its STUPID. also added missing DetailMeshes asset category

TiMan: /* Final Step */

2023-06-08T13:23:05Z

Final Step

TiMan: /* WIP Mod - Automatic Configuration */

2023-06-08T13:22:58Z

WIP Mod - Automatic Configuration

TiMan: /* WIP Mod - Automatic Configuration */

2020-10-07T14:13:16Z

WIP Mod - Automatic Configuration

TiMan: /* Final Step */

2020-08-17T14:13:11Z

Final Step

TiMan at 21:40, 16 August 2020

2020-08-16T21:40:30Z

TiMan at 21:40, 16 August 2020

2020-08-16T21:40:22Z

TiMan: Created page with "{{shortPageTitle}} In order to have a smooth modding development experience, SOMA is needed to be configured into proper development environment. {{note|Each section describ..."

2020-08-16T21:40:10Z

Created page with "{{shortPageTitle}} In order to have a smooth modding development experience, SOMA is needed to be configured into proper development environment. {{note|Each section describ..."

New page

{{shortPageTitle}}

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

{{note|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".
{{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 ===
#Navigate to <code>My Documents/HPL3</code>. You need to open one of the editors at least once in order to see the HPL3 folder inside your document folder.
#Inside that folder, create a file called <code>WIPMod.cfg</code>.
#Paste the following into the file, and save:
<syntaxhighlight lang="xml">
<WIPmod Path="Full_Path_To_Mod/entry.hpc" />
</syntaxhighlight>
(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 [[HPL3/SOMA/Modding/SOMA Mod Manager#Editor Sync|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 ===

{{warning|Currently, this step has to be done 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. You need to add a folder named <code>editor</code> in your mod directory, and a <code>lookupdirs.cfg</code> file inside. The content of the file should point out the relative paths to the directories which contain custom assets. For example:
<syntaxhighlight lang="xml">
<Directories>
<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" />
</Directories>
</syntaxhighlight>

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

[[Category:Modding]]
[[Category:English]]

← Older revision		Revision as of 13:23, 8 June 2023
Line 22:		Line 22:

	===Final Step===		===Final Step===
−
−	~~{{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.		If your mod indeed has custom assets, you need to make sure the editors can add them to their look up list.

@@ Line 4: / Line 4: @@
-== Setting up the Editors ==
+==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".
 {{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 ===
+===WIP Mod - Manual Configuration===
 #Navigate to <code>My Documents/HPL3</code>. You need to open one of the editors at least once in order to see the HPL3 folder inside your document folder.
 #Inside that folder, create a file called <code>WIPMod.cfg</code>.
@@ Line 17: / Line 18: @@
 (Of course, you will have to change the path in order to suit your own location of the mod).
-=== WIP Mod - Automatic Configuration ===
+===WIP Mod - Automatic Configuration===
-You can use the [[HPL3/SOMA/Third_Party_Tools/SOMA_Mod_Manager|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.
+You can use the [[HPL3/Third Party Tools/HPL3 Mod Manager|HPL3 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 ===
+===Final Step===
 {{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.
 #In your mod's folder, create a new folder and name it <code>editor</code>.
 #Inside that folder, create a file called <code>lookupdirs.cfg</code>.

@@ Line 34: / Line 34: @@
 #*<code>Particles</code>
 #*<code>Sounds</code>
 Example file:
 <syntaxhighlight lang="xml">
 <Directories>
-	<Dir Category="StaticObjects" Path="assets/static_objects" />
+	<Dir Category="StaticObjects" Path="static_objects/" />
-	<Dir Category="Entities" Path="assets/entities" />
+	<Dir Category="Entities" Path="entities/" />
-	<Dir Category="Billboards" Path="assets/billboards" />
+	<Dir Category="Billboards" Path="billboards/" />
-	<Dir Category="Particles" Path="assets/particles" />
+	<Dir Category="Particles" Path="particles/" />
-	<Dir Category="Sounds" Path="assets/sounds" />
+	<Dir Category="Sounds" Path="sounds/" />
 </Directories>
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
 {{shortPageTitle}}
 In order to have a smooth modding development experience, SOMA is needed to be configured into proper development environment.
 == Setting up the Editors ==

← Older revision		Revision as of 21:40, 16 August 2020
Line 2:		Line 2:

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

	{{note\|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.}}		{{note\|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.}}