diff options
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..54d6383 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,42 @@ +# Welcome to Celeritas + +Welcome to the Celeritas Game Engine's documentation! + +## What is it? + +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. I will be providing ocaml bindings to the C API but implementing Lua bindings for example +would be fairly trivial. + +**What does 'celeritas' mean?** + +Celerity is an English word meaning "alacrity" "swiftness". +Celeritas is the original Latin word for celerity that the English is derived from. + +## Feature Set + +**Implemented (core)** + +* 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 + +**In-progress** + +* Skeletal animation + +**Roadmap going forwards** + +* Collision detection +* Terrain rendering +* GPU-driven rendering + +## Getting started + +Check these pages out + +* [Getting started](getting-started.md) +* [Project layout](project-layout.md)
\ No newline at end of file |