-Dev: full support for Linux

Author: AEspinosaDev

CMakeLists.txt

@@ -16,10 +16,6 @@ elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     message("Using GCC")
 endif()
 
-
-# Set the platform (e.g., x64)
-# set(CMAKE_GENERATOR_PLATFORM x64) # or Win32, as needed
-
 # Use C++17
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -33,6 +29,10 @@ find_package(Vulkan REQUIRED)
 if(NOT Vulkan_FOUND)
     message(FATAL_ERROR "Vulkan SDK not found. Please install Vulkan SDK and ensure it's in your CMake search path.")
 endif()
+# if(UNIX)
+#     set(SHADERC_INCLUDE_DIRS $ENV{VULKAN_SDK}/include)
+#     set(SHADERC_LIBRARIES $ENV{VULKAN_SDK}/lib/libshaderc_combined.a)
+# endif()
 
 # Get the root path for Vulkan from the Vulkan_LIBRARY variable
 get_filename_component(VULKAN_SDK_ROOT ${Vulkan_LIBRARY} DIRECTORY)

CMakePresets.json

@@ -12,7 +12,7 @@
             "name": "ninja-debug",
             "displayName": "Ninja (Debug)",
             "generator": "Ninja",
-            "binaryDir": "${sourceDir}/build/ninja-debug",
+            "binaryDir": "${sourceDir}/build/${presetName}",
             "cacheVariables": {
                 "CMAKE_CXX_COMPILER": "clang++",         
                 "CMAKE_C_COMPILER": "clang",
@@ -27,7 +27,7 @@
             "name": "ninja-release",
             "displayName": "Ninja (Release)",
             "generator": "Ninja",
-            "binaryDir": "${sourceDir}/build/ninja-release",
+            "binaryDir": "${sourceDir}/build/${presetName}",
             "cacheVariables": {
                 "CMAKE_CXX_COMPILER": "clang++",         
                 "CMAKE_C_COMPILER": "clang",
@@ -42,7 +42,7 @@
             "displayName": "Visual Studio 2022 (x64) (Debug)",
             "generator": "Visual Studio 17 2022",
             "architecture": "x64", 
-            "binaryDir": "${sourceDir}/build/vs2022-x64-debug",
+            "binaryDir": "${sourceDir}/build/${presetName}",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug"
             }
@@ -52,11 +52,38 @@
             "displayName": "Visual Studio 2022 (x64) (Release)",
             "generator": "Visual Studio 17 2022",
             "architecture": "x64", 
-            "binaryDir": "${sourceDir}/build/vs2022-x64-release",
+            "binaryDir": "${sourceDir}/build/${presetName}",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Release"
             }
+        },
+        {
+            "name": "GCC-x86_64-debug",
+            "displayName": "GCC (x86-64) (Debug)",
+            "binaryDir": "${sourceDir}/build/${presetName}",
+            "cacheVariables": {
+                "CMAKE_C_COMPILER": "gcc",
+                "CMAKE_CXX_COMPILER": "g++",
+                "CMAKE_CXX_STANDARD": "17",
+                "CMAKE_CXX_STANDARD_REQUIRED": "ON",
+                "CMAKE_CXX_EXTENSIONS": "OFF",
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
+        },
+        {
+            "name": "GCC-x86_64-release",
+            "displayName": "GCC (x86-64) (Release)",
+            "binaryDir": "${sourceDir}/build/${presetName}",
+            "cacheVariables": {
+                "CMAKE_C_COMPILER": "gcc",
+                "CMAKE_CXX_COMPILER": "g++",
+                "CMAKE_CXX_STANDARD": "17",
+                "CMAKE_CXX_STANDARD_REQUIRED": "ON",
+                "CMAKE_CXX_EXTENSIONS": "OFF",
+                "CMAKE_BUILD_TYPE": "Release"
+            }
         }
+        
     ],
 
     "buildPresets": [
@@ -77,6 +104,16 @@
             "name": "vs2022-x64-debug",
             "configurePreset": "vs2022-x64-debug",
             "configuration": "Debug"
+        },
+        {
+            "name": "GCC-x86_64-debug",
+            "configurePreset": "GCC-x86_64-debug",
+            "configuration": "Debug"
+        },
+        {
+            "name": "GCC-x86_64-release",
+            "configurePreset": "GCC-x86_64-release",
+            "configuration": "Release"
         }
     ]
 }

README.md

@@ -71,10 +71,10 @@ This project is a work in progress. It has a long way until becoming a decent li
 
 The prequisites for using this code are:
 
-- Windows 10, 11 (Although it should be easy enough to set it up for Linux).
-- Vulkan SDK 1.3.* installed. (With VMA and Shaderc libraries)
+- Windows (10, 11) or Ubuntu (22, 23).
+- Vulkan SDK 1.3.* installed. **(With VMA and Shaderc libraries)**
 - CMake installed.
-- Ninja (Optional but recommended to speed-up compilation time)
+- Ninja 🥷 (Optional but recommended to speed-up compilation time)
 
 1. Clone the repo:
    ```bash
@@ -92,16 +92,16 @@ The prequisites for using this code are:
 
 The project is configured in such a way that, during the build process, CMake takes care of automatically locating and linking all dependencies on the system, with exception of the Vulkan SDK, due to its more complex installation. This has been done to facilitate an easy and lightweight distribution of the source code, sparing the user the effort of manual configuration. Although the project has been implemented in VS Code, a practical file structure has been configured for CMake in case it is opened in Visual Studio or any other IDE.
 
-Once the project is opened in the IDE of choice, compile it in the desired mode, and it would be ready to run. The CMake configuration is set for a 64-bit architecture, but it can be changed. CMake also takes care of automatically configuring the paths for resource files.
+Once the project is opened in the IDE of choice, compile it in the desired mode, and it would be ready to run (compile configurations json added for VS Code). CMake also takes care of automatically configuring the paths for resource files.
 
 The project compiles dependencies, the 3D library, and the example applications directory, which statically links against the 3D library. The library is a STATIC lib, do not try to link dynamically against it.
 
-3. Building of the demos and tests directory is optional, and can be turned off in CMake:
+3. Building of the demos and tests directory is **optional**, and can be turned off in CMake:
 ```bash
 cmake -DBUILD_EXAMPLES=OFF /path/to/source
 cmake -DBUILD_TESTS=OFF /path/to/source
 ```
-4. Alternatively, you can click on any of the setup folder .bat files to compile and configure the project using you preferred backend. If using VS Code, you can change presents in the CMake Tools' bar. 
+4. **Alternatively**, you can click on any of the setup folder **.bat files** to compile and configure the project using you preferred backend. If using VS Code, you can change presents in the CMake Tools' bar. 
 
 ## Project Integration 🗄️
 
@@ -326,3 +326,28 @@ With a little extra effort, you can create much richer and interactive applicati
 As you can see, the library is easy to use: with a window, a camera, a scene filled with some meshes and of course a renderer, you have everything you need to start working. 
 
 
+## FOR LINUX USERS ONLY
+
+In order for GLFW to compile you will need to install these dependencies:
+
+ ```bash
+sudo apt-get install libxkbcommon-x11-dev
+sudo apt-get install libxinerama-dev
+sudo apt-get install libxcursor-dev
+sudo apt-get install libxi-dev
+   ```
+
+This uses x11 backend, if you want to use Wayland install Wayland depedencies.
+
+After that, follow these steps:
+
+1. Download https://vulkan.lunarg.com/sdk/home (better this way than apt because it brings VMA and shaderc)
+2. Extract and install
+```bash
+chmod +x vulkansdk-linux-x.x.x.x-setup.run
+./vulkansdk-linux-x.x.x.x-setup.run
+   ```
+3. Setup enviroment variables
+```bash
+source ~/VulkanSDK/x.x.x.x.x/setup-env.sh
+   ```