Difference between revisions of "HPL2/TDD/Config Files"

From Frictional Wiki
< HPL2‎ | TDD
Jump to navigation Jump to search
(Upload from wiki)
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Config Files - Amnesia ==
+
==Config Files==
  
 +
{{todo|Move this to a more appropriate link}}
  
What follows is a list of all the config files that are part of Amnesia.
+
What follows is a list of all the config files that are a part of HPL2. All of them can be used in a [[HPL2/TDD/Full Conversion Mod|full conversion]] to alter the game.
  
 +
==Main configuration==
 +
The following config files are a part of the main config folder.
 +
{| class="wikitable" style="margin:auto;"
 +
|-
 +
|'''[[HPL2/TDD/main init.cfg|<center>Main init</center>]]'''
 +
|Handles all of the major settings for the game, like setting up the name of game, save directory and what config files to use.
 +
|-
 +
|'''[[HPL2/TDD/game.cfg|<center>Game</center>]]'''
 +
|Contains all game related settings.
 +
|-
 +
|'''[[HPL2/TDD/menu.cfg|<center>Menu</center>]]'''
 +
|All the settings related to the menu.
 +
|-
 +
|'''[[HPL2/TDD/pre menu.cfg|<center>Pre-menu</center>]]'''
 +
|Contains all of the settings for the pre-menu (that pops up before the menu).
 +
|-
 +
|'''[[HPL2/TDD/demo.cfg|<center>Demo</center>]]'''
 +
|Demo specific settings. Only loaded if the demo version of the exe is used.
 +
|}
 +
==Resources==
 +
<code>resources.cfg</code> is a file which lists all of the folders that Amnesia.exe searches for assets. In case of file name collisions, they are prioritised in the order of this list.
  
''' [[:hpl2:amnesia:config:main_init|Main_init]] <br /> Handles all of the major settings for the game, like setting up name of game, save directory and what config files to use.
+
{{idea|This file can be used to overwrite files during runtime without changing them. The files need to be copied into a new folder and altered there. Then, the folder has to be put on top of the list.}}
  
 +
==Materials==
 +
<code>materials.cfg</code> is a file which lists all physical materials available in the game and the editors. Each material in the file contains its physics parameters, the sounds it makes (steps, impact, scrape, sometimes also roll) and the particles produced when the material is hit.
  
''' [[:hpl2:amnesia:config:game|Game]] <br /> Contains all game related settings.
+
{{idea|This file can be used to create custom surface materials (Machine For Pigs added a lot of them) or alter the step sounds (this was done in Justine).}}
  
 +
==Insanity events==
 +
<code>misc/main_sanity_events.cfg</code> contains the insanity events which can occur in the game. They can be organised into categories, and custom ones can be made.
  
''' [[:hpl2:amnesia:config:menu|Menu]] <br /> All the settings related to the menu.
+
{{idea|This can be used as a 2D overlay for displaying images in the game.}}
  
 +
==User==
 +
These files are generated in the documents folder of the OS user. They are generated in subfolders for each full conversion (including the main game).
  
''' [[:hpl2:amnesia:config:pre_menu|Pre_menu]] <br /> Contains all of the settings for the pre-menu (that pops up before the menu).
+
*<code>main_settings.cfg</code> - Stores graphical settings and other settings pertaining to the entire program.
 +
*<code>user_keys.cfg</code> - Stores control settings, per user profile
 +
*<code>user_settings.cfg</code> - Stores profile-specific things
  
 +
See [[HPL2/Development_Environment|how to set up development environment]] for some additional information.
  
''' [[:hpl2:amnesia:config:demo|Demo]] <br /> Demo specific settings. Only loaded if the demo version of the exe is used.
+
==Editor==
 +
The editors come with their own set of config files. Asides from e.g. custom colors, altering these doesn't have much purpose, as doing so won't work in the game (e.g. Area types are hardcoded into the executable).
 +
 
 +
==Launcher==
 +
Default settings and a list of compatible graphics cards. Altering these is advised against.

Latest revision as of 08:16, 23 November 2024

Config Files

To do: Move this to a more appropriate link

What follows is a list of all the config files that are a part of HPL2. All of them can be used in a full conversion to alter the game.

Main configuration

The following config files are a part of the main config folder.

Main init
Handles all of the major settings for the game, like setting up the name of game, save directory and what config files to use.
Game
Contains all game related settings.
Menu
All the settings related to the menu.
Pre-menu
Contains all of the settings for the pre-menu (that pops up before the menu).
Demo
Demo specific settings. Only loaded if the demo version of the exe is used.

Resources

resources.cfg is a file which lists all of the folders that Amnesia.exe searches for assets. In case of file name collisions, they are prioritised in the order of this list.

Icon idea.png Idea: This file can be used to overwrite files during runtime without changing them. The files need to be copied into a new folder and altered there. Then, the folder has to be put on top of the list.

Materials

materials.cfg is a file which lists all physical materials available in the game and the editors. Each material in the file contains its physics parameters, the sounds it makes (steps, impact, scrape, sometimes also roll) and the particles produced when the material is hit.

Icon idea.png Idea: This file can be used to create custom surface materials (Machine For Pigs added a lot of them) or alter the step sounds (this was done in Justine).

Insanity events

misc/main_sanity_events.cfg contains the insanity events which can occur in the game. They can be organised into categories, and custom ones can be made.

Icon idea.png Idea: This can be used as a 2D overlay for displaying images in the game.

User

These files are generated in the documents folder of the OS user. They are generated in subfolders for each full conversion (including the main game).

  • main_settings.cfg - Stores graphical settings and other settings pertaining to the entire program.
  • user_keys.cfg - Stores control settings, per user profile
  • user_settings.cfg - Stores profile-specific things

See how to set up development environment for some additional information.

Editor

The editors come with their own set of config files. Asides from e.g. custom colors, altering these doesn't have much purpose, as doing so won't work in the game (e.g. Area types are hardcoded into the executable).

Launcher

Default settings and a list of compatible graphics cards. Altering these is advised against.