feat: Add CMAKE support (#6)

* added clang-format based on Google

* created CmakeLists.txt for all desktop OS

* format source code with clang-format

* add ResourcePath helper for loading assets

* simplify config.hpp load resources

* format using clang-format

* can copy all folders recursively

* ignore DS_store

* more code cleanup

* load map using ResourceLoader

* added requirments for building

* added building instructions

* tip for windows exe failing

* Added screenshot for Cmake GUI

* add more notes in apple README

* set minimum cmake to 3.20

* FIX bug copy resources using cmake for MacOS

* simplify macos copy resources into bundle

* rename apple_cmake to cmake folder

* delete and gitignore  vscode folder

* minor comment fix

* remove all DS_Store files

* fix icon path

* FIX path problem in getResourcePath.cpp

* fix Markdown links and spacing

* remove old worflow directory

* added CmakeSettings.json for Visual Studio

* specify in README.md can install SFML 2.5 or higher

* Create cmake-multi-platform.yml

* Update cmake-multi-platform.yml

* Update cmake-multi-platform.yml

* remove .mm glob from main CmakeLists.txt

* download SFML on linux using CURL from official site

* set BUILD_DIR as env

* fix sfml_dir path in matrix

* use sudo to download and unarchive sfml on ubuntu

* revert back to using apt-get install SFML on ubuntu

.clang-format

@@ -0,0 +1,14 @@
+---
+BasedOnStyle: Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+TabWidth: 8
+UseTab: Never
+VerilogBreakBetweenInstancePorts: true
+WhitespaceSensitiveMacros:
+  - BOOST_PP_STRINGIZE
+  - CF_SWIFT_NAME
+  - NS_SWIFT_NAME
+  - PP_STRINGIZE
+  - STRINGIZE

.github/workflows/cmake-multi-platform.yml

@@ -0,0 +1,84 @@
+# This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
+name: CMake on multiple platforms
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  # global build variables (this sfml_dir is requird only for Windows, Unix is auto)
+  SFML_DIR: "C:/SFML/SFML-2.6.1"
+  BUILD_DIR: ${{ github.workspace }}/build
+  SFML_WIN_ZIP: SFML-2.6.1-windows-vc17-64-bit.zip
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
+      fail-fast: false
+
+
+      # Set up a matrix to run the following 3 configurations:
+      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
+      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
+      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
+      #
+      # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        build_type: [Release]
+        c_compiler: [gcc, cl]
+        include:
+          - os: windows-latest
+            c_compiler: cl
+            cpp_compiler: cl
+          - os: ubuntu-latest
+            c_compiler: gcc
+            cpp_compiler: g++
+        exclude:
+          - os: windows-latest
+            c_compiler: gcc
+          - os: windows-latest
+            c_compiler: clang
+          - os: ubuntu-latest
+            c_compiler: cl
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Download SFML for Ubuntu
+      if:  matrix.os == 'ubuntu-latest'
+      run: sudo apt-get install -y libsfml-dev
+
+    - name: Download and setup SFML for Windows
+      if:  matrix.os == 'windows-latest'
+      shell: cmd
+      run: |
+        mkdir "C:/SFML" && curl -fsSL "https://www.sfml-dev.org/files/${{ env.SFML_WIN_ZIP }}" -o "C:/SFML/${{ env.SFML_WIN_ZIP }}"
+        tar -xvf "C:/SFML/${{ env.SFML_WIN_ZIP }}" -C "C:/SFML/"
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: >
+        cmake -B ${{ env.BUILD_DIR }}
+        -DSFML_HOME=${{env.SFML_DIR}}
+        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
+        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
+        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+        -S ${{ github.workspace }}
+
+    - name: Build
+      # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+      run: cmake --build ${{ env.BUILD_DIR }} --config ${{ matrix.build_type }}
+
+    - name: Test
+      working-directory: ${{ env.BUILD_DIR }}
+      # Execute tests defined by the CMake configuration. Note that --build-config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest --build-config ${{ matrix.build_type }}

.gitignore

@@ -1,3 +1,27 @@
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+build/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+
+# Visual Studio
+.vs/
+.vscode/
+
+# Clion
+*.iml
+.idea/
+.cache/
+.fleet/
+/cmake-build-*/
+
 # Prerequisites
 *.d
 
@@ -30,9 +54,15 @@
 *.exe
 *.out
 *.app
+*.zip
+*.rar
+/*.zip
+xcuserdata/
 
-# ignore the build directory
-build
-
-# performance logger generated files
-*.csv
+# MacOS specific
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+*.xcodeproj/*
+**/.DS_Store