HPL2/TDD/Creating a Custom Story - Revision history

Darkfire: Add link to the config file article in the relevant place

2023-09-14T11:41:03Z

Add link to the config file article in the relevant place

Mudbill at 19:46, 16 September 2020

2020-09-16T19:46:00Z

Mudbill at 19:37, 16 September 2020

2020-09-16T19:37:40Z

Mudbill: Added link to level editor

2020-09-16T19:06:36Z

Added link to level editor

Mudbill: Made list of paths into a table

2020-09-14T21:59:28Z

Made list of paths into a table

Mudbill: Added links to See Also

2020-09-09T08:10:17Z

Added links to See Also

Mudbill: Added TocRight template

2020-09-09T00:41:22Z

Added TocRight template

Mudbill: Rewrote the entire page

2020-09-09T00:38:43Z

Rewrote the entire page

Show changes

Mudbill: Mudbill moved page Hpl2:Amnesia:custom story to HPL2/TDD/Creating a Custom Story without leaving a redirect

2020-08-04T03:00:42Z

Mudbill moved page Hpl2:Amnesia:custom story to HPL2/TDD/Creating a Custom Story without leaving a redirect

Darkfire: /* Wrapping up your Custom Story */ Made smth more understandable

2020-07-31T20:19:30Z

Wrapping up your Custom Story: Made smth more understandable

@@ Line 34: / Line 34: @@
 	DefaultExtraLangFile="english.lang"
 />
-</syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. See the link at the bottom for a full explanation of this file. [[File:Custom story empty example.png|alt=A bare minimum custom story configuration|thumb|A bare minimum custom story configuration]]
+</syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. [[HPL2/custom_story_settings.cfg | See this article]] for a full explanation of this file and additional options that can be added.
 #The next requirement before the story will appear in the game's menu is a valid map file. Open the level editor and create a simple room – or at the very least create a floor using the Plane tool, place down a Box Light to cover the area, and place a PlayerStart area. Save the map file into <code>custom_stories/My First Story/maps/level_01.map</code>, or whatever matches the setup you've used. Don't forget to create the "maps" folder as it is written in your config file.
 #At this point, if you launch Amnesia, your story should appear in the list of custom stories as seen in the image to the right. Feel free to test this to ensure everything works so far. If you click "Start" you should load into your level.

@@ Line 34: / Line 34: @@
 	DefaultExtraLangFile="english.lang"
 />
-</syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. [[HPL2/custom story settings.cfg|Click here to see the full explanation for this file]]. [[File:Custom story empty example.png|alt=A bare minimum custom story configuration|thumb|A bare minimum custom story configuration]]
+</syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. See the link at the bottom for a full explanation of this file. [[File:Custom story empty example.png|alt=A bare minimum custom story configuration|thumb|A bare minimum custom story configuration]]
 #The next requirement before the story will appear in the game's menu is a valid map file. Open the level editor and create a simple room – or at the very least create a floor using the Plane tool, place down a Box Light to cover the area, and place a PlayerStart area. Save the map file into <code>custom_stories/My First Story/maps/level_01.map</code>, or whatever matches the setup you've used. Don't forget to create the "maps" folder as it is written in your config file.
 #At this point, if you launch Amnesia, your story should appear in the list of custom stories as seen in the image to the right. Feel free to test this to ensure everything works so far. If you click "Start" you should load into your level.
@@ Line 71: / Line 71: @@
 ==See also==
 *[[HPL2/Tools/Level Editor|How to navigate the Level Editor]]
 *[[HPL2/Tutorials/Level Design|Using the level editor to design maps]]
 *[[HPL2/ScriptReference|Introduction to AngelScript and level scripting]]

@@ Line 34: / Line 34: @@
 	DefaultExtraLangFile="english.lang"
 />
-</syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. See the table further down for explanations about each field.[[File:Custom story empty example.png|alt=A bare minimum custom story configuration|thumb|A bare minimum custom story configuration]]
+</syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. [[HPL2/custom story settings.cfg|Click here to see the full explanation for this file]]. [[File:Custom story empty example.png|alt=A bare minimum custom story configuration|thumb|A bare minimum custom story configuration]]
 #The next requirement before the story will appear in the game's menu is a valid map file. Open the level editor and create a simple room – or at the very least create a floor using the Plane tool, place down a Box Light to cover the area, and place a PlayerStart area. Save the map file into <code>custom_stories/My First Story/maps/level_01.map</code>, or whatever matches the setup you've used. Don't forget to create the "maps" folder as it is written in your config file.
 #At this point, if you launch Amnesia, your story should appear in the list of custom stories as seen in the image to the right. Feel free to test this to ensure everything works so far. If you click "Start" you should load into your level.
@@ Line 68: / Line 68: @@
   |- custom_story_settings.cfg
   |- extra_english.lang</pre>
 ==See also==

@@ Line 102: / Line 102: @@
 ==See also==
 *[[HPL2/Tutorials/Level Design|Using the level editor to design maps]]
 *[[HPL2/ScriptReference|Introduction to AngelScript and level scripting]]

@@ Line 3: / Line 3: @@
 To get started, browse to your Amnesia TDD installation directory. This is often called the ''Amnesia root directory'', and where it is located depends on the system and platform you are using. Here are some common locations:
+{| class="wikitable"
-*Steam @ Windows: <code>C:\Program Files (x86)\Steam\steamapps\common\Amnesia The Dark Descent</code>
+|Steam @ Windows
-*Retail @ Windows: <code>C:\Program Files (x86)\Amnesia</code>
+|<code>C:\Program Files (x86)\Steam\steamapps\common\Amnesia The Dark Descent</code>
-*Steam @ Mac: <code>~/Library/Application Support/Steam/steamapps/common/Amnesia The Dark Descent</code>
+|-
 ==Setting up a custom story==

@@ Line 4: / Line 4: @@
 To get started, browse to your Amnesia TDD installation directory. This is often called the ''Amnesia root directory'', and where it is located depends on the system and platform you are using. Here are some common locations:
-* Steam @ Windows: <code>C:\Program Files (x86)\Steam\steamapps\common\Amnesia The Dark Descent</code>
+*Steam @ Windows: <code>C:\Program Files (x86)\Steam\steamapps\common\Amnesia The Dark Descent</code>
-* Retail @ Windows: <code>C:\Program Files (x86)\Amnesia</code>
+*Retail @ Windows: <code>C:\Program Files (x86)\Amnesia</code>
-* Steam @ Mac: <code>~/Library/Application Support/Steam/steamapps/common/Amnesia The Dark Descent</code>
+*Steam @ Mac: <code>~/Library/Application Support/Steam/steamapps/common/Amnesia The Dark Descent</code>
-== Setting up a custom story ==
+==Setting up a custom story==
 {{note|The simplest way of starting a Custom Story is downloading a [https://www.mediafire.com/file/m0yw9ro94yruzk6/Custom_Story.zip/file template]. The following tutorial will help with understanding what those files do.}}{{todo|Reupload the template to the wiki}}
 Depending on your version, you may have a folder called "redist" inside your root directory. If you do, you will be working from inside this folder. If you do not have the "redist" folder, you will be working from the root directory itself.
-# Navigate to <code>custom_stories/</code>
+#Navigate to <code>custom_stories/</code>
-# Create a new folder for your custom story. This folder can be named pretty much anything, for example "My First Story".
+#Create a new folder for your custom story. This folder can be named pretty much anything, for example "My First Story".
-# Enter your new folder and create a new plain text file named <code>custom_story_settings.cfg</code>. Open this file in your favorite code editor and paste in the following XML configuration:<syntaxhighlight lang="xml">
+#Enter your new folder and create a new plain text file named <code>custom_story_settings.cfg</code>. Open this file in your favorite code editor and paste in the following XML configuration:<syntaxhighlight lang="xml">
 <Main
 	Name="My First Story"
@@ Line 29: / Line 29: @@
 />
 </syntaxhighlight>You can change any fields you like, for instance the name and author, but you may want to come back to this later. See the table further down for explanations about each field.[[File:Custom story empty example.png|alt=A bare minimum custom story configuration|thumb|A bare minimum custom story configuration]]
-# The next requirement before the story will appear in the game's menu is a valid map file. Open the level editor and create a simple room – or at the very least create a floor using the Plane tool, place down a Box Light to cover the area, and place a PlayerStart area. Save the map file into <code>custom_stories/My First Story/maps/level_01.map</code>, or whatever matches the setup you've used. Don't forget to create the "maps" folder as it is written in your config file.
+#The next requirement before the story will appear in the game's menu is a valid map file. Open the level editor and create a simple room – or at the very least create a floor using the Plane tool, place down a Box Light to cover the area, and place a PlayerStart area. Save the map file into <code>custom_stories/My First Story/maps/level_01.map</code>, or whatever matches the setup you've used. Don't forget to create the "maps" folder as it is written in your config file.
-# At this point, if you launch Amnesia, your story should appear in the list of custom stories as seen in the image to the right. Feel free to test this to ensure everything works so far. If you click "Start" you should load into your level.
+#At this point, if you launch Amnesia, your story should appear in the list of custom stories as seen in the image to the right. Feel free to test this to ensure everything works so far. If you click "Start" you should load into your level.
-# Optional: Add the image file as specified by the <code>ImgFile</code>attribute above. Match the name and extension and place the file next to your config, and it should render as the background image in the game menu.
+#Optional: Add the image file as specified by the <code>ImgFile</code>attribute above. Match the name and extension and place the file next to your config, and it should render as the background image in the game menu.
-== Displaying text ==
+==Displaying text==
 Now that you have a functional custom story, it's time to add some other essential files. In the image to the right you may notice it says "No description." This is the fallback text that appears if you do not have a functional language file, so let's create that now.
-# Start by creating a new plain text file in your custom story folder named <code>extra_english.lang</code>.
+#Start by creating a new plain text file in your custom story folder named <code>extra_english.lang</code>.
-# Open the language file. This is another XML file that stores ALL text that will be displayed in your story. This includes things like descriptions, pop-up text, notes, item names, level names etc.  You can start by pasting in the following:<syntaxhighlight lang="xml">
+#Open the language file. This is another XML file that stores ALL text that will be displayed in your story. This includes things like descriptions, pop-up text, notes, item names, level names etc.  You can start by pasting in the following:<syntaxhighlight lang="xml">
 <LANGUAGE>
 	<CATEGORY Name="CustomStoryMain">
@@ Line 44: / Line 44: @@
 </LANGUAGE>
 </syntaxhighlight>There are a few rules to keep in mind when it comes to this file:
-## All text within this file is CASE SENSITIVE, meaning if you write "language" instead of "LANGUAGE" it will not work.
+##All text within this file is CASE SENSITIVE, meaning if you write "language" instead of "LANGUAGE" it will not work.
-## The file MUST start with the opening <code><LANGUAGE></code> tag and it MUST end with the closing <code></LANGUAGE></code> tag. This element should only occur once in the entire file.
+##The file MUST start with the opening <code><LANGUAGE></code> tag and it MUST end with the closing <code></LANGUAGE></code> tag. This element should only occur once in the entire file.
-## Inside the LANGUAGE element,  you can place as many CATEGORY elements as you wish, but ensure that every opening tag is always accompanied by a closing tag.
+##Inside the LANGUAGE element,  you can place as many CATEGORY elements as you wish, but ensure that every opening tag is always accompanied by a closing tag.
-## Certain CATEGORY tags require a specific value in the "Name" attribute. For instance, the main menu description is required to be within a category named <code>CustomStoryMain</code>.
+##Certain CATEGORY tags require a specific value in the "Name" attribute. For instance, the main menu description is required to be within a category named <code>CustomStoryMain</code>.
-## You can place as many Entry elements as you wish inside each CATEGORY element. The actual text that appears in the game will be written between the opening and closing tag for the Entry. Similarly to CATEGORY tags, certain Entry tags require specific values in their name attribute for the game to pick it up. In the above example, the description must have the name <code>Description</code>.
+##You can place as many Entry elements as you wish inside each CATEGORY element. The actual text that appears in the game will be written between the opening and closing tag for the Entry. Similarly to CATEGORY tags, certain Entry tags require specific values in their name attribute for the game to pick it up. In the above example, the description must have the name <code>Description</code>.
-## If any errors are encountered while the game parses this file, the entire file will fail to load and no custom text will appear in your story. You will know that it failed to load if you see "No description" in the game menu.
+##If any errors are encountered while the game parses this file, the entire file will fail to load and no custom text will appear in your story. You will know that it failed to load if you see "No description" in the game menu.
-== Moving on ==
+==Moving on==
 You have now set up the basic configuration for a custom story. What's left to do now is to create your levels using the level editor, create scripts for your levels using any code editor, and optionally add extra assets you wish to use to additional folders inside your custom story directory. These topics are very expansive and are not covered here, but you can follow the links below for more information on them.
@@ Line 63: / Line 63: @@
   |- extra_english.lang</pre>
-== custom_story_settings.cfg explanation ==
+==custom_story_settings.cfg explanation==
 The <code>custom_story_settings.cfg</code> file has a number of fields available. See the below table for explanations on what each field is.
 {| class="wikitable"
@@ Line 94: / Line 94: @@
 |}
-== See also ==
+==See also==
-* Using the level editor to design maps
+*[[HPL2/Tutorials/Level Design|Using the level editor to design maps]]
-* Introduction to AngelScript and level scripting
+*[[HPL2/ScriptReference|Introduction to AngelScript and level scripting]]

@@ Line 1: / Line 1: @@
 Creating a working custom story is a relatively simple process. This page will explain what you need to set up to do so, but it will not go into how you create engaging content as that is a much more invested topic.
@@ Line 63: / Line 64: @@
 == custom_story_settings.cfg explanation ==
-The <code>custom_story_settings.cfg</code> file has a number of fields available. See the below table for explanations what each field is.
+The <code>custom_story_settings.cfg</code> file has a number of fields available. See the below table for explanations on what each field is.
 {| class="wikitable"
 !Field name

← Older revision	Revision as of 03:00, 4 August 2020
(No difference)

@@ Line 9: / Line 9: @@
 {{todo|The above is misguiding and should probably be deleted.}}
-# Create a subfolder (story root from now on) for the story under <code>redist/custom_stories</code>. Name it anything you please. '''Keep in mind that changing this folder's name might break certain things in the custom story if you make maps.'''
+# Create a subfolder (story root from now on) for the story under <code>redist/custom_stories</code>. Name it anything you please. '''Keep in mind that changing this folder's name might break certain things in maps made when the folder had the previous name.'''
 # Copy your maps, scripts, and anything you created for the custom story into the story root. You may want to organize all stuff in subfolders. Maps with corresponding scripts, by default, should be located in a subfolder called 'maps'.
 # Create a text file named 'custom_story_settings.cfg' in the story root. The contents of this file should look like this: <syntaxhighlight lang="xml">