v0.8.1: supplement release for 0.8.0 with fixes

- read from assets.zip if avaiable
- dengitor launch scripts
- fixes some issues that CI wasn't working with github releases
- install python stblib
- update readme

Author: Denzy7

.github/workflows/dengine.yml

@@ -1,136 +1,195 @@
 name: Building dengine libs, dengitor and tests(including apk)
-
 on:
   push:
-    branches: [ "main" ]
+    branches:
+      - main
+    tags:
+      - "v*"
   pull_request:
-    branches: [ "main" ]
+  workflow_dispatch:
 
 jobs:
-  build_linux:
-    runs-on: ubuntu-latest
+  build:
     strategy:
       fail-fast: true
+      matrix:
+        include:
+          - os: windows-2019
+            shell: msys2
+            name: "x86_64_windows"
+          - os: ubuntu-22.04
+            shell: bash
+            name: "x86_64_linux"
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: ${{ matrix.shell}} {0}
 
     steps:
-      - uses: actions/checkout@v3
-
-      - name: submodules
-        run: |
-          git submodule update --init --depth 1 deps/cglm deps/stb deps/cpython deps/cpython-portable
-
       - name: linux setup and dependencies
+        if: matrix.name == 'x86_64_linux'
         run: |
           sudo apt update
-          sudo apt -y install libgtk-3-dev pkgconf libgl-dev libx11-dev libegl-dev
+          sudo apt -y install libgtk-3-dev python3-dev pkgconf libgl-dev libx11-dev libegl-dev libbullet-dev
+
+      - name: msys2 setup
+        uses: msys2/setup-msys2@v2
+        if: matrix.name == 'x86_64_windows'
+        with:
+          msystem: UCRT64
+          update: true
+          pacboy: gcc gtk3 bullet cmake python
+          install: git zip
 
+      - name: fix crlf
+        run: git config --global core.autocrlf input
+
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: submodules
+        run: |
+          git submodule update --init --depth 1 deps/cglm deps/stb deps/mingw-ldd deps/ntldd
+        
       - name: dengine-rc
         run: |
           cmake -S main/dengine-rc -B build/dengine-rc
           cmake --build build/dengine-rc
 
-      - name: linux config, build and install
+      - name: ${{ matrix.name }} config, build and install
         run: |
-          cmake -S . -B build/linux -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_SHARED_LIBS=ON
-          cmake --build build/linux -j$(nproc)
-          cmake --install build/linux --prefix out-linux
+          cmake -S . -B build/${{ matrix.name }} -DBUILD_SHARED_LIBS=ON
+          cmake --build build/${{ matrix.name }} -j$(nproc)
+          cmake --install build/${{ matrix.name }} --prefix out-${{ matrix.name }}
 
-      - name: linux build
-        uses: actions/upload-artifact@v4
-        with:
-          name: linux_build
-          path: out-linux
+      - name: ${{ matrix.name }} zip
+        run: |
+          zip -r ${{ matrix.name }}.zip out-${{ matrix.name }}/
+
+      - name: assets zip 
+        if: matrix.name == 'x86_64_linux'
+        run: |
+          zip -r assets.zip ./assets
 
       - name: assets package
+        if: matrix.name == 'x86_64_linux'
         uses: actions/upload-artifact@v4
         with:
           name: assets package
-          path: ./assets
+          path: assets.zip
+
+          
+      - name: ${{ matrix.name }} build
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.name }}_build
+          path: ${{ matrix.name }}.zip
 
       - name: Set Up JDK
+        if: matrix.name == 'x86_64_linux'
         uses: actions/setup-java@v3
         with:
           distribution: zulu
-          java-version: '17'
+          java-version: '21'
           cache: 'gradle'
 
-      - name: Change wrapper permissions
+      - name: test apk
+        if: matrix.name == 'x86_64_linux'
+        env:
+          ANDROID_KEYSTORE: ${{ secrets.ANDROID_KEYSTORE }}
+          ANDROID_KEYSTORE_ALIAS: ${{ secrets.ANDROID_KEYSTORE_ALIAS }}
+          ANDROID_KEYSTORE_PASSWORD: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
         run: |
-          cd tests/src/testdengine-android/apk
+          git submodule update --init --depth 1 deps/bullet3_src deps/cpython deps/cpython-portable
+          cd ./tests/src/testdengine-android/apk/
+
+          echo "$ANDROID_KEYSTORE" > ks
+          openssl base64 -A -d -in ks -out ks_dec
+          echo "storeFile=$(pwd)/ks_dec" > signing.properties
+          echo "storePassword=$ANDROID_KEYSTORE_PASSWORD" >> signing.properties
+          echo "keyAlias=$ANDROID_KEYSTORE_ALIAS" >> signing.properties
+          echo "keyPassword=$ANDROID_KEYSTORE_PASSWORD" >> signing.properties
+          
           chmod +x ./gradlew
+          ./gradlew assembleRelease
+          ./gradlew assembleDebug
 
-      - name: test apk
+      - name: zip all apks
+        if: matrix.name == 'x86_64_linux'
         run: |
-          git submodule update --init --depth 1 deps/bullet3_src
-          cd ./tests/src/testdengine-android/apk/
-          ./gradlew assembleDebug -x lintVitalAnalyzeRelease -x lintAnalyzeDebug -x lintDebug
+          zip apks.zip  $(find ./tests/src/testdengine-android/apk/app/build/outputs -iname '*.apk')
 
+      - name: all_android apks
+        if: matrix.name == 'x86_64_linux'
+        uses: actions/upload-artifact@v4
+        with:
+          name: all_android_apks
+          path: apks.zip
 
       - name: android build universal
+        if: matrix.name == 'x86_64_linux'
         uses: actions/upload-artifact@v4
         with:
           name: android_universal_debug
           path: ./tests/src/testdengine-android/apk/app/build/outputs/apk/debug/app-universal-debug.apk
 
       - name: android build armebi-v7a
+        if: matrix.name == 'x86_64_linux'
         uses: actions/upload-artifact@v4
         with:
           name: android_armebi-v7a_debug
           path: ./tests/src/testdengine-android/apk/app/build/outputs/apk/debug/app-armeabi-v7a-debug.apk
 
       - name: android build arm64-v8a
+        if: matrix.name == 'x86_64_linux'
         uses: actions/upload-artifact@v4
         with:
           name: android_arm64-v8a_debug
           path: ./tests/src/testdengine-android/apk/app/build/outputs/apk/debug/app-arm64-v8a-debug.apk
 
       - name: android build x86
+        if: matrix.name == 'x86_64_linux'
         uses: actions/upload-artifact@v4
         with:
           name: android_x86_debug
           path: ./tests/src/testdengine-android/apk/app/build/outputs/apk/debug/app-x86-debug.apk
 
       - name: android build x86_64
+        if: matrix.name == 'x86_64_linux'
         uses: actions/upload-artifact@v4
         with:
           name: android_x86_64_debug
           path: ./tests/src/testdengine-android/apk/app/build/outputs/apk/debug/app-x86_64-debug.apk
 
-  build_msys2:
-    runs-on: windows-latest
-    strategy:
-      fail-fast: true
-    defaults:
-      run:
-        shell: msys2 {0}
-            
+  release:
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v3
-
-      - uses: msys2/setup-msys2@v2
+      - name: download all artifacts
+        uses: actions/download-artifact@v4
         with:
-          msystem: UCRT64
-          update: true
-          install: git mingw-w64-ucrt-x86_64-toolchain base-devel mingw-w64-ucrt-x86_64-cmake mingw-w64-ucrt-x86_64-gtk3 mingw-w64-ucrt-x86_64-bullet
+          path: rel
 
-      - name: submodules
+
+      - name: cleanup
         run: |
-          git submodule update --init --depth 1 deps/stb deps/cglm
+          rm $(find -iname '*.apk')
+          unzip -j rel/all_android_apks/apks.zip -d rel
+          rm rel/all_android_apks/apks.zip
 
-      - name: dengine-rc
+      - name: github sha
         run: |
-          cmake -S main/dengine-rc -B build/dengine-rc
-          cmake --build build/dengine-rc
+          echo ${{ github.sha }} > rel/github.sha
 
-      - name: configure, build and install msys2
+      - name: release files list
         run: |
-          cmake -S . -B build/msys2 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_SHARED_LIBS=ON
-          cmake --build build/msys2 -j$(nproc)
-          cmake --install build/msys2 --prefix out-msys2
+          ls rel/**
 
-      - name: msys2 build
-        uses: actions/upload-artifact@v4
+      - name: GitHub Release
+        uses: softprops/action-gh-release@v2
         with:
-          name: msys2_build
-          path: out-msys2
-
+          files: |
+            rel/**

.gitmodules

@@ -19,4 +19,4 @@
 	url = https://github.com/Denzy7/ntldd
 [submodule "deps/mingw-ldd"]
 	path = deps/mingw-ldd
-	url = https://github.com/xantares/mingw-ldd
+	url = https://github.com/nurupo/mingw-ldd

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.16)
 
-project(dengine VERSION 0.8.0)
+project(dengine VERSION 0.8.1)
 
 #this is just a slight nuance with cmake rather than renaming the project
 set(DENGINE_VERSION "${dengine_VERSION}")
@@ -51,6 +51,7 @@ endif()
 find_library(DENGINE_HAS_LIBZ z)
 find_library(DENGINE_HAS_EGL EGL)
 find_package(PkgConfig QUIET)
+
 if(PkgConfig_FOUND AND NOT ANDROID_NDK)
     #link desktop libs
     pkg_check_modules(GTK3 gtk+-3.0)
@@ -274,6 +275,28 @@ endforeach()
 
 configure_file(dengine.pc.in dengine.pc @ONLY)
 
+find_program(ZIP_EXECUTABLE zip)
+if(NOT ZIP_EXECUTABLE)
+    message(WARNING "zip not found. reading installed saved assets won't work!")
+else()
+    execute_process(
+        COMMAND git ls-files assets
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        OUTPUT_VARIABLE ASSET_FILES
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+    string(REPLACE "\n" ";" ASSET_FILE_LIST "${ASSET_FILES}")
+    add_custom_command(
+        OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/assets.zip
+        DEPENDS ${ASSET_FILE_LIST} #does mean file will have to be committed to reflect in cmake. run cmake twice on new asset??
+        COMMAND ${ZIP_EXECUTABLE} -r ${CMAKE_CURRENT_BINARY_DIR}/assets.zip . -x priv/\*
+        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/assets
+        COMMENT "zipping assets into dengine-utils"
+        VERBATIM
+    )
+    add_custom_target(assets_zip ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/assets.zip)
+    install(FILES ${CMAKE_CURRENT_BINARY_DIR}/assets.zip DESTINATION share/dengine-${DENGINE_VERSION})
+endif()
 install(FILES ${PROJECT_BINARY_DIR}/dengine_config/dengine_config.h DESTINATION include/dengine-${DENGINE_VERSION}/dengine_config)
 install(DIRECTORY deps/glad/include/glad DESTINATION include/dengine-${DENGINE_VERSION}/deps/glad)
 install(DIRECTORY deps/glad/include/KHR DESTINATION include/dengine-${DENGINE_VERSION}/deps/glad)

README.md

@@ -63,6 +63,8 @@ Change dir to repo:
 - **Linux**: Its actually very easy here. Just install the modules located in `<CMAKE_BUILD_DIR>/dengine-script-build/modules-build/python-modules`. Install `dengine` directory to your Python `site-packages` or add the directory to your IDE/Editor Python path (VSCode-OSS in this case) 
 - **Windows**: You'll probably have to use the stubs. Unless you managed to build everyting with MSVC, which is usually what upstream python is built on
 
-# github actions artifact releases
-now availabe on github actions! you need to be logged in  
+# github releases
+- Go to the [Releases page](https://github.com/Denzy7/dengine/releases)
+- Preview releases now availabe on github actions! you need to be logged in  
 [check out the latest succesfull build and download artifacts](https://github.com/Denzy7/dengine/actions/workflows/dengine.yml)
+- Releases are only avaiable for x86_64 windows and linux only (aside from android test apk which is available for all architectures)

deps/README.md

@@ -19,13 +19,13 @@ Initialize and get default deps. Consider checking optional deps you might also
 # optional deps
 **If you will be compiling for Windows or Android you might want to get all optional deps to avoid missing libraries and header files**  
 
-**If you want Python scripting, update deps/cpython (will take some time!)**  
+**If you want recompile Python for scripting(usually the case on windows), update deps/cpython (will take some time!)** 
 `... deps/cpython deps/cpython-portable`  
 
 **bullet3 sources only, for cool physics tests (needed to build android apk):**:
 `... deps/bullet3_src`
 
-**if you are cross-compiling from linux to mingw, you'll need the local linux system to have python, pip and the relevant submodules***  
+**if you are cross-compiling from linux to windows with mingw, you'll need the local linux system to have python, pip and the relevant submodules***  
 `... deps/mingw-ldd deps/ntldd`
 
 # python
@@ -50,7 +50,7 @@ On Linux, Building GTK+ 3 is really complicated. However [some really smart peop
 On Windows, you can use the [MSYS2](https://www.msys2.org) toolset to install GTK and build `dengitor`. We'll use `pacboy` to simplyfy
 ```
 pacman -S pactoys git
-pacboy -S gcc cmake gtk3
+pacboy -S gcc gtk3 bullet cmake python
 ```
 
 # others

deps/mingw-ldd

@@ -82,7 +82,7 @@ int dengine_init();
 void dengine_terminate();
 int dengine_update();
 /*!
- * \brief load asset to memory
+ * \brief load asset to memory. mem is heap allocated, so free when done
  * \param path path to asset in android apk or file system or assetdir
  * \param mem destination of loaded asset in memory
  * \param length optional destination length of memory block