Difference between revisions of "HPL2/Tools"
(Merged editors and tools into a single table) |
m |
||
| Line 1: | Line 1: | ||
[[Category:Entry pages]] | [[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). | 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: | 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/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]. | *[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). | 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: | 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/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] | *[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). | 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: | 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/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.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) | *[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: | 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" |
| + | *'''Update 2011-03-19''' Includes fixes for a crash that occurs when selecting entities to add to a level | ||
*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. | *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 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. | 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" | {| class="wikitable" | ||
| − | ! | + | ! 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/HplLangTool|HPL Language Tool]]||Helper tool to build,edit, and translate language files |
|- | |- | ||
| − | ! | + | ! 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. |
|} | |} | ||
Revision as of 00:24, 6 August 2020
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. Git - there are visual add-ons for it to make it simpler).
Windows
Download the Windows HPL Editor Suite for Amnesia:
This file must be unpacked in one of two places 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, C:\Program Files\Amnesia - The Dark Descent\redist). 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 C:\Program Files\Steam\steamapps\common\amnesia the dark descent\.
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
Download the Linux HPL Editor Suite for Amnesia:
Updated 2011-02-19 Updated to fix crashes when selecting enemies.
Extract the zip and run the installer (hpl_editor_suite.sh).
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.
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.
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
Download the Mac OS X HPL Editor Suite:
- Version 1.3 and later
- Version 1.2.1 and earlier
- 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). After installing the tools, simply run Amnesia and select the "Editor Suite" tab in the launcher to run the tools.
Notes:
- This[Clarify] currently is not for the Mac App Store release, as updates to Amnesia will completely remove the Editor suite. Please read this for more information.
- Update 2011-02-19 Includes fixes for crashes and "hangs"
- Update 2011-03-19 Includes fixes for a crash that occurs when selecting entities to add to a level
- You must install the 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 ~/Library/Application Support/Frictional Games/HPL2 folder).
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.
| Editors | |
|---|---|
| Level Editor | Everything that you do in the other editors comes to use here. |
| Model editor | Makes your 3D models come to life with ingame functions. |
| Particle editor | Create fire, smoke and other particles to spice up levels and models. |
| Material editor | Should a texture come with normal, specular or illumination maps? Should the material be transparent or sound like metal? |
| HPL Language Tool | Helper tool to build,edit, and translate language files |
| Viewers | |
| Map viewer | Gives extra information about the level and allows viewing without running the game. A useful tool for optimization. |
| Model viewer | See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets. |