HPL3/Amnesia: Rebirth/Modding/Setup Modding Environment - Revision history

Crater: add DetailMeshes lookupdir category - leveleditor.log lists this as a valid category but this needs to be verified

2024-05-08T15:21:32Z

add DetailMeshes lookupdir category - leveleditor.log lists this as a valid category but this needs to be verified

Crater: removed asset prefix from example lookupdirs.cfg as the Bunker editors don't seem to correctly find the directories.

2024-05-08T15:19:51Z

removed asset prefix from example lookupdirs.cfg as the Bunker editors don't seem to correctly find the directories.

TiMan at 13:29, 8 June 2023

2023-06-08T13:29:27Z

TiMan at 13:29, 8 June 2023

2023-06-08T13:29:20Z

Mudbill: Rewrote some bits to be multi-platform rather than Windows focused.

2020-11-10T02:58:09Z

Rewrote some bits to be multi-platform rather than Windows focused.

TiMan: /* Setting up Custom Story Dev Mode */

2020-11-07T12:25:33Z

Setting up Custom Story Dev Mode

TiMan at 15:07, 6 November 2020

2020-11-06T15:07:16Z

TiMan at 14:57, 6 November 2020

2020-11-06T14:57:57Z

FG luis: Created page with "{{shortPageTitle}} In order to have a smooth modding development experience, Amnesia: Rebirth is needed to be configured into proper development environment. {{note|Each secti..."

2020-11-04T15:26:17Z

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

New page

{{shortPageTitle}}
In order to have a smooth modding development experience, Amnesia: Rebirth 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).

=== Final Step ===

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>.
#Create a new <code><Directories></code> xml tag inside the file.
#Add a list of directories which include your custom assets. The directory has to be associated with a category. The allowed categories are:
#*<code>StaticObjects</code>
#*<code>Entities</code>
#*<code>Billboards</code>
#*<code>Particles</code>
#*<code>Sounds</code>

Example file:
<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]]

@@ Line 1: / Line 1: @@
 {{shortPageTitle}}
-In order to have a smooth modding development experience, Amnesia: Rebirth should be configured to run in a proper development environment.
+In order to have a smooth modding development experience, Amnesia: Rebirth should be configured to run in a proper development environment.<br />{{Tip|It is recommended to use the [https://wiki.frictionalgames.com/page/HPL3/Third_Party_Tools/HPL3_Mod_Manager HPL3 Mod Manager] to configure everything that is listed on this page.}}<br />
 ==Setting up Custom Story Dev Mode==
 During development, it is extremely helpful to have access to the development options and [[HPL3/Amnesia:_Rebirth/Modding/Developer_Debug_Menu|debug mode]] of the game. To achieve that, you need to start the game with a few extra arguments. It is suggested that you set up a script file for your mod so you can more quickly launch it in development mode.

@@ Line 1: / Line 1: @@
 {{shortPageTitle}}
 In order to have a smooth modding development experience, Amnesia: Rebirth should be configured to run in a proper development environment.
 ==Setting up Custom Story Dev Mode==

@@ Line 1: / Line 1: @@
 {{shortPageTitle}}
-In order to have a smooth modding development experience, Amnesia: Rebirth is needed to be configured into proper development environment.
+In order to have a smooth modding development experience, Amnesia: Rebirth should be configured to run in a proper development environment.
-== Setting up Custom Story Dev Mode ==
+==Setting up Custom Story Dev Mode==
-During development, it is necessary to have access to the development options and [[HPL3/Amnesia:_Rebirth/Modding/Developer_Debug_Menu|debug mode]] of the game. To achieve that, you need to set up a development mode file for the mod.
+During development, it is extremely helpful to have access to the development options and [[HPL3/Amnesia:_Rebirth/Modding/Developer_Debug_Menu|debug mode]] of the game. To achieve that, you need to start the game with a few extra arguments. It is suggested that you set up a script file for your mod so you can more quickly launch it in development mode.
-#In the main folder of the game, create a <code>.bat</code> file with a recognizable name for your mod development. For example: <code>myMod_dev.bat</code>.
-#Paste the following text into the file and save, change <code>MyModName</code> so it fits your mod folder name.
+#In the main folder of the game, create a script file with a recognizable name for your mod development. For example: <code>myMod_dev.bat</code> (.sh for Mac/Linux)
 <pre>AmnesiaRebirth.exe -user Dev -cfg config/main_init_dev.cfg -mod local:MyModName</pre>
-You can now launch the dev .bat file throughout the development of your mod.
+'''Non-Windows users''': Substitute <code>AmnesiaRebirth.exe</code> with your platform's executable, for example: <code>./Amnesia2.bin.x86_64</code>
-== 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 22: / Line 26: @@
 (Of course, you will have to change the path in order to suit your own location of the mod).
-=== Final Step ===
+===Final Step===
 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 7: / Line 7: @@
 #Paste the following text into the file and save, change <code>MyModName</code> so it fits your mod folder name.
 <pre>AmnesiaRebirth.exe -user Dev -cfg config/main_init_dev.cfg -mod local:MyModName</pre>
-#You can now launch the dev .bat file throughout the development of your mod.
+You can now launch the dev .bat file throughout the development of your mod.
 == Setting up the Editors ==

@@ Line 38: / Line 38: @@
 #*<code>Particles</code>
 #*<code>Sounds</code>
 Example file:

@@ Line 42: / Line 42: @@
 <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>