Difference between revisions of "HPL2"

From Frictional Wiki
Jump to navigation Jump to search
(Picture links)
(→‎Where to start: Added the modding guide)
Line 6: Line 6:
 
It is highly recommended to start learning about the engine with the TDD version.
 
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.
 
#Read the [[HPL2/Glossary| glossary]] to quickly learn about terms used in the other articles.
#Download and read about the [[HPL2/Tools|Tools]].
+
#Download and read about the [[HPL2/Tools|Tools]].
 +
#Having problems with the tools? Look for a solution on the [[:hpl2:tools:troubleshooting|Troubleshooting]] page.
 
#Check [[HPL2/Development Environment|how to setup a dev environment]].
 
#Check [[HPL2/Development Environment|how to setup a dev environment]].
 
#Read up on making a [[:hpl2:amnesia:custom_story|Custom Story]].
 
#Read up on making a [[:hpl2:amnesia:custom_story|Custom Story]].
Line 13: Line 14:
 
#Try to skim through and reference [[HPL2/ScriptReference|the script guide]] when starting with scripts.
 
#Try to skim through and reference [[HPL2/ScriptReference|the script guide]] when starting with scripts.
 
#If you're making scripts for a map, then the [[HPL2/Engine Scripts|Script Functions]] page is a must.
 
#If you're making scripts for a map, then the [[HPL2/Engine Scripts|Script Functions]] page is a must.
#Having problems with the tools? Look for a solution on the [[:hpl2:tools:troubleshooting|Troubleshooting]] page.
+
#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==
 
==Game Specific==

Revision as of 22:54, 25 July 2020

Welcome to the HPL2 documentation hub. Here you can find documentation about the different iterations of the engine. 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".

Because the MFP version is in majority identical to the TDD version, most of the documentation resides in the TDD section.

Where to start

It is highly recommended to start learning about the engine with the TDD version.

  1. Read the glossary to quickly learn about terms used in the other articles.
  2. Download and read about the Tools.
  3. Having problems with the tools? Look for a solution on the Troubleshooting page.
  4. Check how to setup a dev environment.
  5. Read up on making a Custom Story.
  6. Make sure you add a default script file to all your maps, as shown here.
  7. Check the rest of the Tutorials.
  8. Try to skim through and reference the script guide when starting with scripts.
  9. If you're making scripts for a map, then the Script Functions page is a must.
  10. Once you know the engine a bit (and before you seriously start developing a mod) read the best practices for developing mods.

Game Specific

Editors & Viewers

HPL2 comes with a set of development tools.

Tutorials

Tutorials for all tools, scripts and engine usage.

Third Party Tools & Resources

Information on 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.

Additionally there are plenty of Resources available, including upgraded tools and script libraries to aid in development.