README.md

Segfault

Build status

Build instructions

• Prerequisites:
  • Vulkan SDK
  • Python 3.11
  • Make sure that glslc from the SDK is in your PATH
• Clone the engine code with all submodules:

git clone --recursive https://github.com/kimkulling/Segfault.git

• Go to the directory and run cmake:

cd SegFault
cmake CMakeLists.txt --preset=default

• Compile the shader

cd scripts
python compile_shader.py

• Run the first application on Windows:

cd bin\<config>
.\hello_world.exe

• Run the first application on Linux:

cd bin
./hello_world.exe

Roadmap for Version 0.0.1

• Core Concepts
  • Define base architecture
  • Define CMake-Build
  • Windows Management
    • Windows creation
    • Base handling of events
  • Rendering
    • Define vulkan renderer
      • Base concept
      • Textures
      • Model loading
    • Define render thread
      • Define render graph concept
  • Assets
    • Define asset structure
  • Editor
    • Simple UI
• Game
  • Start with Legends of War -> April 2026