Cairn

    Installation

    Not available yet

    The repository is private for now, so you cannot clone, build or try the engine yet. It will be open source soon. The steps below are how it will work then.

    The engine is built from source with CMake.

    Requirements

    • CMake 3.25 or newer
    • Ninja
    • A C++20 compiler (Clang, GCC or MSVC)
    • A Vulkan loader and the glslc shader compiler

    On Windows and macOS the Vulkan SDK supplies the loader and glslc, and MoltenVK on macOS. On Linux, install your distribution's Vulkan loader and shaderc packages.

    Build

    git clone https://github.com/Abdulkader-Safi/Cairn-Game-Engine.git
cd Cairn-Game-Engine
cmake -S . -B build -G Ninja
cmake --build build

    The first build downloads every dependency at a pinned version, which takes a few minutes. Nothing has to be installed by hand.

    Every build ends by running the unit tests. A failing test fails the build.

    What the build makes

    ProgramPathWhat it is
    Editorbuild/Cairn-Editor/Cairn-EditorMake and edit projects
    Runtimebuild/Cairn-Runtime/Cairn-RuntimePlay a project, and the program an exported game is made from
    CLIbuild/Cairn-CLI/Cairn-CLISend commands to a running editor
    Testsbuild/Tests/Cairn-TestsUnit tests

    Check that it works

    Run a sample game:

    ./build/Cairn-Runtime/Cairn-Runtime Samples/CoinRun/Game/Game.cairnproject

    Walk with W A S D, jump with Space, look around with the mouse. Escape gives the mouse back.

    Run every test, including the ones that need a GPU:

    ctest --test-dir build --output-on-failure
    Warning

    Only macOS is verified. On Windows and Linux, expect compile errors in the few platform-specific files (the crash handler, sockets and the executable path lookup) until someone has built there.