Headless mode

.github/workflows/appimage.yml

@@ -1,4 +1,4 @@
-name: C/C++ AppImage
+name: x86-64 AppImage
 
 on:
   push:
@@ -20,24 +20,33 @@ jobs:
       - uses: actions/checkout@v2
         with:
           submodules: 'true'
-      - name: install dependencies
+      - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y build-essential libglfw3-dev libglfw3 libglew-dev \
-            libglm-dev libpng-dev libopenal-dev libluajit-5.1-dev libvorbis-dev libcurl4-openssl-dev cmake squashfs-tools
+            libglm-dev libpng-dev libopenal-dev libluajit-5.1-dev libvorbis-dev \
+            libcurl4-openssl-dev libgtest-dev cmake squashfs-tools valgrind
           # fix luajit paths
           sudo ln -s /usr/lib/x86_64-linux-gnu/libluajit-5.1.a /usr/lib/x86_64-linux-gnu/liblua5.1.a
           sudo ln -s /usr/include/luajit-2.1 /usr/include/lua
           # install EnTT
           git clone https://github.com/skypjack/entt.git
           cd entt/build
-          cmake -DCMAKE_BUILD_TYPE=Release ..
+          cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
           sudo make install
           cd ../..
-      - name: configure
-        run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DVOXELENGINE_BUILD_APPDIR=1
-      - name: build
+      - name: Configure
+        run: cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo -DVOXELENGINE_BUILD_APPDIR=1 -DVOXELENGINE_BUILD_TESTS=ON
+      - name: Build
         run: cmake --build build -t install
+      - name: Run tests
+        run: ctest --test-dir build
+      - name: Run engine tests
+        timeout-minutes: 1
+        run: |
+            chmod +x build/VoxelEngine
+            chmod +x AppDir/usr/bin/vctest
+            AppDir/usr/bin/vctest -e build/VoxelEngine -d dev/tests -u build
       - name: Build AppImage
         uses: AppImageCrafters/build-appimage-action@fe2205a4d6056be47051f7b1b3811106e9814910
         env:

.github/workflows/macos.yml

@@ -39,6 +39,12 @@ jobs:
       - name: Run tests
         run: ctest --output-on-failure --test-dir build
 
+      - name: Run engine tests
+        timeout-minutes: 1
+        run: |
+          chmod +x build/VoxelEngine
+          chmod +x AppDir/usr/bin/vctest
+          AppDir/usr/bin/vctest -e build/VoxelEngine -d dev/tests -u build
       - name: Create DMG
         run: |
           mkdir VoxelEngineDmgContent

.github/workflows/windows-clang.yml

@@ -0,0 +1,70 @@
+name: Windows Build (CLang)
+
+on:
+  push:
+    branches: [ "main", "release-**"]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-windows:
+
+    strategy:
+      matrix:
+        include:
+          - os: windows-latest
+            compiler: clang
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: 'true'
+      - uses: msys2/setup-msys2@v2
+        id: msys2
+        name: Setup MSYS2
+        with:
+            msystem: clang64
+            install: >-
+                mingw-w64-clang-x86_64-toolchain 
+                mingw-w64-clang-x86_64-cmake 
+                mingw-w64-clang-x86_64-make 
+                mingw-w64-clang-x86_64-luajit 
+                git
+      - name: Set up vcpkg
+        shell: msys2 {0}
+        run: |
+            git clone https://github.com/microsoft/vcpkg.git
+            cd vcpkg
+            ./bootstrap-vcpkg.bat
+            ./vcpkg integrate install
+            cd ..
+      - name: Configure project with CMake and vcpkg
+        shell: msys2 {0}
+        run: |
+            export VCPKG_DEFAULT_TRIPLET=x64-mingw-static
+            export VCPKG_DEFAULT_HOST_TRIPLET=x64-mingw-static
+            export VCPKG_ROOT=./vcpkg
+            mkdir build
+            cd build
+            cmake -G "MinGW Makefiles" -DVCPKG_TARGET_TRIPLET=x64-mingw-static -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=./vcpkg/scripts/buildsystems/vcpkg.cmake ..
+            cmake --build . --config Release
+      - name: Package for Windows
+        run: |
+          mkdir packaged
+          mkdir packaged/res
+          cp build/VoxelEngine.exe packaged/
+          cp build/vctest/vctest.exe packaged/
+          cp build/*.dll packaged/
+          cp -r build/res/* packaged/res/
+          mv packaged/VoxelEngine.exe packaged/VoxelCore.exe
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Windows-Build
+          path: 'packaged/*'
+      - name: Run engine tests
+        shell: msys2 {0}
+        working-directory: ${{ github.workspace }}
+        run: |
+          packaged/vctest.exe -e packaged/VoxelCore.exe -d dev/tests -u build

.github/workflows/windows.yml

@@ -1,4 +1,4 @@
-name: Windows Build
+name: MSVC Build
 
 on:
   push:
@@ -21,29 +21,33 @@ jobs:
         with:
           submodules: 'true'
 
-      - name: Set up vcpkg
+      - name: Bootstrap vcpkg
+        shell: pwsh
         run: |
           git clone https://github.com/microsoft/vcpkg.git
-          cd vcpkg
-          .\bootstrap-vcpkg.bat
-          .\vcpkg integrate install
-          cd ..
+          ${{ github.workspace }}/vcpkg/bootstrap-vcpkg.bat
+
       - name: Configure and build project with CMake and vcpkg
+        env:
+          VCPKG_ROOT: ${{ github.workspace }}/vcpkg
+        run: |
+          cmake --preset default-vs-msvc-windows
+          cmake --build --preset default-vs-msvc-windows --config Release
+      - name: Run tests
+        run: ctest --preset default-vs-msvc-windows
+      - name: Run engine tests
         run: |
-          mkdir build
-          cd build
-          cmake -DCMAKE_BUILD_TYPE=Release -DVOXELENGINE_BUILD_WINDOWS_VCPKG=ON -DVOXELENGINE_BUILD_TESTS=ON ..
-          cmake --build . --config Release
+            build/vctest/Release/vctest.exe -e build/Release/VoxelEngine.exe -d dev/tests -u build
+        timeout-minutes: 1
       - name: Package for Windows
         run: |
           mkdir packaged
-          cp -r build/* packaged/
-          cp C:/Windows/System32/msvcp140.dll packaged/Release/msvcp140.dll
-          mv packaged/Release/VoxelEngine.exe packaged/Release/VoxelCore.exe
+          cp -r build/Release/* packaged/
+          cp build/vctest/Release/vctest.exe packaged/
+          cp C:/Windows/System32/msvcp140.dll packaged/msvcp140.dll
+          mv packaged/VoxelEngine.exe packaged/VoxelCore.exe
         working-directory: ${{ github.workspace }}
-      - name: Run tests
-        run: ctest --output-on-failure --test-dir build
       - uses: actions/upload-artifact@v4
         with:
           name: Windows-Build
-          path: 'packaged/Release/*'
+          path: 'packaged/*'

.gitignore

@@ -36,10 +36,6 @@ Debug/voxel_engine
 AppDir
 appimage-build/
 
-# for vcpkg
-/vcpkg/
-.gitmodules
-
 # macOS folder attributes
 *.DS_Store
 

CMakeLists.txt

@@ -1,18 +1,24 @@
-option(VOXELENGINE_BUILD_WINDOWS_VCPKG ON)
-if(VOXELENGINE_BUILD_WINDOWS_VCPKG AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake")
-  set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake" CACHE STRING "")
-endif()
-
-cmake_minimum_required(VERSION 3.15)
+cmake_minimum_required(VERSION 3.26)
 project(VoxelEngine)
 
-option(VOXELENGINE_BUILD_APPDIR OFF)
-option(VOXELENGINE_BUILD_TESTS OFF)
+option(VOXELENGINE_BUILD_APPDIR "" OFF)
+option(VOXELENGINE_BUILD_TESTS "" OFF)
 
 set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
+  # We use two types linking: for clang build is static (vcpkg triplet x64-windows-static)
+  # and for msvc build is dynamic linking (vcpkg triplet x64-windows)
+  # By default CMAKE_MSVC_RUNTIME_LIBRARY set by MultiThreaded$<$<CONFIG:Debug>:Debug>DLL
+  if (VCPKG_TARGET_TRIPLET MATCHES "static")
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+  endif()
+endif()
 
 add_subdirectory(src)
-add_executable(${PROJECT_NAME} src/voxel_engine.cpp)
+add_executable(${PROJECT_NAME} src/main.cpp)
 target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src)
 
 if(VOXELENGINE_BUILD_APPDIR)
@@ -24,7 +30,6 @@ if(MSVC)
       set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
     endif()
     if((CMAKE_BUILD_TYPE EQUAL "Release") OR (CMAKE_BUILD_TYPE EQUAL "RelWithDebInfo"))
-      set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Release>:Release>")
       target_compile_options(${PROJECT_NAME} PRIVATE /W4 /MT /O2)
     else()
       target_compile_options(${PROJECT_NAME} PRIVATE /W4)
@@ -39,31 +44,9 @@ else()
   if (CMAKE_BUILD_TYPE MATCHES "Debug")
     target_compile_options(${PROJECT_NAME} PRIVATE -Og)
   endif()
-endif()
-
-if(VOXELENGINE_BUILD_WINDOWS_VCPKG AND WIN32)
-  if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/.git")
-    find_package(Git QUIET)
-    if(GIT_FOUND)
-      message(STATUS "Adding vcpkg as a git submodule...")
-      execute_process(COMMAND ${GIT_EXECUTABLE} submodule add https://github.com/microsoft/vcpkg.git vcpkg WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
-    else()
-      message(FATAL_ERROR "Git not found, cannot add vcpkg submodule.")
-    endif()
-  endif()
-
-  if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/.git")
-    message(STATUS "Initializing and updating vcpkg submodule...")
-    execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
-    execute_process(COMMAND ${CMAKE_COMMAND} -E chdir vcpkg ./bootstrap-vcpkg.bat WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+  if (WIN32)
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
   endif()
-
-  foreach(CONFIG_TYPE ${CMAKE_CONFIGURATION_TYPES})
-    string(TOUPPER ${CONFIG_TYPE} CONFIG_TYPE_UPPER)
-    add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
-                       COMMAND ${CMAKE_COMMAND} -E copy_directory
-                       ${CMAKE_SOURCE_DIR}/res ${CMAKE_BINARY_DIR}/${CONFIG_TYPE_UPPER}/res)
-  endforeach()
 endif()
 
 if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
@@ -76,9 +59,18 @@ endif()
 
 target_link_libraries(${PROJECT_NAME} VoxelEngineSrc ${CMAKE_DL_LIBS})
 
-file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/res DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
+# Deploy res to build dir
+add_custom_command(
+  TARGET ${PROJECT_NAME} 
+  POST_BUILD 
+  COMMAND ${CMAKE_COMMAND} -E copy_directory_if_different 
+          ${CMAKE_CURRENT_SOURCE_DIR}/res 
+          $<TARGET_FILE_DIR:${PROJECT_NAME}>/res
+  )
 
 if (VOXELENGINE_BUILD_TESTS)
     enable_testing()
     add_subdirectory(test)
-endif()
+endif()
+
+add_subdirectory(vctest)

CMakePresets.json

@@ -0,0 +1,35 @@
+{
+    "version": 6,
+    "configurePresets": [
+        {
+            "name": "default-vs-msvc-windows",
+            "condition": {
+                "type": "equals",
+                "rhs": "${hostSystemName}",
+                "lhs": "Windows"
+            },
+            "generator": "Visual Studio 17 2022",
+            "binaryDir": "${sourceDir}/build",
+            "cacheVariables": {
+                "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+                "VOXELENGINE_BUILD_TESTS": "ON"
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "default-vs-msvc-windows",
+            "configurePreset": "default-vs-msvc-windows",
+            "configuration": "Debug"
+        }
+    ],
+    "testPresets": [
+        {
+            "name": "default-vs-msvc-windows",
+            "configurePreset": "default-vs-msvc-windows",
+            "output": {
+                "outputOnFailure": true
+            }
+        }
+    ]
+}

README.md

@@ -108,28 +108,32 @@ cmake --build .
 >[!NOTE]
 > Requirement:
 >
-> vcpkg, CMake
+> vcpkg, CMake, Git
+There are two options to use vcpkg:
+1. If you have Visual Studio installed, most likely the **VCPKG_ROOT** environment variable will already exist in **Developer Command Prompt for VS**
+2. If you want use **vcpkg**, install **vcpkg** from git to you system:
+```PowerShell
+cd C:/
+git clone https://github.com/microsoft/vcpkg.git
+cd vcpkg
+.\bootstrap-vcpkg.bat
+```
+After installing **vcpkg**, setup env variable **VCPKG_ROOT** and add it to **PATH**:
+```PowerShell
+$env:VCPKG_ROOT = "C:\path\to\vcpkg"
+$env:PATH = "$env:VCPKG_ROOT;$env:PATH"
+```
+>[!TIP]
+>For troubleshooting you can read full [documentation](https://learn.microsoft.com/ru-ru/vcpkg/get_started/get-started?pivots=shell-powershell) for **vcpkg**
 
-```sh
+After installing **vcpkg** you can build project:
+```PowerShell
 git clone --recursive https://github.com/MihailRis/VoxelEngine-Cpp.git
 cd VoxelEngine-Cpp
-mkdir build
-cd build
-cmake -DCMAKE_BUILD_TYPE=Release -DVOXELENGINE_BUILD_WINDOWS_VCPKG=ON ..
-del CMakeCache.txt
-rmdir /s /q CMakeFiles
-cmake -DCMAKE_BUILD_TYPE=Release -DVOXELENGINE_BUILD_WINDOWS_VCPKG=ON ..
-cmake --build . --config Release
+cmake --preset default-vs-msvc-windows
+cmake --build --preset default-vs-msvc-windows
 ```
 
-> [!TIP]
-> You can use ```rm CMakeCache.txt``` and ```rm -rf CMakeFiles``` while using Git Bash
-
-> [!WARNING]
-> If you have issues during the vcpkg integration, try navigate to ```vcpkg\downloads```
-> and extract PowerShell-[version]-win-x86 to ```vcpkg\downloads\tools``` as powershell-core-[version]-windows.
-> Then rerun ```cmake -DCMAKE_BUILD_TYPE=Release -DVOXELENGINE_BUILD_WINDOWS_VCPKG=ON ..```
-
 ## Build using Docker
 
 ### Step 0. Install docker on your system