Differences

This shows you the differences between two versions of the page.

--- documentation:documentation [2012/05/25 12:58] – [Various documents] mhgamework
+++ documentation:documentation [2024/08/26 13:25] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Documentation ======
+====== Features ======
+This section of the wiki contains information about the current **implementation** of The Wizards.  It describes how current features are implemented and designed, and decisions that have been made or rules that should be followed.  This is to ensure stability of the implementation.
-This section of the wiki contains information about the current **implementation** of The Wizards.
-It describes how current features are implemented and designed, and decisions that have been made or rules that should be followed.
-This is to ensure stability of the implementation.
 There is also information about planning and tasks to complete.
-===== Planning =====
+Please follow the CodingGuidelines!
-  * The [[documentation::planning]] page contains the current short term task list to be completed
+More information of how the documentation can be found in HowToDocument
-  * [[documentation:planning:small|]] has minor features that should be implemented but are independent from the rest of development
-  * The [[documentation:planning:todo|]]-list contains any tasks that have to be completed, things to consider, memo's
-  * Info on nasty creatures inside the code is in the [[documentation:bugs|]]-page
-===== Overall design =====
+A list of ready to be implemented features can be found here ReadyToImplementFeatures.
-  * [[documentation::appoverview]] describes the Application-Logic paradigm used in The Wizards.
-  * Storage of data is described in the [[documentation:datasystem|]]
-===== Modules =====
+===== Features =====
-Following pages describe the different modules in The Wizards
-  * [[documentation:animation:animation|]]
+This section lists all the features present in the code. This should contain very short summaries, more information can be optained on the specific pages for each feature.
-  * [[documentation:terrain|]]
-  * [[documentation:vegetation|]]
-  * [[documentation:rendering|]]
-  * [[documentation:particle_engine|]]
-  * [[documentation:objimporter|]]
-  * [[documentation:classform]]
-  * [[documentation:physics]]
-  * [[documentation:networking]]
-  * [[documentation:dx11|]]
-  * [[documentation:graphics|]]
-  * [[documentation:core|]]
-  * [[documentation:tileengine]]
-  * [[documentation:entity]]
-===== Various documents =====
-  * [[documentation:codegeneration|]]
-  * [[documentation:debughelper|]]
-  * [[documentation:maxscript|]]
-  * [[documentation:colladaschema|]]
-  * [[documentation:voxelengine|]]
-  * [[documentation:anaglyph3d|]]
+    * **[[:documentation:thewizardsengine|TheWizardsEngine]]** Tools and utilities for hosting and developing gameplay code
+    * **[[:documentation:renderingframework|RenderingFramework]]** Custom written rendering engine
+    * **[[:documentation:aisystem|AiSystem]]** Artificial intelligence related features
+    * **[[:documentation:mathlibrary|MathLibrary]]** Mathematical helpers and algorithms
+    * **[[:documentation:proceduralgeneration|ProceduralGeneration]]** Procedural asset/content generation
+    * **[[:documentation:physics|Physics]]** Realtime Physics simulation using Nvidia [[:documentation:physx|PhysX]]
+    * **[[:documentation:rtstestcase|RtsTestcase]]** The first testcase, featuring a RTS gameplay
+    * **[[:documentation:questtestcase|QuestTestcase]]** The second testcase, featuring a example quest
-  * [[documentation:rendering:deferred_rendering|]]
+Now begins the unorganized stuffs!
-  * [[documentation:rendering:fxaa|]]
+\\
-  * [[documentation:rendering:hdr|]]
+\\
-  * [[documentation:rendering:occlusionculling|]]
+\\
-  * [[documentation:rendering:ssao|]]
+\\
+===== Planning =====
+    * The [[:documentation:planning|Planning]] page contains the current short term task list to be completed
+    * [[:documentation:planning:small|Small tasks]] has minor features that should be implemented but are independent from the rest of development
+    * The [[:documentation:planning:todo|TODO]]-list contains any tasks that have to be completed, things to consider, memo's
+    * Info on nasty creatures inside the code is in the [[:documentation:bugs|Bugs]]-page
-  * [[documentation:terrain:hydrolic_errosion_and_river_creation|]]
-  * [[documentation:terrain:procedural_terraingeneration|]]
-  * [[documentation:terrain:procedural_terraingeneration:islandgeneration|]]
-  * [[documentation:terrain:procedural_terraingeneration:noise|]]
-  * [[documentation:vegetation:grass|]]
-  * [[documentation:vegetation:treeengine|]]
-  * [[documentation:ai|]]
+===== Overall design =====
-  * [[documentation:anaglyph3d|]]
-  * [[documentation:appoverview|]]
-  * [[documentation:bugs|]]
-  * [[documentation:codegeneration|]]
-  * [[documentation:colladaschema|]]
-  * [[documentation:core|]]
-  * [[documentation:datasystem|]]
-  * [[documentation:debughelper|]]
-  * [[documentation:documentation|]]
-  * [[documentation:dx11|]]
-  * [[documentation:entity|]]
-  * [[documentation:graphics|]]
-  * [[documentation:maxscript|]]
-  * [[documentation:objimporter|]]
-  * [[documentation:particle_engine|]]
-  * [[documentation:physics|]]
-  * [[documentation:planning|]]
-  * [[documentation:rendering|]]
-  * [[documentation:terrain|]]
-  * [[documentation:tileengine|]]
-  * [[documentation:vegetation|]]
-  * [[documentation:voxelengine|]]
+    * [[:documentation:appoverview|Application overview]] describes the Application-Logic paradigm used in The Wizards.
+    * Storage of data is described in the [[:documentation:datasystem|Data System]]
+===== Modules =====
+Following pages describe the different modules in The Wizards
+    * [[:documentation:animation:animation|Animation]]
+    * [[:documentation:terrain|Terrain]]
+    * [[:documentation:vegetation|Vegetation]]
+    * [[:documentation:rendering|Rendering]]
+    * [[:documentation:particle_engine|Particle Engine]]
+    * [[:documentation:classform|classform]]
+    * [[:documentation:networking|networking]]
+    * [[:documentation:dx11|DirectX 11]]
+    * [[:documentation:core|Core]]
+    * [[:documentation:tileengine|Tile Engine]]
+    * [[:documentation:entity|Entity]]
+===== Various documents =====
+    * [[:documentation:codegeneration|Code Generation]]
+    * [[:documentation:debughelper|Debug Helper]]
+    * [[:documentation:maxscript|Maxscript]]
+    * [[:documentation:colladaschema|ColladaSchema]]
+    * [[:documentation:voxelengine|Voxel Engine]]
+    * [[:documentation:anaglyph3d|Anaglyph3D]]
+    * [[:documentation:rendering:deferred_rendering|Deferred Rendering]]
+    * [[:documentation:rendering:fxaa|FXAA]]
+    * [[:documentation:rendering:hdr|High Dynamic Range Rendering]]
+    * [[:documentation:rendering:occlusionculling|Occlusion culling]]
+    * [[:documentation:rendering:ssao|Screen Space Ambient Occlusion (SSAO)]]
+    * [[:documentation:ai|AI]]
+    * [[:documentation:anaglyph3d|Anaglyph3D]]
+    * [[:documentation:appoverview|Application overview]]
+    * [[:documentation:bugs|Bugs]]
+    * [[:documentation:codegeneration|Code Generation]]
+    * [[:documentation:colladaschema|ColladaSchema]]
+    * [[:documentation:core|Core]]
+    * [[:documentation:datasystem|Data System]]
+    * [[:documentation:debughelper|Debug Helper]]
+    * [[:documentation:documentation|Documentation]]
+    * [[:documentation:dx11|DirectX 11]]
+    * [[:documentation:entity|Entity]]
+    * [[:documentation:graphics|Graphics]]
+    * [[:documentation:maxscript|Maxscript]]
+    * [[:documentation:objimporter|OBJ Importer]]
+    * [[:documentation:particle_engine|Particle Engine]]
+    * [[:documentation:physics|Physics]]
+    * [[:documentation:planning|Planning]]
+    * [[:documentation:rendering|Rendering]]
+    * [[:documentation:terrain|Terrain]]
+    * [[:documentation:tileengine|Tile Engine]]
+    * [[:documentation:vegetation|Vegetation]]
+    * [[:documentation:voxelengine|Voxel Engine]]