HPL2/Getting started

From Frictional Wiki
Jump to navigation Jump to search

This page will guide you through the basic steps you want to make to get started modding HPL2. This guide will have you use Amnesia – The Dark Descent (TDD), not Amnesia – A Machine For Pigs (AMFP), as TDD is the one that is officially supported for modding.

Prerequisites

Before you get started, you should already have the following installed:

  1. A legal copy of Amnesia – The Dark Descent. All platforms should work, including Steam, GOG and retail DVDs, on Windows, Mac OS X (versions EARLIER than 10.15 Catalina), and most Linux distros.
  2. Your code editor of choice.
    1. VS Code or its free/open version, VS Codium, are recommended due to their convenient autocompletion and search features.
    2. If you're old-school, Notepad++ also works.

Setting up your game

The initial view of the HPL2 level editor.
The view of the level editor

Before you dive in, you should set up a few things:

  1. Install the development tools for your platform.
  2. Configure your game to use the development environment (optional, but highly recommended).
  3. Bookmark the Script Functions page. This page is a great reference for when you create your scripts.

You are now ready to start setting up your first custom story!

Additional steps

Here are a few other useful things you can do:

  1. Check out the HPL2 glossary for an explanations of the engine's modding jargon.
  2. Check out some Tutorials.
  3. Join the official Discord server and its modding channels to ask questions if you need help.