aboutsummaryrefslogtreecommitdiff
path: root/src/doc/features.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2025-01-11 22:07:17 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2025-01-11 22:07:17 +0100
commitcc8add56f9b8f0a32e7ab35a63454fed81eaacba (patch)
treee765a71b4a9b8798d99873fdcaf9487bc8f2954e /src/doc/features.dox
parentb6609ecd6636e65db76eb11617923222921d52d2 (diff)
parentf06be6004ec8b47e3b4b1ba4fda068b365923683 (diff)
Merge branch 'loek/doxygen'
Diffstat (limited to 'src/doc/features.dox')
-rw-r--r--src/doc/features.dox55
1 files changed, 48 insertions, 7 deletions
diff --git a/src/doc/features.dox b/src/doc/features.dox
index 21a040a..56d17c7 100644
--- a/src/doc/features.dox
+++ b/src/doc/features.dox
@@ -3,8 +3,12 @@
\htmlonly
<style>
-table.memberdecls { display: none; }
-ul { margin: 1ex 0pt; }
+table.memberdecls,
+.groupheader
+{ display: none; }
+ul,
+li
+{ margin: 1ex 0pt; }
</style>
\endhtmlonly
@@ -14,15 +18,52 @@ ul { margin: 1ex 0pt; }
This page lists engine features and contains usage instructions for each
feature.
-\par Features
+- Basics
+ - \todo Hello world / engine initialization
-- Scripting
- - \ref feature_script \n\copybrief feature_script
+ - \ref feature_config \n\copybrief feature_config
-- Game flow management
+- Scenes
- \ref feature_scene \n\copybrief feature_scene
+ - \todo Navigating between scenes
+
+- Input
+ - \todo Key/Mouse events (w/ Script)
-- Entity
+- Actors / game objects
- \ref feature_gameobject \n\copybrief feature_gameobject
+- \todo HUD
+
+- Animation
+ - \todo Animation using spritesheet
+
+ - \todo Particle effects
+
+- Save data
+ - \ref feature_savemgr \n\copybrief feature_savemgr
+
+- Audio
+ - \ref feature_sfx \n\copybrief feature_sfx
+ - \ref feature_bgm \n\copybrief feature_bgm
+
+- \todo AI
+
+- \todo Physics
+
+- Scripting
+ - \ref feature_script \n\copybrief feature_script
+ - \ref feature_script_ecs \n\copybrief feature_script_ecs
+
+ - \todo Subscribing to *any* event inside Script
+
+ - \todo Creating and dispatching custom events
+
+- \todo Replay
+
+- Utilities
+ - \todo Logging
+
+ - \ref feature_proxy \n\copybrief feature_proxy
+
*/