Code Restructure To Reduce Disk Usage and Help Readability

- Move from github-submodule structure to use CMake's native
  dependency management facilities. (https://cmake.org/cmake/help/latest/guide/using-dependencies/index.html). Ideally the dependencies are to be installed using native mechanisms like vcpkg on windows, the linux distribution package manager or homebrew for mac. CMake will find the installed versions as a first option but build the dependencies if not available in the Build Directory at Build time. The linux_build code action is an example of this working in linux.

- Restructure The #include statements to indicate the project source,
  this prevents confusion and is easier to read at the source file. It is also a consistent
  way to describe the included header and to reason about the include
  structure. This also is to pave the way to converting to modules.

- Explicit Code file declaration in CMake as opposed to File Globbing
  which is only run once during build system generation. When creating a
  new file, it is suggested to specify it in the CMake File which will
  enhance tracking and ensure that it is picked up at build time due to
  changes in the CMake Files.

- Changed Bitmap.h to utf-8 from iso-8859

- Changed from MSVC style of pre-compiled headers, just using plain
  header includes for portability. Another benefit is storage savings as
  the pch file was taking up too much space(in my experience)

Author: MathewBenson

.clang-format

@@ -120,7 +120,7 @@ PenaltyBreakTemplateDeclaration: 100
 PenaltyReturnTypeOnItsOwnLine: 300
 PointerAlignment: Left
 ReflowComments: true
-SortIncludes: true
+SortIncludes: false
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: true
 SpaceAfterLogicalNot: false

.github/workflows/linux-build.yml

@@ -4,56 +4,27 @@ name: ZEngine Linux Build
 
 on:
   push:
-    branches: [ master ]
+    branches: [ develop ]
   pull_request:
     branches: [ master ]
 
 jobs:
   Linux-Build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-          buildConfiguration: [Debug, Release]
+    runs-on: ubuntu-24.04
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
-
-#     - name: Checkout submodules
-#       run: git submodule update --init --recursive
-
-#     - name: Install development library
-#       run: sudo apt-get install libasound2-dev libgl1-mesa-dev libpulse-dev libdbus-1-dev libx11-dev libxcursor-dev libxext-dev libxi-dev libxinerama-dev libxrandr-dev libxss-dev libxt-dev libxxf86vm-dev
-
-#     - name: Install CMake
-#       uses: jwlawson/actions-setup-cmake@v1.9
-#       with:
-#         cmake-version: '3.20.x'
-
-#     - name: Install pre-requisite packages.
-#       run: sudo apt-get install -y wget apt-transport-https software-properties-common
-
-#     - name: Download the Microsoft repository GPG keys
-#       run: wget -q https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb
-
-#     - name: Register the Microsoft repository GPG keys
-#       run: sudo dpkg -i packages-microsoft-prod.deb
-
-#     - name: Update the list of packages after we added packages.microsoft.com
-#       run: sudo apt-get update
-
-#     - name: Install PowerShell
-#       run: sudo apt-get install -y powershell
+      uses: actions/checkout@v3
 
-#     - name: Add GCC Toolchain repository
-#       run: sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+    - name: Install development library
+      run: sudo apt-get update && sudo apt-get install -y git libasound2-dev libgl1-mesa-dev libpulse-dev libdbus-1-dev libx11-dev libxcursor-dev libxext-dev libxi-dev libxinerama-dev libxrandr-dev libxss-dev libxt-dev libxxf86vm-dev cmake gcc g++ ninja-build libassimp-dev libfmt-dev libimgui-dev libstb-dev libglfw3-dev libspdlog-dev libglm-dev libyaml-cpp-dev libspirv-cross-c-shared-dev spirv-cross spirv-tools glslang-dev glslang-tools nlohmann-json3-dev dotnet-runtime-8.0 libgtest-dev
 
-#     - name: Install GCC compiler
-#       run: sudo apt install -y gcc-11
+    - name: Create CMake Build Directory
+      run: mkdir ../build && cmake -B ../build -DCMAKE_BUILD_TYPE=Debug -G Ninja
 
-#     - name: Install G++ compiler
-#       run: sudo apt install -y g++-11
+    - name: Build
+      run: cmake --build ../build
 
-#     - name: CMake Build
-#       run: .\Scripts\BuildEngine.ps1 -Configurations ${{matrix.buildConfiguration}}
-#       shell: pwsh
+    - name: Test
+      run: ctest .
+      working-directory: ../build/ZEngine/tests

.gitmodules

@@ -1,69 +0,0 @@
-[submodule "__externals/fmt"]
-	path = __externals/fmt
-	url = https://github.com/fmtlib/fmt
-[submodule "__externals/stb"]
-	path = __externals/stb
-	url = https://github.com/nothings/stb
-[submodule "__externals/imgui/src"]
-	path = __externals/imgui/src
-	url = https://github.com/ocornut/imgui
-[submodule "__externals/spdlog"]
-	path = __externals/spdlog
-	url = https://github.com/gabime/spdlog
-[submodule "__externals/glfw"]
-	path = __externals/glfw
-	url = https://github.com/glfw/glfw
-[submodule "__externals/entt"]
-	path = __externals/entt
-	url = https://github.com/skypjack/entt
-[submodule "__externals/assimp"]
-	path = __externals/assimp
-	url = https://github.com/assimp/assimp
-[submodule "__externals/stduuid"]
-	path = __externals/stduuid
-	url = https://github.com/mariusbancila/stduuid
-[submodule "__externals/yaml-cpp"]
-	path = __externals/yaml-cpp
-	url = https://github.com/jbeder/yaml-cpp
-[submodule "__externals/ImGuizmo"]
-	path = __externals/ImGuizmo
-	url = https://github.com/CedricGuillemet/ImGuizmo
-[submodule "__externals/SPIRV-Cross"]
-	path = __externals/SPIRV-Cross
-	url = https://github.com/KhronosGroup/SPIRV-Cross
-[submodule "__externals/gtest"]
-	path = __externals/gtest
-	url = https://github.com/google/googletest
-[submodule "__externals/VulkanMemoryAllocator"]
-	path = __externals/VulkanMemoryAllocator
-	url = https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator
-[submodule "__externals/nlohmann_json"]
-	path = __externals/nlohmann_json
-	url = https://github.com/nlohmann/json
-[submodule "__externals/glslang"]
-	path = __externals/glslang
-	url = https://github.com/khronosGroup/glslang.git
-[submodule "__externals/SPIRV-headers"]
-	path = __externals/SPIRV-headers
-	url = https://github.com/khronosGroup/SPIRV-headers.git
-[submodule "__externals/SPIRV-Tools"]
-	path = __externals/SPIRV-Tools
-	url = https://github.com/khronosGroup/SPIRV-Tools
-[submodule "__externals/Vulkan-Loader"]
-	path = __externals/Vulkan-Loader
-	url = https://github.com/KhronosGroup/Vulkan-Loader
-[submodule "__externals/glm"]
-	path = __externals/glm
-	url = https://github.com/g-truc/glm
-[submodule "__externals/Vulkan-Headers"]
-	path = __externals/Vulkan-Headers
-	url = https://github.com/KhronosGroup/Vulkan-Headers
-[submodule "__externals/tlsf/src"]
-	path = __externals/tlsf/src
-	url = https://github.com/mattconte/tlsf
-[submodule "__externals/CLI11"]
-	path = __externals/CLI11
-	url = https://github.com/CLIUtils/CLI11
-[submodule "__externals/rapidhash/src"]
-	path = __externals/rapidhash/src
-	url = https://github.com/Nicoshev/rapidhash

CMakeLists.txt

@@ -1,115 +1,81 @@
-cmake_minimum_required (VERSION 3.17 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.17 FATAL_ERROR)
 
-project (RendererEngine
-	VERSION 1.0
-	DESCRIPTION "Renderer Engine is an open-source 2D - 3D rendering engine written in C/C++"
-	LANGUAGES CXX C
-)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_CXX_STANDARD 20)
 
-set_property (GLOBAL PROPERTY USE_FOLDERS ON)
+project(
+  RendererEngine
+  VERSION 1.0
+  DESCRIPTION
+    "Renderer Engine is an open-source 2D - 3D rendering engine written in C/C++"
+  LANGUAGES CXX)
+
+set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
 # Core invariants
 #
-get_filename_component (ENLISTMENT_ROOT "." ABSOLUTE CACHE)
-get_filename_component (EXTERNAL_DIR "${ENLISTMENT_ROOT}/__externals" ABSOLUTE CACHE)
-get_filename_component (EXTERNAL_NUGET_DIR "${ENLISTMENT_ROOT}/__externals/nuget" ABSOLUTE CACHE)
+get_filename_component(ENLISTMENT_ROOT "." ABSOLUTE CACHE)
+get_filename_component(EXAMPLE_DIR "${ENLISTMENT_ROOT}/Examples" ABSOLUTE CACHE)
 
 include(${ENLISTMENT_ROOT}/Scripts/CMake/NuGet.cmake)
-include(${ENLISTMENT_ROOT}/Scripts/CMake/CppWinRT.cmake)
-include(${ENLISTMENT_ROOT}/dependencies.cmake)
-
 
-option (COPY_EXAMPLE_PROJECT "Copy example projects that show how to use Launcher" ON)
-option (LAUNCHER_ONLY "Build Launcher only" OFF)
-
-set (MACOSX_ARCHITECTURE_ARM64 OFF)
-if (APPLE)
-    # Use uname to detect the macOS processor architecture
-    execute_process(
-        COMMAND uname -m
-        OUTPUT_VARIABLE MACOSX_ARCHITECTURE
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-    )
-	if (MACOSX_ARCHITECTURE STREQUAL "arm64")
-		set (MACOSX_ARCHITECTURE_ARM64 ON)
-	endif ()
-endif ()
+option(COPY_EXAMPLE_PROJECT
+       "Copy example projects that show how to use Launcher" ON)
+option(LAUNCHER_ONLY "Build Launcher only" OFF)
+
+set(MACOSX_ARCHITECTURE_ARM64 OFF)
+if(APPLE)
+  # Use uname to detect the macOS processor architecture
+  execute_process(
+    COMMAND uname -m
+    OUTPUT_VARIABLE MACOSX_ARCHITECTURE
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
+  if(MACOSX_ARCHITECTURE STREQUAL "arm64")
+    set(MACOSX_ARCHITECTURE_ARM64 ON)
+  endif()
+endif()
 
 if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
 	add_compile_definitions(_SILENCE_STDEXT_ARR_ITERS_DEPRECATION_WARNING) # Fix Warning from VS 2022 +
 endif()
 
-# Externals dependencies
-#
-if (NOT LAUNCHER_ONLY)
-	add_subdirectory (${EXTERNAL_DIR}/fmt)
-	add_subdirectory (${EXTERNAL_DIR}/imgui)
-	add_subdirectory (${EXTERNAL_DIR}/glfw)
-	add_subdirectory (${EXTERNAL_DIR}/spdlog)
-	add_subdirectory (${EXTERNAL_DIR}/glm)
-	add_subdirectory (${EXTERNAL_DIR}/entt)
-	add_subdirectory (${EXTERNAL_DIR}/assimp)
-	add_subdirectory (${EXTERNAL_DIR}/stduuid)
-	add_subdirectory (${EXTERNAL_DIR}/yaml-cpp)
-	add_subdirectory (${EXTERNAL_DIR}/SPIRV-headers)
-	add_subdirectory (${EXTERNAL_DIR}/SPIRV-Tools)
-	add_subdirectory (${EXTERNAL_DIR}/glslang)
-	add_subdirectory (${EXTERNAL_DIR}/SPIRV-Cross)
-	add_subdirectory (${EXTERNAL_DIR}/gtest)
-	add_subdirectory (${EXTERNAL_DIR}/VulkanMemoryAllocator)
-	add_subdirectory (${EXTERNAL_DIR}/tlsf)
-	add_subdirectory (${EXTERNAL_DIR}/rapidhash)
-	add_subdirectory (${EXTERNAL_DIR}/CLI11)
-
-	set (CMAKE_PREFIX_PATH
-		${CMAKE_PREFIX_PATH}
-		${EXTERNAL_DIR}/Vulkan-Headers/build/install/share/cmake
-	)
-	add_subdirectory (${EXTERNAL_DIR}/Vulkan-Loader)
+include(externals.cmake)
 
-	# Core engine lib is here
-	#
-	add_subdirectory (ZEngine)
+# Core engine lib is here
+#
+add_subdirectory(ZEngine)
 
-	# Editor is here
-	#
-	add_subdirectory (Tetragrama)
-endif ()
+# Editor is here
+#
+add_subdirectory(Tetragrama)
 
 # Launcher is here
 #
-add_subdirectory (Panzerfaust)
+ add_subdirectory (Panzerfaust)
 
-if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-	set_property (DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT Panzerfaust)
-endif ()
+if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
+  set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT
+                                                              Panzerfaust)
+endif()
 
 # Post build operation
 #
-set (SYSTEM_NAME ${CMAKE_SYSTEM_NAME})
-if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-	set (SYSTEM_ARCHITECTURE "win-x64")
-elseif (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-	set (SYSTEM_ARCHITECTURE "linux-x64")
-elseif (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
-	if (MACOSX_ARCHITECTURE_ARM64)
-		set (SYSTEM_ARCHITECTURE "osx-arm64")
-	else ()
-		set (SYSTEM_ARCHITECTURE "osx-x64")
-	endif ()
-endif ()
-
-add_custom_target (AssembleContent ALL
-	COMMENT "Copying assets and resources contents"
-	COMMAND pwsh ${CMAKE_CURRENT_SOURCE_DIR}/Scripts/PostBuild.ps1 -SystemName ${SYSTEM_NAME} -Architectures ${SYSTEM_ARCHITECTURE} -Configurations $<IF:$<CONFIG:Debug>,Debug,Release> $<$<BOOL:${LAUNCHER_ONLY}>:-LauncherOnly>
-)
-
-if (NOT LAUNCHER_ONLY)
-	add_dependencies(AssembleContent zEngineLib tetragrama)
-endif ()
+set(SYSTEM_NAME ${CMAKE_SYSTEM_NAME})
+if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
+  set(SYSTEM_ARCHITECTURE "win-x64")
+elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
+  set(SYSTEM_ARCHITECTURE "linux-x64")
+elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
+  if(MACOSX_ARCHITECTURE_ARM64)
+    set(SYSTEM_ARCHITECTURE "osx-arm64")
+  else()
+    set(SYSTEM_ARCHITECTURE "osx-x64")
+  endif()
+endif()
 
-if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-	add_dependencies(AssembleContent Panzerfaust-WinBuild)
-else ()
-	add_dependencies(AssembleContent Panzerfaust)
-endif ()
+if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
+  # add_dependencies(AssembleContent Panzerfaust-WinBuild)
+else()
+  # add_dependencies(AssembleContent Panzerfaust)
+endif()