Cyclecs Engine

A custom game engine written in C (C17) which uses a custom ECS architecture for game objects and logic. Currently only tested on Linux.

Libraries

• CGLM - 0.9.6 - MIT
• FreeType - 2.14.1 - Custom
• GLFW - 3.4 - Zlib
• Glad 2 - OpenGL 3.3 Core - MIT
• stb_image - 2.30 - MIT
• stb_image_write - 1.16 - MIT

Dependencies

• OpenGL >= 3.3 supported graphics
• CMake >= 3.21
• Wayland or Xorg
• Clang or GCC C17 compiler

Getting and Running

Clone the repository:

git clone https://github.com/jagger-harris/cyclecs.git
cd cyclecs

Debug build:

cmake -S . -B build/debug -DCMAKE_BUILD_TYPE=debug
cmake --build build/debug
./build/debug/executable

Release build:

cmake -S . -B build/release -DCMAKE_BUILD_TYPE=release
cmake --build build/release
./build/release/executable

Building Documentation

For building documentation, you can read how to here.

Contributing

This is a personal project. Contributions will not be accepted as of now.

License

• LGPL 3.0