Difference between revisions of "HPL2/Getting started"

From Frictional Wiki
Jump to navigation Jump to search
(Created page)
 
(add tutorials and clean up the reading experience a bit)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
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.
+
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 ==
+
==Prerequisites==
−
Before you get started, you should already have the following:
+
Before you get started, you should already have the following installed:
  
−
# A legal copy of Amnesia – The Dark Descent installed. 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.
+
#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.
−
# Your code editor of choice installed. For example [https://code.visualstudio.com/ VS Code] or [https://atom.io/ Atom]. If you're old school, [https://notepad-plus-plus.org/ Notepad++] also works great.
+
#Your code editor of choice.
 +
##[https://code.visualstudio.com/ VS Code] or its free/open version, [https://vscodium.com/ VS Codium], are recommended due to their convenient autocompletion and search features.
 +
##If you're old-school, [https://notepad-plus-plus.org/ Notepad++] also works.
  
−
== Setting up your game ==
+
==Setting up your game==
 
[[File:Level Editor.png|alt=The initial view of the HPL2 level editor.|thumb|The view of the level editor]]
 
[[File:Level Editor.png|alt=The initial view of the HPL2 level editor.|thumb|The view of the level editor]]
 
Before you dive in, you should set up a few things:
 
Before you dive in, you should set up a few things:
  
−
# [[HPL2/Tools#Installation Instructions|Install the development tools]] for your platform.
+
#[[HPL2/Tools#Installation Instructions|Install the development tools]] for your platform.
−
# Configure your game to use the [[HPL2/Development Environment|development environment]] (optional, but highly recommended).
+
#Configure your game to use the [[HPL2/Development Environment|development environment]] (optional, but highly recommended).
−
# Bookmark the [[HPL2/Engine Scripts|Script Functions]] page. This page is a great reference for when you create your scripts.
+
#Bookmark the [[HPL2/Engine Scripts|Script Functions]] page. This page is a great reference for when you create your scripts.
  
−
== Additional reading ==
+
You are now ready to start [[HPL2/TDD/Creating a Custom Story|'''setting up your first custom story''']]!
−
Here are a few additional things you can do that are very useful to check out:
 
  
−
# Check out the [[HPL2/Glossary|HPL2 glossary]] for explanations on common terms and phrases and what they mean.
+
==Additional steps==
−
# Join the official [https://discord.com/invite/frictionalgames Discord server] and ask questions if you need help.
+
Here are a few other useful things you can do:
  
−
You are now ready to start [[HPL2/TDD/Creating a Custom Story|'''setting up your first custom story''']]!
+
#Check out the [[HPL2/Glossary|HPL2 glossary]] for an explanations of the engine's modding jargon.
 +
#Check out some [[HPL2/Tutorials | Tutorials]].
 +
#Join the official [https://discord.com/invite/frictionalgames Discord server] and its modding channels to ask questions if you need help.

Latest revision as of 15:43, 21 September 2023

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.
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL2/Getting_started&oldid=6458"