diff options
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/index.md b/docs/index.md index f889ee0..54d6383 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,11 +4,12 @@ Welcome to the Celeritas Game Engine's documentation! ## What is it? -Celeritas is a small 3D game engine written in OCaml **and** plain ol' C. +Celeritas is a small 3D game engine written in plain ol' C **and** OCaml. The idea underlying celeritas is to have a small versatile "core" that can then be added to from other languages. This means you could add gameplay systems in OCaml but rely on the celeritas core layer to do all the heavy lifting -when it comes to computation or rendering. +when it comes to computation or rendering. I will be providing ocaml bindings to the C API but implementing Lua bindings for example +would be fairly trivial. **What does 'celeritas' mean?** @@ -17,26 +18,25 @@ Celeritas is the original Latin word for celerity that the English is derived fr ## Feature Set -_(as of Jan 2024)_ +**Implemented (core)** -**Implemented** - -* OpenGL renderer backend! ((*need to port Metal renderer over*)) +* Vulkan & OpenGL renderer backends (*need to port Metal renderer over*) * Basic Blinn-Phong lighting model (*need to port from old project*) -* Task queue for loading mesh and texture data into memory on background threads (*how do we want to do this with OCaml engine?*) +* Task queue for loading mesh and texture data into memory on background threads **In-progress** -* UI system +* Skeletal animation **Roadmap going forwards** -* Skeletal animation +* Collision detection * Terrain rendering +* GPU-driven rendering ## Getting started -Check out these in order +Check these pages out -<!-- * [Getting started](getting-started.md) --> -<!-- * [Project layout](project-layout.md) -->
\ No newline at end of file +* [Getting started](getting-started.md) +* [Project layout](project-layout.md)
\ No newline at end of file |