Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 932 Bytes

README.md

File metadata and controls

44 lines (32 loc) · 932 Bytes

🐫🎮 camlcade

Warning

Still in development. Not ready for production.

camlcade is an OCaml game engine. It features an archetype-based entity-component system (ECS) and an OpenGL-based renderer.

Features

  • Archetype storage
  • Composable plugins
  • User-defined GLSL shaders
  • Custom meshes

Examples

To see how to use camlcade, see examples/.

Run an example with:

# Runs the "shapes" example
dune exec shapes

Development

Project Structure

lib
├── ecs       # Entity-component system
├── graphics  # OpenGL-based renderer
├── input     # Input and event handling
├── math      # Math utilities
├── storage   # Sparse storage
└── transform # Transform component

Quick Start

  • Build: dune build
  • Test: dune test
  • Benchmark: dune exec bench
  • Documentation: dune build @doc (see _build/default/_doc/_html/index.html)