HPL2/Tools - Revision history

Darkfire: Add introduction section

2024-06-05T19:36:20Z

Add introduction section

Darkfire: Make the git link point to our article on it

2024-06-05T19:22:34Z

Make the git link point to our article on it

Crater at 10:15, 27 June 2022

2022-06-27T10:15:47Z

Crater: /* Installation Instructions */ added note to try another browser if the download keeps failing.

2022-06-27T10:10:32Z

Installation Instructions: added note to try another browser if the download keeps failing.

Darkfire: /* Community tools */ restructured

2021-04-09T13:44:31Z

Community tools: restructured

Mudbill: /* Windows */ Added warning about copying link

2021-01-15T21:19:05Z

Windows: Added warning about copying link

Darkfire: Added community tools section

2020-11-08T23:45:44Z

Added community tools section

Mudbill: Centered table

2020-08-08T20:08:27Z

Centered table

Mudbill: Restructured a bit and fixed up some sentences, added table to the top.

2020-08-08T20:07:32Z

Restructured a bit and fixed up some sentences, added table to the top.

Mudbill at 23:24, 5 August 2020

2020-08-05T23:24:03Z

@@ Line 19: / Line 19: @@
 |'''[[HPL2/Tools/Model Viewer|Model Viewer]]'''||See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets.
 |}
 ==Installation Instructions==
 Make sure to click the download links as copying the link will result in an error. If clicking the link also results in an error, try downloading in another browser.
@@ Line 80: / Line 88: @@
 == Community tools ==
-After the HPL2 games went open-source, the community managed to compile newer editors with a few quality-of-life improvements. They are '''available for Windows and Linux.'''
+HPL2 is now open source and a community edition of the editors is being worked on. They are '''available for Windows and Linux.'''
 ===Features===
 The new features include:
-* A much more comfortable color picker
+* A much more comfortable color picker (compared to the classic editors; this picker is included in 1.5 versions too)
 * Dark theme (installed by default, but the original one can be reinstated)
 * Keyboard shortcuts for common utilities (e.g. grid snapping)
@@ Line 91: / Line 99: @@
 ===Installation===
-#Install the original editors first (not all files and editors are included in the community version).
+# Go to [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page] to download the latest version of the community tools.
-#Go to [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page] to download the latest version of the community tools.
+# Download the archive in the format of your choice (.7z is smaller than .zip but requires [https://www.7-zip.org/ 7zip] or Winrar to open).
-#Download the archive in the format of your choice (.7z is smaller than .zip but requires [https://www.7-zip.org/ 7zip] or Winrar to open).
+# Extract the contents into the main directory of Amnesia.
-#Extract the contents into the main directory of Amnesia.
+# Merge and overwrite all when asked.

@@ Line 19: / Line 19: @@
 |'''[[HPL2/Tools/Model Viewer|Model Viewer]]'''||See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets.
 |}
 ==Installation Instructions==
-Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git]).
+Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, can have bugs.
 Make sure to click the download links as copying the link will result in an error. If clicking the link also results in an error, try downloading in another browser.

@@ Line 22: / Line 22: @@
 Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git]).
-Make sure to click the download links before, as copying the link will result in an error. If clicking the link also results in an error, try downloading in another browser.
+Make sure to click the download links as copying the link will result in an error. If clicking the link also results in an error, try downloading in another browser.
 ===Windows===

@@ Line 21: / Line 21: @@
 ==Installation Instructions==
 Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git]).
 ===Windows===

@@ Line 77: / Line 77: @@
 After the HPL2 games went open-source, the community managed to compile newer editors with a few quality-of-life improvements. They are '''available for Windows and Linux.'''
 The new features include:
 * A much more comfortable color picker
@@ Line 84: / Line 86: @@
 * Other small improvements
-Check [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page to download the latest version]. Not all files and editors are included in this download, so please install the original editors first.
+===Installation===
+#Install the original editors first (not all files and editors are included in the community version).
-'''Installation:'''
+#Go to [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page] to download the latest version of the community tools.
-#Download the archive of your choice.
+#Download the archive in the format of your choice (.7z is smaller than .zip but requires [https://www.7-zip.org/ 7zip] or Winrar to open).
 #Extract the contents into the main directory of Amnesia.
 #Merge and overwrite all when asked.

@@ Line 24: / Line 24: @@
 ===Windows===
-Download the Windows HPL Editor Suite for Amnesia:
+Download the Windows HPL Editor Suite for Amnesia (click the link, it won't work if you copy it into a tab):
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/amnesia_tdd_1.3_editor_suite.zip Version 1.3 and later]

← Older revision		Revision as of 23:45, 8 November 2020
Line 73:		Line 73:

	When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder.		When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder.
		+
		+	== Community tools ==
		+
		+	After the HPL2 games went open-source, the community managed to compile newer editors with a few quality-of-life improvements. They are '''available for Windows and Linux.'''
		+	The new features include:
		+	* A much more comfortable color picker
		+	* Dark theme (installed by default, but the original one can be reinstated)
		+	* Keyboard shortcuts for common utilities (e.g. grid snapping)
		+	* Ability to load MFP maps and assets without errors
		+	* Other small improvements
		+
		+	Check [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page to download the latest version]. Not all files and editors are included in this download, so please install the original editors first.
		+
		+	'''Installation:'''
		+	#Download the archive of your choice.
		+	#Extract the contents into the main directory of Amnesia.
		+	#Merge and overwrite all when asked.
		+	No information will be lost by replacing these files, so no need to create a backup.

@@ Line 1: / Line 1: @@
 [[Category:Entry pages]]
-{| class="wikitable"
+{| class="wikitable" style="margin:auto"
 ! colspan="2" scope="row" |Editors
 |-

@@ Line 1: / Line 1: @@
 [[Category:Entry pages]]
 ==Installation Instructions==
-Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git] - there are visual add-ons for it to make it simpler).
+Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git]).
 ===Windows===
@@ Line 10: / Line 29: @@
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite.zip Version 1.2 and earlier].
-This file must be unpacked in one of two places depending on which version of the game you have.
+This file must be unpacked into the folder where you find Amnesia.exe, all .dll files and folders with game data. This may be one of two locations depending on which version of the game you have.
-For users who downloaded the game from the site, unpack the file to the redist folder, found in the game's root directory that you chose during installation (By default, <code>C:\Program Files\Amnesia - The Dark Descent\redist</code>). If you have no redist folder, unpack it to the main folder where you find Amnesia.exe, all .dll files and folders with game data. For steam users, that will be <code>C:\Program Files\Steam\steamapps\common\amnesia the dark descent\</code>.
+* '''For Steam users''': This will be your game installation directory, usually <code>C:\Program Files\Steam\steamapps\common\Amnesia - The Dark Descent\</code>
-When reporting crashes and bugs, always include a description of the bug and any log output from the editors themselves (logs located in your <User Directory>/HPL2/ folder).
+When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code><Documents>\HPL2\</code> folder.
 ===Linux===
@@ Line 25: / Line 45: @@
 '''Updated 2011-02-19''' Updated to fix crashes when selecting enemies.
-Extract the zip and run the installer (''hpl_editor_suite.sh'').
+Extract the zip and run the installer (<code>hpl_editor_suite.sh</code>).
 The installer should automatically find your currently installed copy of Amnesia if you installed it in one of the common installation locations. If not, simply select the Amnesia folder where you installed the game.
@@ Line 31: / Line 51: @@
 '''Note:''' No menu items are created by the installer, it simply installs the editor data files and executables for your platform.
-'''Note:''' The HplLangTool.exe is included in the Linux HPL editor suite, it is a .NET application that does run under mono.
+'''Note:''' The HplLangTool.exe is included in the Linux HPL editor suite, it is a .NET application that does run under wine/mono.
-When reporting crashes and bugs, always include a description of the bug and any log output from the editors themselves (logs located in your ~/.frictionalgames/HPL2 folder).
+When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/.frictionalgames/HPL2</code> folder.
 ===Mac OS X===
@@ Line 43: / Line 63: @@
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite-manual.dmg Manual Install for version 1.2.1 and earlier]. (Use the Manual Install only if you have issues with the automated installer, and be ''SURE'' to read the directions)
-Extract the zip and run the installer (''HPL2 Editor Suite Installer''). The installer should automatically find your currently installed copy of Amnesia no matter where you purchased it (including Steam).
+Extract the zip and run the installer (''HPL2 Editor Suite Installer''). The installer should automatically find your currently installed copy of Amnesia no matter where you purchased it (including Steam). After installing the tools, simply run Amnesia and select the "Editor Suite" tab in the launcher to run the tools.
 Notes:
@@ Line 53: / Line 72: @@
 *You must install the [http://support.frictionalgames.com/entry/100/ Amnesia 1.0.1.2 Mac OS X Patch] (this is a Mac-only patch). Steam users will get the update directly from the Steam client.
-When reporting crashes and bugs, always include a description of the bug and any log output from the editors themselves (logs located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder).
+When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder.

@@ Line 1: / Line 1: @@
 [[Category:Entry pages]]
-== Installation Instructions ==
+==Installation Instructions==
 Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git] - there are visual add-ons for it to make it simpler).
-=== Windows ===
+===Windows===
 Download the Windows HPL Editor Suite for Amnesia:
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/amnesia_tdd_1.3_editor_suite.zip Version 1.3 and later]
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite.zip Version 1.2 and earlier].
@@ Line 15: / Line 16: @@
 When reporting crashes and bugs, always include a description of the bug and any log output from the editors themselves (logs located in your <User Directory>/HPL2/ folder).
-=== Linux ===
+===Linux===
 Download the Linux HPL Editor Suite for Amnesia:
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2_editor_suite-linux-2015-03-04.zip Version 1.3 and later]
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite_linux.zip Version 1.2.1 and earlier]
@@ Line 33: / Line 35: @@
 When reporting crashes and bugs, always include a description of the bug and any log output from the editors themselves (logs located in your ~/.frictionalgames/HPL2 folder).
-=== Mac OS X ===
+===Mac OS X===
 Download the Mac OS X HPL Editor Suite:
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/HPL2-EditorSuite-OSX-2015-03-04.dmg Version 1.3 and later]
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite.dmg Version 1.2.1 and earlier]
 *[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite-manual.dmg Manual Install for version 1.2.1 and earlier]. (Use the Manual Install only if you have issues with the automated installer, and be ''SURE'' to read the directions)
@@ Line 44: / Line 47: @@
 Notes:
 * This{{clarify}} currently is not for the Mac [http://www.proleadsoft.com/mobile-app-development/| App Store] release, as updates to Amnesia will completely remove the Editor suite. Please read [http://support.frictionalgames.com/entry/103/ this] for more information.
-* '''Update 2011-02-19'''  Includes fixes for crashes and "hangs"
+*This{{clarify}} currently is not for the Mac [http://www.proleadsoft.com/mobile-app-development/| App Store] release, as updates to Amnesia will completely remove the Editor suite. Please read [http://support.frictionalgames.com/entry/103/ this] for more information.
-* '''Update 2011-03-19'''  Includes fixes for a crash that occurs when selecting entities to add to a level
+*'''Update 2011-02-19'''  Includes fixes for crashes and "hangs"
 *You must install the [http://support.frictionalgames.com/entry/100/ Amnesia 1.0.1.2 Mac OS X Patch] (this is a Mac-only patch). Steam users will get the update directly from the Steam client.
 When reporting crashes and bugs, always include a description of the bug and any log output from the editors themselves (logs located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder).
-== Tools ==
+==Tools==
 Every editor executable file must be located in the game redist folder. When first run, they create a folder in your personal directory where they will store logs, settings and temporary files. This folder will be named after a string set in the MainEditorSettings.cfg found in the game redist folder. "HPL2" is the default folder name.
 {| class="wikitable"
-! scope="row" colspan="2"| Editors
+! colspan="2" scope="row" |Editors
 |-
-| [[:hpl2:tools:editors:level_editor|Level Editor]] || Everything that you do in the other editors comes to use here.
+|[[:hpl2:tools:editors:level_editor|Level Editor]]||Everything that you do in the other editors comes to use here.
 |-
-| [[:hpl2:tools:editors:model_editor|Model editor]] || Makes your 3D models come to life with ingame functions.
+|[[:hpl2:tools:editors:model_editor|Model editor]]||Makes your 3D models come to life with ingame functions.
 |-
-| [[:hpl2:tools:editors:particle_editor|Particle editor]] || Create fire, smoke and other particles to spice up levels and models.
+|[[:hpl2:tools:editors:particle_editor|Particle editor]]||Create fire, smoke and other particles to spice up levels and models.
 |-
-| [[:hpl2:tools:editors:material_editor|Material editor]] || Should a texture come with normal, specular or illumination maps? Should the material be transparent or sound like metal?
+|[[:hpl2:tools:editors:material_editor|Material editor]]||Should a texture come with normal, specular or illumination maps? Should the material be transparent or sound like metal?
 |-
-| [[:hpl2:tools:editors:hpl_lang_tool|HPL Language Tool]] || Helper tool to build,edit, and translate language files
+|[[HPL2/Tools/HplLangTool|HPL Language Tool]]||Helper tool to build,edit, and translate language files
 |-
-! scope="row" colspan="2"| Viewers
+! colspan="2" scope="row" |Viewers
 |-
-| [[:hpl2:tools:viewers:map_viewer|Map viewer]] || Gives extra information about the level and allows viewing without running the game. A useful tool for optimization.
+|[[:hpl2:tools:viewers:map_viewer|Map viewer]]||Gives extra information about the level and allows viewing without running the game. A useful tool for optimization.
 |-
-| [[:hpl2:tools:viewers:model_viewer|Model viewer]] || See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets.
+|[[:hpl2:tools:viewers:model_viewer|Model viewer]]||See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets.
 |}