summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-07-21 15:30:25 +1000
committeromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-07-21 15:30:25 +1000
commit47465948f2a5a85d0882ff116fce095f401d69c1 (patch)
treebfe75ee11c6b1349a33fbd85253037b937cb4559 /docs
parent357b24af4a490eca2757bb8940e08361ada04943 (diff)
docs
Diffstat (limited to 'docs')
-rw-r--r--docs/index.md16
1 files changed, 3 insertions, 13 deletions
diff --git a/docs/index.md b/docs/index.md
index f71d8fe..fd5b8f6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,13 +4,15 @@ 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.
+Celeritas is a small 3D game engine 'framework' 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.
+[Riot Games refers to this](https://technology.riotgames.com/news/future-leagues-engine) as **engine-heavy** vs. **engine-light**; we are strongly in the engine-light category.
+
**What does 'celeritas' mean?**
Celerity is an English word meaning "alacrity" "swiftness".
@@ -18,18 +20,6 @@ Celeritas is the original Latin word for celerity that the English is derived fr
## 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**
-
[See here (README)](https://github.com/omnisci3nce/celeritas-core/blob/winter-cleaning/README.md#todo)
## Getting started