/Light

Modular game engine

Primary LanguageC++GNU General Public License v3.0GPL-3.0

Light

"An idiot admires complexity, a genius admires simplicity."

-Terry A. Davis

License: GPL v3 Conventional Commits

What's all this?

Light Engine is a data-driven and highly-modularized game engine written in modern C++

Development Guideline

⚠️ Waiting for C++ modules to have better support ⚠️

Trello Board

Commit syntax follows the conventional commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit types:

  • feat: Changes that add a new feature
  • fix: Changes that fix a bug
  • refactor: Changes that improve the code quality (readablity/performance/extensibility/etc)
  • style: Code changes that don't affect the compiled code
  • docs: Changes to the documentations
  • asset: Changes to the assets

Branches:

  • main: main development branch

Getting started:

git clone --recurse-submodules 'git@github.com:light7734/light'
cd light
cmake -S . -B Build -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=DEBUG
ln -sf ./Build ./
cmake --build Build -j`nproc`
./Build/bin/Light

# Or in one command

git clone --recurse-submodules 'git@github.com:light7734/light' &&\
cd light &&\
cmake -S . -B Build -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=DEBUG &&\
ln -sf ./Build ./ &&\
cmake --build Build -j`nproc` &&\
./Build/bin/Light