Simple game engine

README.adoc

@@ -26,6 +26,8 @@ It also contains Vulkan usage clarifications, improved synchronization and new c
 The repository is organized into several important directories:
 
 * `en/` - Contains the tutorial content in English, organized by chapters
+** The main tutorial covers fundamental Vulkan concepts (chapters 00-17)
+** The "Building a Simple Engine" section builds upon these fundamentals to create a structured rendering engine
 * `attachments/` - Contains code examples, shader files, and resources used in the tutorial
 * `images/` - Contains illustrations, diagrams, and screenshots used in the tutorial
 * `scripts/` - Contains utility scripts, including dependency installation scripts

antora/modules/ROOT/nav.adoc

@@ -52,4 +52,13 @@
 * xref:15_GLTF_KTX2_Migration.adoc[Migrating to Modern Asset Formats: glTF and KTX2]
 * xref:16_Multiple_Objects.adoc[Rendering Multiple Objects]
 * xref:17_Multithreading.adoc[Multithreading]
+* xref:Building_a_Simple_Engine/introduction.adoc[Building a Simple Engine]
+** xref:Building_a_Simple_Engine/Engine_Architecture/01_introduction.adoc[Engine Architecture]
+** xref:Building_a_Simple_Engine/Camera_Transformations/01_introduction.adoc[Camera Transformations]
+** xref:Building_a_Simple_Engine/Lighting_Materials/01_introduction.adoc[Lighting & Materials]
+** xref:Building_a_Simple_Engine/GUI/01_introduction.adoc[GUI]
+** xref:Building_a_Simple_Engine/Loading_Models/01_introduction.adoc[Loading Models]
+** xref:Building_a_Simple_Engine/Subsystems/01_introduction.adoc[Subsystems]
+** xref:Building_a_Simple_Engine/Tooling/01_introduction.adoc[Tooling]
+** xref:Building_a_Simple_Engine/Mobile_Development/01_introduction.adoc[Mobile Development]
 * xref:90_FAQ.adoc[FAQ]

attachments/simple_engine/CMakeLists.txt

@@ -0,0 +1,208 @@
+cmake_minimum_required(VERSION 3.29)
+
+# Enable C++ module dependency scanning
+set(CMAKE_CXX_SCAN_FOR_MODULES ON)
+
+project(SimpleEngine VERSION 1.0.0 LANGUAGES CXX C)
+
+# Add CMake module path for custom find modules
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../CMake")
+
+# Find required packages
+find_package (glfw3 REQUIRED)
+find_package (glm REQUIRED)
+find_package (Vulkan REQUIRED)
+find_package (tinygltf REQUIRED)
+find_package (KTX REQUIRED)
+find_package (OpenAL REQUIRED)
+
+# set up Vulkan C++ module
+add_library(VulkanCppModule)
+add_library(Vulkan::cppm ALIAS VulkanCppModule)
+
+target_compile_definitions(VulkanCppModule
+        PUBLIC VULKAN_HPP_DISPATCH_LOADER_DYNAMIC=1 VULKAN_HPP_NO_STRUCT_CONSTRUCTORS=1
+)
+target_include_directories(VulkanCppModule
+        PRIVATE
+        "${Vulkan_INCLUDE_DIR}"
+)
+target_link_libraries(VulkanCppModule
+        PUBLIC
+        Vulkan::Vulkan
+)
+
+set_target_properties(VulkanCppModule PROPERTIES CXX_STANDARD 20)
+
+target_sources(VulkanCppModule
+        PUBLIC
+        FILE_SET cxx_modules TYPE CXX_MODULES
+        BASE_DIRS
+        "${Vulkan_INCLUDE_DIR}"
+        FILES
+        "${Vulkan_INCLUDE_DIR}/vulkan/vulkan.cppm"
+)
+
+
+# Add the vulkan.cppm file directly as a source file
+target_sources(VulkanCppModule
+        PRIVATE
+        "${Vulkan_INCLUDE_DIR}/vulkan/vulkan.cppm"
+)
+
+# Platform-specific settings
+if(ANDROID)
+    # Android-specific settings
+    add_definitions(-DPLATFORM_ANDROID)
+else()
+    # Desktop-specific settings
+    add_definitions(-DPLATFORM_DESKTOP)
+endif()
+
+# Shader compilation
+# Find Slang shaders
+file(GLOB SLANG_SHADER_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/shaders/*.slang)
+
+# Find slangc executable (optional)
+find_program(SLANGC_EXECUTABLE slangc HINTS $ENV{VULKAN_SDK}/bin)
+
+if(SLANGC_EXECUTABLE)
+    # Ensure the output directory for compiled shaders exists
+    file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/shaders)
+
+    # Compile Slang shaders using slangc
+    foreach(SHADER ${SLANG_SHADER_SOURCES})
+        get_filename_component(SHADER_NAME ${SHADER} NAME)
+        get_filename_component(SHADER_NAME_WE ${SHADER_NAME} NAME_WE)
+        string(REGEX REPLACE "\.slang$" "" OUTPUT_NAME ${SHADER_NAME})
+        add_custom_command(
+            OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/shaders/${OUTPUT_NAME}.spv
+            COMMAND ${SLANGC_EXECUTABLE} ${SHADER} -target spirv -profile spirv_1_4 -emit-spirv-directly -o ${CMAKE_CURRENT_BINARY_DIR}/shaders/${OUTPUT_NAME}.spv
+            DEPENDS ${SHADER}
+            COMMENT "Compiling Slang shader ${SHADER_NAME} with slangc"
+        )
+        list(APPEND SHADER_SPVS ${CMAKE_CURRENT_BINARY_DIR}/shaders/${OUTPUT_NAME}.spv)
+    endforeach()
+
+    add_custom_target(shaders DEPENDS ${SHADER_SPVS})
+else()
+    message(STATUS "slangc not found. Skipping shader compilation step.")
+    add_custom_target(shaders)
+endif()
+
+# Source files
+set(SOURCES
+    main.cpp
+    engine.cpp
+    scene_loading.cpp
+    platform.cpp
+    renderer_core.cpp
+    renderer_rendering.cpp
+    renderer_pipelines.cpp
+    renderer_compute.cpp
+    renderer_utils.cpp
+    renderer_resources.cpp
+    memory_pool.cpp
+    resource_manager.cpp
+    entity.cpp
+    component.cpp
+    transform_component.cpp
+    mesh_component.cpp
+    camera_component.cpp
+    model_loader.cpp
+    audio_system.cpp
+    physics_system.cpp
+    imgui_system.cpp
+    imgui/imgui.cpp
+    imgui/imgui_draw.cpp
+    vulkan_device.cpp
+    pipeline.cpp
+    descriptor_manager.cpp
+    renderdoc_debug_system.cpp
+)
+
+# Create executable
+add_executable(SimpleEngine ${SOURCES})
+add_dependencies(SimpleEngine shaders)
+set_target_properties (SimpleEngine PROPERTIES CXX_STANDARD 20)
+
+# Link libraries
+target_link_libraries(SimpleEngine PRIVATE
+    Vulkan::cppm
+    glm::glm
+    tinygltf::tinygltf
+    KTX::ktx
+    OpenAL::OpenAL
+)
+
+if(NOT ANDROID)
+    target_link_libraries(SimpleEngine PRIVATE glfw)
+endif()
+
+# Copy model and texture files if they exist
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/models)
+    add_custom_command(TARGET SimpleEngine POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/models ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/models
+        COMMENT "Copying models to output directory"
+    )
+endif()
+
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/textures)
+    add_custom_command(TARGET SimpleEngine POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/textures ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/textures
+        COMMENT "Copying textures to output directory"
+    )
+endif()
+
+# Add packaging configuration
+include(CPack)
+
+# Set package properties
+set(CPACK_PACKAGE_NAME "SimpleEngine")
+set(CPACK_PACKAGE_VENDOR "SimpleEngine Team")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "A simple game engine built with Vulkan")
+set(CPACK_PACKAGE_VERSION "1.0.0")
+set(CPACK_PACKAGE_VERSION_MAJOR "1")
+set(CPACK_PACKAGE_VERSION_MINOR "0")
+set(CPACK_PACKAGE_VERSION_PATCH "0")
+set(CPACK_PACKAGE_INSTALL_DIRECTORY "SimpleEngine")
+
+# Set platform-specific package generators
+if(WIN32)
+    set(CPACK_GENERATOR "ZIP;NSIS")
+    set(CPACK_NSIS_PACKAGE_NAME "SimpleEngine")
+    set(CPACK_NSIS_DISPLAY_NAME "SimpleEngine")
+    set(CPACK_NSIS_HELP_LINK "https://github.com/yourusername/SimpleEngine")
+    set(CPACK_NSIS_URL_INFO_ABOUT "https://github.com/yourusername/SimpleEngine")
+    set(CPACK_NSIS_CONTACT "your.email@example.com")
+    set(CPACK_NSIS_MODIFY_PATH ON)
+elseif(APPLE)
+    set(CPACK_GENERATOR "ZIP;DragNDrop")
+    set(CPACK_DMG_VOLUME_NAME "SimpleEngine")
+    set(CPACK_DMG_FORMAT "UDBZ")
+else()
+    set(CPACK_GENERATOR "ZIP;DEB")
+    set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Your Name <your.email@example.com>")
+    set(CPACK_DEBIAN_PACKAGE_SECTION "games")
+    set(CPACK_DEBIAN_PACKAGE_DEPENDS "libvulkan1, libglfw3, libglm-dev, libktx-dev")
+endif()
+
+# Include binary and resource directories in the package
+install(TARGETS SimpleEngine DESTINATION bin)
+if(SLANGC_EXECUTABLE)
+    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/shaders DESTINATION share/SimpleEngine)
+endif()
+
+# Install models and textures if they exist
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/models)
+    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/models DESTINATION share/SimpleEngine)
+endif()
+
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/textures)
+    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/textures DESTINATION share/SimpleEngine)
+endif()
+
+# Install README if it exists
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/README.md)
+    install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/README.md DESTINATION share/SimpleEngine)
+endif()