Difference between revisions of "HPL2"
Jump to navigation
Jump to search
Note: because the MFP version is in majority identical to the TDD version, most of the documentation resides in the TDD section.
(→Where to start: New link, and refactoring) |
(Intro revamp) |
||
| Line 1: | Line 1: | ||
[[Category:Entry pages]] | [[Category:Entry pages]] | ||
| − | + | __NOTOC__ | |
| − | + | <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". | ||
| + | </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;"> | ||
| + | <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> | ||
==Where to start== | ==Where to start== | ||
| Line 9: | Line 17: | ||
#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. | #Having problems with the tools? Look for a solution on the [[:hpl2:tools:troubleshooting|Troubleshooting]] page. | ||
| − | #Check [[HPL2/Development Environment|how to setup a | + | #Check [[HPL2/Development Environment|how to setup a developer environment]]. |
#Read up on making a [[:hpl2:amnesia:custom_story|Custom Story]]. | #Read up on making a [[:hpl2:amnesia:custom_story|Custom Story]]. | ||
#Learn scripting: | #Learn scripting: | ||
| Line 20: | Line 28: | ||
==Game Specific== | ==Game Specific== | ||
| − | |||
<gallery mode="nolines" widths="250" heights="250"> | <gallery mode="nolines" widths="250" heights="250"> | ||
Tdd-header.jpg|link=HPL2/TDD|[[HPL2/TDD|"Amnesia: The Dark Descent" - The main HPL2 documentation]]. | Tdd-header.jpg|link=HPL2/TDD|[[HPL2/TDD|"Amnesia: The Dark Descent" - The main HPL2 documentation]]. | ||
Mfp-header.jpg|link=HPL2/AMFP|[[HPL2/AMFP|Documentation specific to "Amnesia: A Machine For Pigs"]]. | Mfp-header.jpg|link=HPL2/AMFP|[[HPL2/AMFP|Documentation specific to "Amnesia: A Machine For Pigs"]]. | ||
</gallery> | </gallery> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Tutorials== | ==Tutorials== | ||
| − | [[ | + | [[HPL2/Tutorials|Tutorials]] for all tools, scripts and engine usage. |
==Third Party Tools & Resources== | ==Third Party Tools & Resources== | ||
Revision as of 13:19, 30 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".
Note: 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.
- Read the glossary to quickly learn about terms used in the other articles.
- Download and read about the Tools.
- Having problems with the tools? Look for a solution on the Troubleshooting page.
- Check how to setup a developer environment.
- Read up on making a Custom Story.
- 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.
- Once you know the engine a bit (and before you seriously start developing a mod) read the best practices for developing mods.
Game Specific
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.