ck-engine

A learning-oriented 2D game engine, following the game engine series by TheCherno.

WIP: docs

Quickstart

Prerequisites

• C++20 compiler (clang, gcc, MSVC, etc.)
• CMake 3.24+
• Git

MSYS2 UCRT64 setup (Windows)

Install MSYS2, then open UCRT64 terminal and run:

pacman -S --needed \
  mingw-w64-ucrt-x86_64-cmake \
  mingw-w64-ucrt-x86_64-clang \
  mingw-w64-ucrt-x86_64-make \
  mingw-w64-ucrt-x86_64-gdb \
  git

Build & Run

git clone --recursive https://github.com/qiekn/ck-engine.git
cd ck-engine

MSYS2 UCRT64 Terminal:

./run.sh

PowerShell:

.\run.ps1

The script will automatically configure the CMake build directory on first run, then build and launch the editor.

Commit Convention

mark	description
ep	episode
feat	new feature
add	add third party library
update	make some progress
fix	fix a bug
docs	documents (readme or some comments)
refactor	refactor code
chores	some little changes