Merge pull request #66 from CapsCollective/feature/resource-packing

Added resource module with packer target, implemented resource packing across examples

Author: jonjondev

.github/workflows/formatting.yml

@@ -11,14 +11,11 @@ jobs:
   formatting:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v2
-
-      # Install dependencies
+      - name: perform checkout
+        uses: actions/checkout@v4
 
       - name: install latest clang-format
         run: brew install clang-format
 
-      # Run formatting checks
-
       - name: make format-check
         run: make format-check

.github/workflows/macOS.yml

@@ -14,10 +14,29 @@ jobs:
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v2
+      - name: perform checkout
+        uses: actions/checkout@v4
 
-    - name: perform setup
-      run: ./scripts/setup.sh
+      - name: install Python dependencies
+        run: brew install python-setuptools
 
-    - name: build all targets
-      run: make
+      - name: perform setup
+        run: ./scripts/setup.sh
+
+      - name: build all targets
+        run: make
+
+      - name: run tests
+        run: |
+          cd ./bin/tests/build
+          ./app
+
+      - name: compress output
+        shell: bash
+        run: tar -cvf ./macos.tar -C ./output .
+
+      - name: upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: macos_output
+          path: ./macos.tar

.github/workflows/tests.yml

@@ -14,19 +14,35 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+      - name: perform checkout
+        uses: actions/checkout@v4
 
-    - name: update apt
-      run: sudo apt-get update
+      - name: update apt
+        run: sudo apt-get update
 
-    - name: install vulkan dependencies
-      run: sudo apt install git build-essential libx11-xcb-dev libxkbcommon-dev libwayland-dev libxrandr-dev
+      - name: install vulkan dependencies
+        run: sudo apt install git build-essential libx11-xcb-dev libxkbcommon-dev libwayland-dev libxrandr-dev
 
-    - name: install glfw dependencies
-      run: sudo apt install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev
+      - name: install glfw dependencies
+        run: sudo apt install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev
 
-    - name: perform setup
-      run: ./scripts/setup.sh
+      - name: perform setup
+        run: ./scripts/setup.sh
 
-    - name: build all targets
-      run: make
+      - name: build all targets
+        run: make
+
+      - name: run tests
+        run: |
+          cd ./bin/tests/build
+          ./app
+
+      - name: compress output
+        shell: bash
+        run: tar -cvf ./linux.tar -C ./output .
+
+      - name: upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: linux_output
+          path: ./linux.tar

.github/workflows/ubuntu.yml

@@ -17,10 +17,25 @@ jobs:
         shell: pwsh
 
     steps:
-    - uses: actions/checkout@v2
+      - name: perform checkout
+        uses: actions/checkout@v4
 
-    - name: perform setup
-      run: ./scripts/setup.ps1
-      
-    - name: build all targets
-      run: mingw32-make
+      - name: perform setup
+        run: ./scripts/setup.ps1
+        
+      - name: build all targets
+        run: mingw32-make
+
+      - name: run tests
+        run: |
+          cd ./bin/tests/build
+          ./app.exe
+
+      - name: compress output
+        run: Compress-Archive -Path ./output/* -DestinationPath ./windows.zip
+
+      - name: upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows_output
+          path: ./windows.zip

.github/workflows/windows.yml

@@ -37,14 +37,17 @@ export scriptsDir := $(abspath scripts)
 export outputDir := $(abspath output)
 export engineDir := $(abspath engine)
 export testsDir := $(abspath tests)
+export packerDir := $(abspath packer)
 export examplesDir := $(abspath examples)
 
 # Set top level targets
 export utilsLib := $(libDir)/libutils.a
+export resourcesLib := $(libDir)/libresources.a
 export windowLib := $(libDir)/libwindow.a
 export coreLib := $(libDir)/libcore.a
 export renderLib := $(libDir)/librender.a
 export testApp := $(binDir)/tests/build/app
+export packerApp := $(binDir)/packer/build/app
 export exampleGameApp := $(binDir)/examples/game/build/app
 export exampleRenderApp := $(binDir)/examples/render/build/app
 export exampleTilemapApp := $(binDir)/examples/tilemap/build/app
@@ -54,13 +57,16 @@ export compileFlags := -Wall -std=c++17
 export linkFlags += -L $(libDir)
 buildFlagsFile:=.buildflags
 
-.PHONY: all testapp gameapp renderapp tilemapapp package-gameapp package-renderapp package-tilemapapp buildFlags clean format
+.PHONY: all packerapp testapp gameapp renderapp tilemapapp package-gameapp package-renderapp package-tilemapapp buildFlags clean format
 
-all: testapp package-gameapp package-renderapp package-tilemapapp
+all: packerapp testapp package-gameapp package-renderapp package-tilemapapp
 
 $(utilsLib): buildFlags
 	"$(MAKE)" -C $(engineDir)/utils CXXFLAGS="$(CXXFLAGS)"
 
+$(resourcesLib): buildFlags $(utilsLib)
+	"$(MAKE)" -C $(engineDir)/resources CXXFLAGS="$(CXXFLAGS)"
+
 $(windowLib): buildFlags $(utilsLib)
 	"$(MAKE)" -C $(engineDir)/window CXXFLAGS="$(CXXFLAGS)"
 
@@ -70,20 +76,25 @@ $(coreLib): buildFlags $(utilsLib)
 $(renderLib): buildFlags $(utilsLib) $(windowLib)
 	"$(MAKE)" -C $(engineDir)/render CXXFLAGS="$(CXXFLAGS)"
 
-$(testApp): buildFlags $(utilsLib) $(coreLib)
+$(packerApp): buildFlags $(utilsLib) $(resourcesLib)
+	"$(MAKE)" -C $(packerDir) CXXFLAGS="$(CXXFLAGS)"
+
+$(testApp): buildFlags $(utilsLib) $(coreLib) $(packerApp)
 	"$(MAKE)" -C $(testsDir) CXXFLAGS="$(CXXFLAGS)"
 
-$(exampleGameApp): buildFlags $(renderLib) $(coreLib)
+$(exampleGameApp): buildFlags $(renderLib) $(coreLib) $(packerApp)
 	"$(MAKE)" -C $(examplesDir)/game CXXFLAGS="$(CXXFLAGS)"
 
-$(exampleRenderApp): buildFlags $(renderLib)
+$(exampleRenderApp): buildFlags $(renderLib) $(packerApp)
 	"$(MAKE)" -C $(examplesDir)/render CXXFLAGS="$(CXXFLAGS)"
 
-$(exampleTilemapApp): buildFlags $(renderLib)
+$(exampleTilemapApp): buildFlags $(renderLib) $(packerApp)
 	"$(MAKE)" -C $(examplesDir)/tilemap CXXFLAGS="$(CXXFLAGS)"
 
 testapp: $(testApp)
 
+packerapp: $(packerApp)
+
 gameapp: $(exampleGameApp)
 
 renderapp: $(exampleRenderApp)
@@ -105,15 +116,15 @@ buildFlags:
 
 # Run cleanup across project
 clean:
-	$(RM) $(call platformpth, $(libDir))
-	$(RM) $(call platformpth, $(binDir))
-	$(RM) $(call platformpth, $(outputDir))
-	$(RM) $(call platformpth, $(buildFlagsFile))
+	$(RM) $(call platformpth,$(libDir))
+	$(RM) $(call platformpth,$(binDir))
+	$(RM) $(call platformpth,$(outputDir))
+	$(RM) $(call platformpth,$(buildFlagsFile))
 
 # Check file formatting program across all source files
 format-check:
-	$(formatScript) "$(engineDir) $(examplesDir) $(testsDir)" --check
+	$(formatScript) "$(engineDir) $(examplesDir) $(testsDir) $(packerDir)" --check
 
 # Run file formatting program across all source files
 format:
-	$(formatScript) "$(engineDir) $(examplesDir) $(testsDir)"
+	$(formatScript) "$(engineDir) $(examplesDir) $(testsDir) $(packerDir)"

Makefile

@@ -43,16 +43,20 @@ The ultimate purpose of this project is to act as the metaphorical siege engine
 
 The following are dependencies for building and running the project:
 
-- **All platforms**
-    - [CMake](https://cmake.org/)
 - **macOS**
+    - [CMake](https://cmake.org/)
     - [GNU Make](https://www.gnu.org/software/make/)
     - [Clang Format](https://clang.llvm.org/docs/ClangFormat.html)
     - [Xcode Command Line Tools](https://developer.apple.com/download/) (via `xcode-select --install`)
 - **Windows**
-    - [MinGW32 Make](https://www.mingw-w64.org/)
-    - [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/)
+  - [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/)
+  - [MSYS2](https://www.msys2.org/) with the following UCRT packages installed:
+    - `mingw-w64-ucrt-x86_64-gcc`
+    - `mingw-w64-ucrt-x86_64-make`
+    - `mingw-w64-ucrt-x86_64-python`
+    - `mingw-w64-ucrt-x86_64-cmake`
 - **Linux**
+    - [CMake](https://cmake.org/)
     - [Clang Format](https://clang.llvm.org/docs/ClangFormat.html)
     - The following packages are required for building the dependencies:
         - `git`
@@ -162,6 +166,7 @@ You can see examples of this in any of the application targets under `examples`.
      │          ├─[render] <- an example app demonstrating the renderer
      │
      ├─[make] <- additional Make file utilities for the build system
+     ├─[packer] <- an asset packing app for bundling game assets in a pack file on build 
      ├─[scripts] <- additional scripts for the build system and user convenience
      ├─[tests] <- a unit test app covering all of the engine's libraries
      ├─[vendor] <- all third-party libraries used by the project

README.md

@@ -24,13 +24,13 @@ endif
 
 # Build the static library
 $(coreLib): $(coreObjects)
-	$(MKDIR) $(call platformpth, $(libDir))
+	$(call MKDIR,$(call platformpth,$(libDir)))
 	ar -crs $(coreLib) $(coreObjects)
 
 # Add all rules from dependency files
 -include $(coreDepends)
 
 # Compile object files to the bin directory
 $(coreBinDir)/%.o: $(coreSrcDir)/%.cpp
-	$(MKDIR) $(call platformpth, $(@D))
+	$(call MKDIR,$(call platformpth,$(@D)))
 	$(CXX) -MMD -MP -c $(compileFlags) -I $(engineDir) $< -o $@ $(CXXFLAGS)