This is still heavily in development so some commits will be stupid, commit history may be rewritten and there is no API stability at all.

The engine uses C++17 features such as std::filesystem and std::variant, and therefore requires a fairly recent compiler.

The following libraries are currently used by the engine:

• assimp
• Bullet3
• GLEW
• GLM
• imgui
• ImGuizmo
• moodycamel::ConcurrentQueue
• nlohmann::json
• SDL
• SDL_GameControllerDB
• shaderc
• stb
• tinyobjloader

These are all cloned into the Source/ThirdParty directory using git submodules and then built together with the engine. This means that the first build after cloning will be slow because all these libraries need to be built.

When it comes to graphics APIs, the engine currently targets:

• Vulkan 1.0
• OpenGL 4.6

You must have the following installed in order to build:

• CMake >= 3.16
• Python >= 3.11

1. Clone the project: git clone https://github.com/JackBister/VK2D.git
2. Enter the directory: cd VK2D
3. Download dependencies: git submodule update --init
4. Create the build directory: mkdir build
5. Enter the build directory: cd build
6. Run CMake to generate project files, in this case using Visual Studio: cmake -G "Visual Studio 17 2022" -A x64
7. Run the build: msbuild ALL_BUILD.vcxproj