|
|
| (32 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | {{wip}}
| + | <div style="text-align:center;"> |
| | + | '''Welcome to the HPL3 documentation hub.'''<br>Here you can find extensive documentation about the engine and the games below, including downloads for various tools and tutorials on how to create your own mods. |
| | + | </div> |
| | | | |
| − | Welcome to the HPL3 documentation hub. Here you can find documentation about the different iterations of the engine. HPL3 was used to create SOMA, and an upgraded iteration of the engine was used to create Amnesia: Rebirth.
| + | {{note|Because the engine versions depend on their respective games a lot, the engine documentation differ for each game. And so, documentation for each version can be found under each game, respectively.}} |
| | | | |
| − | Both versions differ from each other in some aspects, and so documentation on each engine iteration can be found under each game.<div style="text-align:center;"> | + | <div style="text-align:center;"> |
| − | <p style="margin:1em auto 0; text-align:center; width:400px;">[[File:hpl3 logo.png|150px|link=|Source]]</p> | + | <p style="margin:1em auto 0; text-align:center; width:400px;">[[File:hpl3 logo.png|250px|link=|HPL3]]</p> |
| − | <p style="margin:1em;">'''[[Hpl3:Community:hpl3 legacy editors|Download and Installation]] | [[Hpl3:Game:faq|Frequently Asked Questions]]'''</p> | + | <p style="margin:1em;">'''[[Hpl3:Community:hpl3 legacy editors|Development Tools]] | [[HPL3/Troubleshooting|Troubleshooting]] | [[HPL3/Features Overview|Features Overview]]'''</p> |
| | | | |
| | ----- | | ----- |
| | | | |
| | <gallery mode="nolines" widths="250" heights="250"> | | <gallery mode="nolines" widths="250" heights="250"> |
| − | File:Soma-header.jpg|[[HPL3:SOMA/Contents|'''SOMA documentation index''']] | + | File:Soma-header.jpg|[[HPL3/SOMA|'''SOMA documentation index''']]|link=HPL3/SOMA |
| − | File:Rebirth-header.jpg|[[HPL3:Rebirth/Contents|'''Amnesia: Rebirth documentation index''']] | + | File:Rebirth-header.jpg|[[HPL3/Amnesia: Rebirth|'''Amnesia: Rebirth documentation index''']]|link=HPL3/Amnesia: Rebirth |
| | </gallery> | | </gallery> |
| − | <div> | + | </div> |
| − | | |
| − | | |
| − | =HPL3 Documentation=
| |
| − | | |
| − | ==Engine==
| |
| − | | |
| − | [[:hpl3:engine:rendering|Rendering]] <br />Overview of the different rendering techniques that happens.
| |
| − | | |
| − | [[:hpl3:engine:materials|Materials]] <br />Detailed information on the different material that can be used.
| |
| − | | |
| − | [[:hpl3:engine:static_objects|Static Objects]] <br />Some information specific to static objects that are used to build the base geometry of the levels.
| |
| − | | |
| − | [[:hpl3:engine:entities|Entities]] <br />Information regarding entities, which is used for all the interactive and dynamic objects in the world.
| |
| − | | |
| − | [[:hpl3:engine:terrain|Terrain]] <br />Terrain is quite different from other parts and require some special explanations.
| |
| − | | |
| − | [[:hpl3:engine:script|Script]] <br />Scripting is a big part of the engine and meant to implement most of the game related things.
| |
| − | | |
| − | [[:hpl3:engine:optimizations|Optimizations]] <br />This part discusses various important optimizations.
| |
| − | | |
| − | [[:hpl3:engine:model_export|Model Export]] <br />How to properly export models from various programs.
| |
| − | | |
| − | [[:hpl3:engine:sound|Sound]] <br />How the sound system functions and on the needs of assets.
| |
| − | | |
| − | ==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:particleeditor|Particle Editor]] <br />Used to create particle systems.
| |
| − | | |
| − | [[:hpl3:tools:materialeditor|Material Editor]] <br />Create the material files for models with this tool.
| |
| − | | |
| − | [[:hpl3:tools:modelviewer|Model Viewer]] <br />The model viewer is used to generate material files and view created models.
| |
| − | | |
| − | [[:hpl3:tools:mapviewer|Map Viewer]] <br />A tool for easy viewing of map files. Also good for optimization.
| |
| − | | |
| − | ==Game==
| |
| − | | |
| − | [[:hpl3:game:setup|Setup]] <br />Before doing anything, you need to know how to set things up!
| |
| − | | |
| − | [[:hpl3:game:dev_features|Dev Features]] <br />Goes through some of the development specific stuff that can be done in-game.
| |
| − | | |
| − | [[:hpl3:game:commandline|Commandline]] <br />What different commands can be used in the command line.
| |
| − | | |
| − | [[:hpl3:game:entity_types|Entity types]] <br />The different basic entity types that are in the game.
| |
| − | | |
| − | [[:hpl3:game:scripting|Scripting]] <br />Game specific information on the scripting.
| |
| − | | |
| − | [[:hpl3:game:gui|Gui]] <br />The way the gui works and how it integrates into the game.
| |
| − | | |
| − | [[:hpl3:game:eventdb|Event Database]] <br />How the game handles the event database.
| |
| − | | |
| − | [[:hpl3:game:voicehandler|Voice Handler]] <br />The voice handler system used to handle, you guess it, voices.
| |
| − | | |
| − | [[:hpl3:game:dialoghandler|Dialog Handler]] <br />A higher level system that creates dialogs using functionality from the Voice Handler.
| |
| − | | |
| − | [[:hpl3:game:soundscapearea|Soundscape Area]] <br />This is a special type of area that needs some explanation.
| |
| − | | |
| − | [[:hpl3:game:guides|Guides]] <br />A couple of guides with important information on some subjects.
| |
| − | | |
| − | ==Tutorials==
| |
| − | | |
| − | [[:hpl3:tutorials:texture_dds_export|DDS Texture Export]] <br />A tutorial on how to export a texture using the Nvidia textureTools
| |
| − | | |
| − | [[:hpl3:tutorials:material_translucent|Translucent Material]] <br />Here is explained how to create a translucent material.
| |
| − | | |
| − | [[:hpl3:tutorials:basic_modeling|Basic Modeling]] <br />The basics on modelling.
| |
| − | | |
| − | ==3rd Party Tools==
| |
| − | | |
| − | [[:hpl3:3rdparty:codelite|CodeLite Script Editor]] <br />Basic info on using CodeLite as a script editor for Angel Script.
| |
| | | | |
| | [[Category:Entry pages]] | | [[Category:Entry pages]] |
| | + | [[Category:English]] |
| | | | |
| | __NOTOC____NOEDITSECTION__ | | __NOTOC____NOEDITSECTION__ |
Because the engine versions depend on their respective games a lot, the engine documentation differ for each game. And so, documentation for each version can be found under each game, respectively.
