Skip to content

DougTanner/BrokenEnginePublic

Repository files navigation

Broken Teapot Studios - Broken Engine

License: MIT Language

Broken Engine is an open source C++20 Vulkan game engine for Windows. It uses data-oriented design, scalable parallelism, and a pre-compiled Vulkan command buffer for efficient CPU usage. The included Data Packer pre-processes files; pre-compiling shaders, packing .gltf and .obj files into efficient vertex buffers, re-encoding images files into BC4 and BC7 compressed textures, and processing .wav files into ADPCM audio.

The game Kinetic Storm runs on Broken Engine and is currently in Early Access on Steam: https://store.steampowered.com/app/2154430/Kinetic_Storm/?utm_source=github

Prerequisites

Git

  • Repository should be cloned with --recurse-submodules
    • Or use "git submodule init" & "git submodule update" after cloning

Compile

  • You can verify that everything is set up correctly by opening BrokenEnginePublic/DataPacker/Platforms/VisualStudio2022/DataPacker.sln

    • Compile it in Release
  • Open BrokenEnginePublic/Projects/BrokenEngineSandbox/Platforms/VisualStudio2022/BrokenEngineSandbox.sln

    • Build in either Debug or Profile or Release (Build -> Build Solution)
      • The first time you compile, a pre-build event will build the Data Packer at BrokenEnginePublic/DataPacker/Platforms/VisualStudio2022/Output/DataPacker.exe
      • Any time data is changed, a pre-build event will run the Data Packer to export and package the data to BrokenEngineSandbox/Platforms/VisualStudio2022/Output/Data.bin
    • Run with Visual Studio (Debug -> Start Debugging)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published