Difference between revisions of "HPL2"

From Frictional Wiki
Jump to navigation Jump to search
m (uppercase letter)
(Add a link to the 1.5 update notes and small clean up)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
 
 
 
<div style="text-align:center;">
 
<div style="text-align:center;">
'''Welcome to the HPL2 documentation hub. Here you can find documentation about the different iterations of the engine.'''<br>HPL2 was used to create "Amnesia: The Dark Descent", and an alternate version of the engine was used to create "Amnesia: A Machine For Pigs".
+
'''Welcome to the HPL2 documentation hub.'''<br>Here you can find extensive documentation about the engine and the games below, including downloads for various tools and tutorials on how to create your own [[HPL2/TDD/Modding|custom stories]].
 
</div>
 
</div>
 
{{note|Note: because the MFP version is in majority identical to the TDD version, most of the documentation resides in the TDD section.}}
 
  
 
<div style="text-align:center;">
 
<div style="text-align:center;">
 
<p style="margin:1em auto 0; text-align:center; width:400px;">[[File:Hpl2 logo.png|250px|link=|HPL2]]</p>
 
<p style="margin:1em auto 0; text-align:center; width:400px;">[[File:Hpl2 logo.png|250px|link=|HPL2]]</p>
<p style="margin:1em;">'''[[HPL2/Tools|Development Tools]] | [[:hpl2:tools:troubleshooting|Troubleshooting]] | [[HPL2/Features_Overview|Features Overview]]'''</p></div>
+
<p style="margin:1em;">'''[[HPL2/Tools|Development Tools]] | [[HPL2/Troubleshooting|Troubleshooting]] | [https://wiki.frictionalgames.com/page/Special:PrefixIndex?prefix=HPL2%2F&namespace=0&hideredirects=1 All Pages]'''</p></div>
 +
----
  
==Where to start==
 
It is highly recommended to start learning about the engine with the TDD version.
 
  
#Read the [[HPL2/Glossary| glossary]] to quickly learn about terms used in the other articles.
+
<div style="text-align:center;">
#Download and read about the [[HPL2/Tools|Tools]].
+
<span style="background-color: #4A554A; border: 1px solid #44dd44; padding: 12px;>
#Having problems with the tools? Look for a solution on the [[:hpl2:tools:troubleshooting|Troubleshooting]] page.
+
<span>[[File:Note icon.png|frameless|link=]]
#Check [[HPL2/Development Environment|how to setup a developer environment]].
+
[[HPL2/1.5_Update | Notes about the 1.5 update]]
#Read up on making a [[:hpl2:amnesia:custom_story|Custom Story]].
+
</span>
#Learn scripting:
+
</span>
#*Make sure you add a default script file to all your maps, [[:hpl2:tutorials:script:tutorial_1|as shown here]].
+
</div>
#*Learn how to write scripts comfortably and fast from [[HPL2/Tutorials/Scripts/Debugging|the debugging guide]].
 
#*Check the rest of the [[HPL2/Tutorials|Tutorials]] for simple scripts to practice the basics on.
 
#*If you start making your own scripts, then the [[HPL2/Engine Scripts|Script Functions]] page is a must.
 
#*Try to skim through and reference [[HPL2/ScriptReference|the script guide]] to deepen your understanding.
 
#Once you know the engine a bit <span style="color:#e94242">(and before you seriously start developing a mod)</span> read the [[Making_a_Mod_-_Best_Practices|best practices for developing mods]].
 
  
==Game Specific==
+
{{:HPL2/TDD}}
<gallery mode="nolines" widths="250" heights="250">
 
File:Tdd-header.jpg|[[HPL2/TDD|"Amnesia: The Dark Descent" - The main HPL2 documentation]].
 
File:Mfp-header.jpg|[[HPL2/AMFP|Documentation specific to "Amnesia: A Machine For Pigs"]].
 
</gallery>
 
==Tutorials==
 
  
[[HPL2/Tutorials|Tutorials]] for all tools, scripts and engine usage.
+
----
  
==Third Party Tools & Resources==
 
  
Information on [[:hpl2:third_party_tools:start|Third Party Tools]] that can be used to create models, graphics and art for the game and what specific things you will need to setup to make it all work.
+
<div style="text-align:center;">
 +
<span style="background-color: #4a4a44; border: 1px solid #ffc400; padding: 12px;>
 +
<span>[[File:Note icon.png|frameless|link=]]
 +
Because The Dark Descent and A Machine for Pigs are quite similar, most of the documentation from TDD applies to MFP.
 +
</span>
 +
</span>
 +
</div>
 +
{{:HPL2/AMFP}}
  
Additionally there are plenty of [[:hpl2:resources:start|Resources]] available, including upgraded tools and script libraries to aid in development.
 
  
 
[[Category:Entry pages]]
 
[[Category:Entry pages]]
 
[[Category:English]]
 
[[Category:English]]
 +
 +
__NOTOC____NOEDITSECTION__

Latest revision as of 13:45, 14 September 2023

Welcome to the HPL2 documentation hub.
Here you can find extensive documentation about the engine and the games below, including downloads for various tools and tutorials on how to create your own custom stories.

HPL2

Development Tools | Troubleshooting | All Pages



Note icon.png Notes about the 1.5 update

Amnesia: The Dark Descent

Getting started
Check out how to quickly get started creating custom content for Amnesia – The Dark Descent.
Modding
Create, organize and release your Amnesia mods
Level Design
Work with the Level Editor and create immersive worlds
Script Functions
See a list of all available script functions for Amnesia TDD
Scripting
Some useful links for scripting
Modeling
Import, export, add and modify 3D models for the game
Entities
Use the Model Editor to create interactive and dynamic objects
Materials
Use the Material Editor to combine texture maps to create materials
Effects
About effects: Lights, Billboards, Sounds and Particle Systems (effects like smoke, sparks, blood and fire).
Tutorials
Step-by-step guides on a variety of topics, created by the community
Third-Party Tools
Useful developer tools, some of which are created by the community
Glossary
Explanations for terms you may encounter




Note icon.png Because The Dark Descent and A Machine for Pigs are quite similar, most of the documentation from TDD applies to MFP.

Amnesia: A Machine for Pigs

Introduction
Information to get started and how to set up the tools
Developer environment
About the debug set-up.
Areas
MFP features new area types.
Entities
MFP features new entity types.
Scripting
MFP uses a majority of TDD functions. There are some new ones, however. Some of the old ones are removed or replaced.
Infection
Infection was a mechanic which was removed from the final product. However, some of the functionality remained.
Color grade texture tutorial
Instructions for creating custom color grade textures. In-game color grading usage is documented in the Areas article.