Difference between revisions of "HPL2"

From Frictional Wiki
Jump to navigation Jump to search
m (→‎Where to start: Updated the tutorial link)
(→‎Where to start: New link, and refactoring)
Line 11: Line 11:
 
#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]].
#Make sure you add a default script file to all your maps, [[:hpl2:tutorials:script:tutorial_1|as shown here]].
+
#Learn scripting:
#Check the rest of the [[HPL2/Tutorials|Tutorials]].
+
#*Make sure you add a default script file to all your maps, [[:hpl2:tutorials:script:tutorial_1|as shown here]].
#Try to skim through and reference [[HPL2/ScriptReference|the script guide]] when starting with scripts.
+
#*Learn how to write scripts comfortably and fast from [[HPL2/Tutorials/Scripts/Debugging|the debugging guide]].
#If you're making scripts for a map, then the [[HPL2/Engine Scripts|Script Functions]] page is a must.
+
#*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]].
 
#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]].
  

Revision as of 23:24, 27 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. Learn scripting:
    • Make sure you add a default script file to all your maps, as shown here.
    • Learn how to write scripts comfortably and fast from the debugging guide.
    • Check the rest of the Tutorials for simple scripts to practice the basics on.
    • If you start making your own scripts, then the Script Functions page is a must.
    • Try to skim through and reference the script guide to deepen your understanding.
  7. 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.