diff options
Diffstat (limited to 'src/doc/features.dox')
-rw-r--r-- | src/doc/features.dox | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/src/doc/features.dox b/src/doc/features.dox new file mode 100644 index 0000000..56d17c7 --- /dev/null +++ b/src/doc/features.dox @@ -0,0 +1,69 @@ +// vim:ft=doxygen +/** + +\htmlonly +<style> +table.memberdecls, +.groupheader +{ display: none; } +ul, +li +{ margin: 1ex 0pt; } +</style> +\endhtmlonly + +\defgroup feature Features +\brief Engine components + +This page lists engine features and contains usage instructions for each +feature. + +- Basics + - \todo Hello world / engine initialization + + - \ref feature_config \n\copybrief feature_config + +- Scenes + - \ref feature_scene \n\copybrief feature_scene + - \todo Navigating between scenes + +- Input + - \todo Key/Mouse events (w/ Script) + +- 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 + +*/ |