DragonEngine

DragonEngine is a C++, code-first, thin and lightweight Vulkan 3D game engine designed for gaming, AR, and VR. It is designed to keep functions tucked away when you don't need them and provide access to the APIs beneath it when you do.

Documentation

• The authoritative source of HTML documentation can be found here along with some example usage.
• Documentation can be generated locally using Doxygen.
• GitHub Issues is a good way to ask questions.

SDK Structure

 - docs/                             Doxygen build scripts for Dragon
 - external/
      - boost/                       The required Boost packages are found here
      - glfw/                        GLFW submodule for the window
 - include/dragon/                   Dragon Headers for the main library.
 - src/                              C++ Source for Dragon
 - tools/                            Useful scripts not built into the library binary
      - cmake/                       Files and scripts for CMake to find Dragon
           - FindDragon.cmake     !! CMake script that gets placed in your CMake modules directory !!
      - installer/                   Installer source code
      - tests/                       Assorted tests from Dragon

Build Dependencies

Several libraries are required for DragonEngine to be built on your computer.

Required Dependencies

• Vulkan: Dragon requires a version of Vulkan 1, and supports up to Vulkan 1.3, tested up to Vulkan 1.2.

Optional Dependencies

• OpenXR: Dragon's XR capability extension module requires OpenXR to support AR and VR capabilities. If OpenXR is not found at compile time/install time, the engine will not use it. Currently, OpenXR is not production-ready, so the engine will not use it until an official version is released by Khronos.

Test and Documentation Dependencies

• Doxygen: Doxygen is required when building the documentation for Dragon.

Using Dragon

Dragon uses CMake to build, and provides a FindDragon.cmake file to easily include Dragon into your project. If needed, Dragon can be added as a subdirectory in your project.

Building From Source

Dragon will reconfigure its entire structure after finalizing all of the targets in Dragon. By default, this value is "C:\DragonSDK" on Windows, "~/usr/local/libdragon-dev" on Linux, and "/Applications/DragonSDK" on MacOS. Using CMake, add

cmake -DDragon_INSTALL_DIR:String=${PREFERRED_INSTALL}
cmake --build

Minimal CMake Example with Binaries

find_package(Dragon REQUIRED)
add_executable(MyApp main.cpp)
target_include_directories(MyApp PUBLIC ${Dragon_INCLUDE_DIR})
target_link_libraries(MyApp PUBLIC ${Dragon_LINK_LIBRARIES})

CMake Example with Dragon as a subdirectory

add_subdirectory(external/dragon)
add_executable(MyApp main.cpp)
target_include_directories(MyApp PUBLIC ${Dragon_INCLUDE_DIR})
target_link_libraries(MyApp PUBLIC Dragon::Dragon)

IMPORTANT NOTE

Building Dragon from Source, or using the installer, will automatically attempt to add "FindDragon.cmake" to your CMake modules. Downloading a precompiled source package WILL NOT add this file. You will have to manually move it to your CMake modules path.