Create new appimage workflow

.github/workflows/appimage.yml

@@ -0,0 +1,70 @@
+name: Build MG AppImage
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'version number'
+        required: false
+        type: string
+  push:
+    branches: develop
+  pull_request:
+    branches: develop
+    paths:
+      - '**appimage.yml'
+
+jobs:
+  build-mg-appimage:
+    runs-on: ubuntu-latest
+    env:
+      VERSION: ${{ inputs.version }}
+    strategy:
+      matrix:
+        platform:
+          - linux/amd64
+          - linux/arm64
+
+    steps:
+      - name: Checkout MegaGlest
+        uses: actions/checkout@v4
+
+      - name: Checkout Data
+        uses: actions/checkout@v4
+        with:
+          repository: "megaglest/megaglest-data"
+          path: "data/glest_game"
+
+
+      - if: ${{ ! contains(matrix.platform, 'amd64') }}
+        uses: docker/setup-qemu-action@v3
+
+      - name: Build AppImage
+        run: |
+          export HOSTUID=$(id -u) HOSTGID=$(id -g)
+          docker compose -f mk/linux/docker/docker-compose.yml run --rm build
+        env:
+          PLATFORM: ${{ matrix.platform }}
+          CC: clang
+          CXX: clang++
+
+      - name: Create sha256sum
+        run: |
+          for file in *.AppImage; do
+            sha256sum "$file" > "$file.sha256sum";
+          done
+
+      - name: Artifact Filename
+        run: |
+          PLATFORM=${{ matrix.platform }}
+          echo "ARTIFACT_NAME=AppImages-${PLATFORM//\//-}" >> $GITHUB_ENV
+
+      - name: Upload AppImage
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.ARTIFACT_NAME }}
+          path: ./*AppImage*
+          if-no-files-found: error

.gitignore

@@ -13,6 +13,14 @@ Session.vim
 # Emacs
 \#*\#
 
+# AppImage
+CMakeFiles/
+_build_appimage/
+
+# These are output to the source root when the appimage script is run:
+#/xml2g
+#/g2xml
+
 ## macOS
 *.DS_Store
 Icon

CMakeLists.txt

@@ -74,6 +74,7 @@ OPTION(BUILD_MEGAGLEST_MODEL_VIEWER "Build model viewer" ON)
 OPTION(BUILD_MEGAGLEST_MAP_EDITOR "Build map editor" ON)
 OPTION(BUILD_MEGAGLEST "Build MegaGlest" ON)
 OPTION(BUILD_MEGAGLEST_TESTS "Build MegaGlest Unit Tests" OFF)
+OPTION(INCLUDE_DATA "Include Game Data in build. If true but no data present, data will be skipped." ON)
 OPTION(WANT_SINGLE_INSTALL_DIRECTORY "Use single install directory for everything. It is useful for example for MacOS cpack bundles." OFF)
 OPTION(WANT_APPIMAGE "Enable AppImage compatibility" ON)
 OPTION(WANT_STATIC_LIBS "Builds as many static libs as possible." OFF)
@@ -157,7 +158,7 @@ IF(CMAKE_COMPILER_IS_GNUCXX OR MINGW OR MSVC)
 	IF(NOT WANT_APPIMAGE)
 		MESSAGE(STATUS "**Disable appimage code.")
 		ADD_DEFINITIONS(-DNO_APPIMAGE)
-	ELSEIF((NOT EXISTS "${PROJECT_SOURCE_DIR}/data/glest_game/CMakeLists.txt") AND "${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
+	ELSEIF((NOT INCLUDE_DATA OR NOT EXISTS "${PROJECT_SOURCE_DIR}/data/glest_game/CMakeLists.txt") AND "${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
 		MESSAGE(STATUS "**AppImage compatiblity + nodata wanted. Adding flag \"APPIMAGE_NODATA\".")
 		ADD_DEFINITIONS(-DAPPIMAGE_NODATA)
 	ENDIF()
@@ -509,7 +510,7 @@ IF(EXISTS "${PROJECT_SOURCE_DIR}/source/")
 ENDIF()
 
 # Check if data exist
-IF(EXISTS "${PROJECT_SOURCE_DIR}/data/glest_game/CMakeLists.txt")
+IF(INCLUDE_DATA AND EXISTS "${PROJECT_SOURCE_DIR}/data/glest_game/CMakeLists.txt")
     MESSAGE(STATUS "**Found game data.")
 	ADD_SUBDIRECTORY( ${PROJECT_SOURCE_DIR}/data/glest_game )
 ENDIF()
@@ -526,7 +527,7 @@ IF(NOT DEFINED CPACK_GENERATOR)
 ENDIF()
 # CPack configuration shared accross platforms
 SET(CPACK_PACKAGE_NAME ${PKG_NAME})
-IF(EXISTS "${PROJECT_SOURCE_DIR}/data/glest_game/others/megaglest-long-description.txt.in")
+IF(INCLUDE_DATA AND EXISTS "${PROJECT_SOURCE_DIR}/data/glest_game/others/megaglest-long-description.txt.in")
 	FILE(READ "${PROJECT_SOURCE_DIR}/data/glest_game/others/megaglest-long-description.txt.in" MEGAGLEST_LONG_DESCRIPTION)
 	SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${MEGAGLEST_LONG_DESCRIPTION}")
 ELSE()

mk/linux/AppRun

@@ -0,0 +1,22 @@
+#! /usr/bin/env bash
+
+set -e
+
+HERE="$(readlink -f "$(dirname "$0")")"
+
+BINARY_NAME="megaglest"
+
+if [ "$MG_BIN" = "editor" ]; then
+  BINARY_NAME="megaglest_editor"
+elif [ "$MG_BIN" = "viewer" ]; then
+  BINARY_NAME="megaglest_g3dviewer"
+fi
+
+echo "To invoke the map editor:"
+echo "MG_BIN=editor $0"
+echo ""
+echo "To invoke the g3d model viewer:"
+echo "MG_BIN=viewer $0"
+echo ""
+
+exec "$HERE/usr/bin/$BINARY_NAME" "$@"

mk/linux/build-appimage.sh

@@ -1,120 +1,160 @@
 #!/bin/sh
 
-set -e
-
-# SCRIPTLOC=$(dirname "$0")
-SCRIPTLOC="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
-
-if [ ! -f $TOOLS_DIR/squashfs-root/AppRun ]; then
-    echo "Please specify the path to the extracted linuxdeploy (squashfs-root) using \$TOOLS_DIR env variable."
-    exit -1
+# To test this script locally, from the source root directory,
+# you can use:
+#
+# docker run -it --rm -e HOSTUID=$(id -u) -e \
+# -v $PWD:/workspace -w /workspace andy5995/linuxdeploy:v2-focal bash
+#
+# Normally 'bash' can be replaced with the /path/to/script but starting
+# the container from a shell means you can run the script manually in the
+# container and then fix any problems, then re-run the script (hint: the
+# dependencies will be installed the first time, and not have to be installed
+# on subsequent attempts).
+#
+# Then: 'su - builder' (preserve some environmental variables with '-')
+# 'bash'
+# 'export VERSION=snapshot'
+# 'cd /workspace'
+# 'mk/linux/build-appimage.sh'
+
+set -ev
+
+if [ -z "$VERSION" ]; then
+  echo "VERSION must be set"
+  exit 1
 fi
 
-mkdir -p $SCRIPTLOC/BuildAppImage/game
-cd $SCRIPTLOC/BuildAppImage/game
-
-if [ -d $SCRIPTLOC/BuildAppImage/game/AppDir ]; then
-    rm -r $SCRIPTLOC/BuildAppImage/game/AppDir
+# Check if the workspace path is absolute
+if [[ "$WORKSPACE" != /* ]]; then
+  echo "The workspace path must be absolute"
+  exit 1
 fi
+test -d "$WORKSPACE"
 
-cmake ../../../.. -DBUILD_MEGAGLEST_MODEL_VIEWER=OFF -DBUILD_MEGAGLEST_MAP_EDITOR=OFF -DBUILD_MEGAGLEST_MODEL_IMPORT_EXPORT_TOOLS=OFF
-make DESTDIR=AppDir -j$(nproc) install
-strip AppDir/usr/local/bin/megaglest
+# Used by linuxdeploy when it sets the filename
+export LINUXDEPLOY_OUTPUT_VERSION="$VERSION"
 
-if [ ! -d AppDir/usr/bin ]; then
-    mkdir -p AppDir/usr/bin
-fi
+APPIMAGE_BUILD_DIR="$WORKSPACE/_build_appimage"
+INST_PREFIX="usr"
 
-cp $(whereis 7z | awk -F ' ' '{print $2;}') AppDir/usr/bin/
-# Hacky workaround to use internal 7z.
-sed -i 's#=7z#=$APPLICATIONPATH/7z#' AppDir/usr/local/share/megaglest/glest.ini
+#if [ -n "$DO_CLEAN_BUILD" ] && [ -d $APPIMAGE_BUILD_DIR ]; then
+  #rm -rf $APPIMAGE_BUILD_DIR
+#fi
 
-if [ ! -f AppDir/usr/local/share/applications/megaglest.desktop ]; then 
-    wget -P AppDir/usr/local/share/applications/ https://raw.githubusercontent.com/MegaGlest/megaglest-data/develop/others/desktop/megaglest.desktop;
+if [ ! -d "$APPIMAGE_BUILD_DIR" ]; then
+  mkdir -p "$APPIMAGE_BUILD_DIR"
 fi
 
-convert AppDir/usr/local/share/megaglest/megaglest.ico megaglest.png
-mv megaglest-2.png megaglest.png
-
-$TOOLS_DIR/squashfs-root/AppRun -d AppDir/usr/local/share/applications/megaglest.desktop \
-  --icon-file=megaglest.png \
-   --icon-filename=megaglest --executable AppDir/usr/local/bin/megaglest --appdir AppDir --output appimage
-
-mv MegaGlest*.AppImage $SCRIPTLOC
-
-# MapEditor
-mkdir -p $SCRIPTLOC/BuildAppImage/mapeditor
-cd $SCRIPTLOC/BuildAppImage/mapeditor
-
-if [ -d $SCRIPTLOC/BuildAppImage/mapeditor/AppDir ]; then
-    rm -r $SCRIPTLOC/BuildAppImage/mapeditor/AppDir
-fi
+sudo DEBIAN_FRONTEND=noninteractive -i sh -c \
+  "apt update &&
+  apt upgrade -y &&
+  apt install --no-install-recommends -y
+    build-essential
+    $CC
+    libcurl4-gnutls-dev
+    libsdl2-dev
+    libopenal-dev
+    liblua5.3-dev
+    libjpeg-dev
+    libpng-dev
+    libfreetype6-dev
+    libwxgtk3.0-gtk3-dev
+    libcppunit-dev
+    libfribidi-dev
+    libftgl-dev
+    libglew-dev
+    libogg-dev
+    libvorbis-dev
+    libminiupnpc-dev
+    libircclient-dev
+    libxml2-dev
+    libx11-dev
+    libgl1-mesa-dev
+    libglu1-mesa-dev
+    librtmp-dev
+    libkrb5-dev
+    libldap2-dev
+    libidn2-dev
+    libpsl-dev
+    libgnutls28-dev
+    libnghttp2-dev
+    libssh-dev
+    libbrotli-dev
+    p7zip-full
+    imagemagick"
+
+cd "$APPIMAGE_BUILD_DIR"
+cmake $WORKSPACE \
+  -DCMAKE_INSTALL_PREFIX=/$INST_PREFIX \
+  -DBUILD_MEGAGLEST_MODEL_IMPORT_EXPORT_TOOLS=OFF
+make DESTDIR=$APPIMAGE_BUILD_DIR/AppDir -j$(nproc) install
+# This is done by linuxdeploy
+# strip AppDir/$INST_PREFIX/local/bin/megaglest
+
+cp $(whereis 7z | awk -F ' ' '{print $2;}') $APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/bin/
+# Hacky workaround to use internal 7z.
+sed -i 's#=7z#=$APPLICATIONPATH/7z#' AppDir/$INST_PREFIX/share/megaglest/glest.ini
 
-cmake ../../../.. -DBUILD_MEGAGLEST=OFF -DBUILD_MEGAGLEST_MODEL_VIEWER=OFF -DBUILD_MEGAGLEST_MAP_EDITOR=ON -DBUILD_MEGAGLEST_MODEL_IMPORT_EXPORT_TOOLS=OFF
-make DESTDIR=AppDir -j$(nproc) install
-strip AppDir/usr/local/bin/megaglest_editor
+GAME_DESKTOP_DEST="$APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/share/applications"
 
-if [ ! -d AppDir/usr/bin ]; then
-    mkdir -p AppDir/usr/bin
+if [ ! -d "$GAME_DESKTOP_DEST" ]; then
+  mkdir -p "$GAME_DESKTOP_DEST"
 fi
 
-if [ ! -f AppDir/usr/local/share/applications/megaglest_editor.desktop ]; then 
-    wget -P AppDir/usr/local/share/applications/ https://raw.githubusercontent.com/MegaGlest/megaglest-data/develop/others/desktop/megaglest_editor.desktop;
+if [ ! -f "$GAME_DESKTOP_DEST/megaglest.desktop" ]; then
+  cp "$WORKSPACE/data/glest_game/others/desktop/megaglest.desktop" "$GAME_DESKTOP_DEST"
 fi
 
-convert AppDir/usr/local/share/megaglest/editor.ico editor.png
-mv editor-2.png editor.png
-# Another stupid hack to fix icons.
-sed -i 's#Icon=megaglest#Icon=editor#' AppDir/usr/local/share/applications/megaglest_editor.desktop
-
-ln -s $TOOLS_DIR/linuxdeploy-plugin-gtk.sh .
-
-$TOOLS_DIR/squashfs-root/AppRun -d AppDir/usr/local/share/applications/megaglest_editor.desktop \
-  --icon-file=editor.png \
-   --icon-filename=editor --executable AppDir/usr/local/bin/megaglest_editor --appdir AppDir --plugin gtk --output appimage
-
-mv MegaGlest*.AppImage $SCRIPTLOC
+convert $APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/share/megaglest/megaglest.ico megaglest.png
+mv megaglest-2.png megaglest.png
 
-# G3D viewer
-mkdir -p $SCRIPTLOC/BuildAppImage/g3dviewer
-cd $SCRIPTLOC/BuildAppImage/g3dviewer
+MAP_EDITOR_DESKTOP_DEST="$APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/share/applications"
+if [ ! -d "$MAP_EDITOR_DESKTOP_DEST" ]; then
+  mkdir -p "$MAP_EDITOR_DESKTOP_DEST"
+fi
 
-if [ -d $SCRIPTLOC/BuildAppImage/g3dviewer/AppDir ]; then
-    rm -r $SCRIPTLOC/BuildAppImage/g3dviewer/AppDir
+if [ ! -f "$MAP_EDITOR_DESKTOP_DEST/megaglest_editor.desktop" ]; then
+  cp "$WORKSPACE/data/glest_game/others/desktop/megaglest_editor.desktop" "$MAP_EDITOR_DESKTOP_DEST"
+  # Another stupid hack to fix icons.
+  sed -i 's#Icon=megaglest#Icon=editor#' $MAP_EDITOR_DESKTOP_DEST/megaglest_editor.desktop
 fi
 
-cmake ../../../.. -DBUILD_MEGAGLEST=OFF -DBUILD_MEGAGLEST_MODEL_VIEWER=ON -DBUILD_MEGAGLEST_MAP_EDITOR=OFF -DBUILD_MEGAGLEST_MODEL_IMPORT_EXPORT_TOOLS=OFF
-make DESTDIR=AppDir -j$(nproc) install
-strip AppDir/usr/local/bin/megaglest_g3dviewer
+#convert $APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/share/megaglest/editor.ico editor.png
+#mv editor-2.png editor.png
 
-if [ ! -d AppDir/usr/bin ]; then
-    mkdir -p AppDir/usr/bin
+G3DVIEWER_DESKTOP_DEST="$APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/share/applications"
+if [ ! -d "$G3DVIEWER_DESKTOP_DEST" ]; then
+  mkdir -p "$G3DVIEWER_DESKTOP_DEST"
 fi
 
-if [ ! -f AppDir/usr/local/share/applications/megaglest_g3dviewer.desktop ]; then 
-    wget -P AppDir/usr/local/share/applications/ https://raw.githubusercontent.com/MegaGlest/megaglest-data/develop/others/desktop/megaglest_g3dviewer.desktop;
+if [ ! -f "$G3DVIEWER_DESKTOP_DEST/megaglest_g3dviewer.desktop" ]; then
+  cp "$WORKSPACE/data/glest_game/others/desktop/megaglest_g3dviewer.desktop" "$G3DVIEWER_DESKTOP_DEST"
+  # Another stupid hack to fix icons.
+  sed -i 's#Icon=megaglest#Icon=g3dviewer#' $G3DVIEWER_DESKTOP_DEST/megaglest_g3dviewer.desktop
 fi
 
-convert AppDir/usr/local/share/megaglest/g3dviewer.ico g3dviewer.png
-mv g3dviewer-2.png g3dviewer.png
-# Another stupid hack to fix icons.
-sed -i 's#Icon=megaglest#Icon=g3dviewer#' AppDir/usr/local/share/applications/megaglest_g3dviewer.desktop
+#convert $APPIMAGE_BUILD_DIR/AppDir/$INST_PREFIX/share/megaglest/g3dviewer.ico g3dviewer.png
+#mv g3dviewer-2.png g3dviewer.png
 
-ln -s $TOOLS_DIR/linuxdeploy-plugin-gtk.sh .
-
-$TOOLS_DIR/squashfs-root/AppRun -d AppDir/usr/local/share/applications/megaglest_g3dviewer.desktop \
-  --icon-file=g3dviewer.png \
-   --icon-filename=g3dviewer --executable AppDir/usr/local/bin/megaglest_g3dviewer --appdir AppDir --plugin gtk --output appimage
+linuxdeploy -d $GAME_DESKTOP_DEST/megaglest.desktop \
+  --icon-file=megaglest.png \
+  --icon-filename=megaglest \
+  --custom-apprun="$WORKSPACE/mk/linux/AppRun" \
+  --executable AppDir/$INST_PREFIX/bin/megaglest \
+  --appdir AppDir \
+  --plugin gtk \
+  --output appimage
 
-mv MegaGlest*.AppImage $SCRIPTLOC
+mv MegaGlest*.AppImage "$WORKSPACE"
 
 # Tools
-mkdir -p $SCRIPTLOC/BuildAppImage/tools
-cd $SCRIPTLOC/BuildAppImage/tools
+#mkdir -p $APPIMAGE_BUILD_DIR/tools
+#cd $APPIMAGE_BUILD_DIR/tools
 
-cmake ../../../.. -DBUILD_MEGAGLEST=OFF -DBUILD_MEGAGLEST_MODEL_VIEWER=OFF -DBUILD_MEGAGLEST_MAP_EDITOR=OFF -DBUILD_MEGAGLEST_MODEL_IMPORT_EXPORT_TOOLS=ON
-make -j$(nproc)
+#cmake $WORKSPACE -DBUILD_MEGAGLEST=OFF -DBUILD_MEGAGLEST_MODEL_VIEWER=OFF -DBUILD_MEGAGLEST_MAP_EDITOR=OFF -DBUILD_MEGAGLEST_MODEL_IMPORT_EXPORT_TOOLS=ON
+#make -j$(nproc)
 
-strip source/tools/glexemel/g2xml source/tools/glexemel/xml2g
-mv source/tools/glexemel/g2xml $SCRIPTLOC 
-mv source/tools/glexemel/xml2g $SCRIPTLOC 
+#strip source/tools/glexemel/g2xml source/tools/glexemel/xml2g
+#mv source/tools/glexemel/g2xml $WORKSPACE
+#mv source/tools/glexemel/xml2g $WORKSPACE