Difference between revisions of "HPL2/Getting started"

From Frictional Wiki
Jump to navigation Jump to search
(Created page)
 
m (Boldened some names)
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:
  
# 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''' 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.
# 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 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.
  
== 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 ==
+
==Additional reading==
 
Here are a few additional things you can do that are very useful to check out:
 
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.
+
#Check out the [[HPL2/Glossary|HPL2 glossary]] for explanations on common terms and phrases and what they mean.
# Join the official [https://discord.com/invite/frictionalgames Discord server] and ask questions if you need help.
+
#Join the official [https://discord.com/invite/frictionalgames Discord server] and ask questions if you need help.
  
 
You are now ready to start [[HPL2/TDD/Creating a Custom Story|'''setting up your first custom story''']]!
 
You are now ready to start [[HPL2/TDD/Creating a Custom Story|'''setting up your first custom story''']]!

Revision as of 23:21, 8 September 2020

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:

  1. 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.
  2. Your code editor of choice installed. For example VS Code or Atom. If you're old school, Notepad++ also works great.

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.

Additional reading

Here are a few additional things you can do that are very useful to check out:

  1. Check out the HPL2 glossary for explanations on common terms and phrases and what they mean.
  2. Join the official Discord server and ask questions if you need help.

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