Difference between revisions of "HPL3"

From Frictional Wiki
Jump to navigation Jump to search
m
m (Link names)
Line 5: Line 5:
 
-----
 
-----
  
<gallery mode=nolines widths=250px heights=250px>
+
<gallery mode="nolines" widths="250" heights="250">
File:soma-header.jpg|a link to [[HPL3:SOMA/Contents]]
+
File:Soma-header.jpg|[[HPL3:SOMA/Contents|SOMA]] documentation index
File:rebirth-header.jpg|a link to [[HPL3:Rebirth/Contents]]
+
File:Rebirth-header.jpg|[[HPL3:Rebirth/Contents|Amnesia: Rebirth]] documentation index
 
</gallery>
 
</gallery>
 
<div>
 
<div>
  
  
= HPL3 Documentation =
+
=HPL3 Documentation=
  
== Engine ==
+
==Engine==
  
 
[[:hpl3:engine:rendering|Rendering]] <br />Overview of the different rendering techniques that happens.
 
[[:hpl3:engine:rendering|Rendering]] <br />Overview of the different rendering techniques that happens.
Line 34: Line 34:
 
[[:hpl3:engine:sound|Sound]] <br />How the sound system functions and on the needs of assets.
 
[[:hpl3:engine:sound|Sound]] <br />How the sound system functions and on the needs of assets.
  
== Tools ==
+
==Tools==
  
 
[[:hpl3:tools:maineditors|Main Editors]] <br />The main editor tools are the LevelEditor and the ModelEditor. Here is indepth information on these.
 
[[:hpl3:tools:maineditors|Main Editors]] <br />The main editor tools are the LevelEditor and the ModelEditor. Here is indepth information on these.
Line 46: Line 46:
 
[[:hpl3:tools:mapviewer|Map Viewer]] <br />A tool for easy viewing of map files. Also good for optimization.
 
[[:hpl3:tools:mapviewer|Map Viewer]] <br />A tool for easy viewing of map files. Also good for optimization.
  
== Game ==
+
==Game==
  
 
[[:hpl3:game:setup|Setup]] <br />Before doing anything, you need to know how to set things up!
 
[[:hpl3:game:setup|Setup]] <br />Before doing anything, you need to know how to set things up!
Line 72: Line 72:
 
[[:hpl3:game:faq|FAQ]] <br />Frequently asked question about anything to do with the game and engine.
 
[[:hpl3:game:faq|FAQ]] <br />Frequently asked question about anything to do with the game and engine.
  
== Tutorials ==
+
==Tutorials==
  
 
[[:hpl3:tutorials:texture_dds_export|DDS Texture Export]] <br />A tutorial on how to export a texture using the Nvidia textureTools
 
[[:hpl3:tutorials:texture_dds_export|DDS Texture Export]] <br />A tutorial on how to export a texture using the Nvidia textureTools
Line 80: Line 80:
 
[[:hpl3:tutorials:basic_modeling|Basic Modeling]] <br />The basics on modelling.
 
[[:hpl3:tutorials:basic_modeling|Basic Modeling]] <br />The basics on modelling.
  
== 3rd Party Tools ==
+
==3rd Party Tools==
  
 
[[:hpl3:3rdparty:codelite|CodeLite Script Editor]] <br />Basic info on using CodeLite as a script editor for Angel Script.
 
[[:hpl3:3rdparty:codelite|CodeLite Script Editor]] <br />Basic info on using CodeLite as a script editor for Angel Script.
  
[[Category:Entry pages]]__NOTOC____NOEDITSECTION__
+
[[Category:Entry pages]]
 +
__NOTOC____NOEDITSECTION__

Revision as of 22:25, 22 July 2020

Source

Download and Installation



HPL3 Documentation

Engine

Rendering
Overview of the different rendering techniques that happens.

Materials
Detailed information on the different material that can be used.

Static Objects
Some information specific to static objects that are used to build the base geometry of the levels.

Entities
Information regarding entities, which is used for all the interactive and dynamic objects in the world.

Terrain
Terrain is quite different from other parts and require some special explanations.

Script
Scripting is a big part of the engine and meant to implement most of the game related things.

Optimizations
This part discusses various important optimizations.

Model Export
How to properly export models from various programs.

Sound
How the sound system functions and on the needs of assets.

Tools

Main Editors
The main editor tools are the LevelEditor and the ModelEditor. Here is indepth information on these.

Particle Editor
Used to create particle systems.

Material Editor
Create the material files for models with this tool.

Model Viewer
The model viewer is used to generate material files and view created models.

Map Viewer
A tool for easy viewing of map files. Also good for optimization.

Game

Setup
Before doing anything, you need to know how to set things up!

Dev Features
Goes through some of the development specific stuff that can be done in-game.

Commandline
What different commands can be used in the command line.

Entity types
The different basic entity types that are in the game.

Scripting
Game specific information on the scripting.

Gui
The way the gui works and how it integrates into the game.

Event Database
How the game handles the event database.

Voice Handler
The voice handler system used to handle, you guess it, voices.

Dialog Handler
A higher level system that creates dialogs using functionality from the Voice Handler.

Soundscape Area
This is a special type of area that needs some explanation.

Guides
A couple of guides with important information on some subjects.

FAQ
Frequently asked question about anything to do with the game and engine.

Tutorials

DDS Texture Export
A tutorial on how to export a texture using the Nvidia textureTools

Translucent Material
Here is explained how to create a translucent material.

Basic Modeling
The basics on modelling.

3rd Party Tools

CodeLite Script Editor
Basic info on using CodeLite as a script editor for Angel Script.