Merge https://github.com/supertuxkart/stk-code into command-manager-prototype at 1.4-rc1

Author: kimden

.github/workflows/windows.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        arch: [i686, x86_64, aarch64]
+        arch: [i686, x86_64, armv7, aarch64]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -31,6 +31,8 @@ jobs:
             echo "cmake_arch=Win32" >> $GITHUB_ENV
           elif [ ${{ matrix.arch }} = "x86_64" ]; then
             echo "cmake_arch=x64" >> $GITHUB_ENV
+          elif [ ${{ matrix.arch }} = "armv7" ]; then
+            echo "cmake_arch=ARM" >> $GITHUB_ENV
           else
             echo "cmake_arch=ARM64" >> $GITHUB_ENV
           fi
@@ -83,8 +85,8 @@ jobs:
           sudo wget https://github.com/supertuxkart/dependencies/releases/download/preview/mxe_static_mingw.zip
           sudo unzip mxe_static_mingw.zip
           sudo rm mxe_static_mingw.zip
-      - name: Install MinGW for aarch64
-        if: ${{ matrix.os == 'ubuntu-latest' && matrix.arch == 'aarch64' }}
+      - name: Install MinGW for armv7 or aarch64
+        if: ${{ matrix.os == 'ubuntu-latest' && ( matrix.arch == 'armv7' || matrix.arch == 'aarch64' ) }}
         run: |
           cd /
           sudo wget https://github.com/mstorsjo/llvm-mingw/releases/download/20210423/llvm-mingw-20210423-msvcrt-ubuntu-18.04-x86_64.tar.xz
@@ -120,17 +122,17 @@ jobs:
           cd build
           cmake .. -G "Visual Studio 17 2022" -DCMAKE_SYSTEM_NAME=Windows -DCMAKE_SYSTEM_PROCESSOR=${{ matrix.arch }} -A ${{ env.cmake_arch }} -DCHECK_ASSETS=OFF
       - name: Configure bulid for MinGW (i686 or x86_64)
-        if: ${{ matrix.os == 'ubuntu-latest' && matrix.arch != 'aarch64' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.arch != 'armv7' && matrix.arch != 'aarch64' }}
         run: |
           mkdir -p build
           cd build
           cmake .. -DCMAKE_TOOLCHAIN_FILE=../toolchain.cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCHECK_ASSETS=OFF -DUSE_DIRECTX=ON
-      - name: Configure bulid for MinGW (aarch64)
-        if: ${{ matrix.os == 'ubuntu-latest' && matrix.arch == 'aarch64' }}
+      - name: Configure bulid for MinGW (armv7 or aarch64)
+        if: ${{ matrix.os == 'ubuntu-latest' && ( matrix.arch == 'armv7' || matrix.arch == 'aarch64' ) }}
         run: |
           mkdir -p build
           cd build
-          cmake .. -DLLVM_ARCH=aarch64 -DLLVM_PREFIX=/llvm-mingw -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-llvm-mingw.cmake -DCHECK_ASSETS=OFF -DUSE_DIRECTX=ON
+          cmake .. -DLLVM_ARCH=${{ matrix.arch }} -DLLVM_PREFIX=/llvm-mingw -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-llvm-mingw.cmake -DCHECK_ASSETS=OFF -DUSE_DIRECTX=ON
       - name: Build for MSVC
         if: ${{ matrix.os == 'windows-latest' }}
         working-directory: build
@@ -238,11 +240,14 @@ jobs:
           mv tools/run_game.bat SuperTuxKart-${{ env.release_tag }}-win
           mkdir SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-i686
           mkdir SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-x86_64
+          mkdir SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-armv7
           mkdir SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-aarch64
           mv i686 SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-i686/bin
           mv x86_64 SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-x86_64/bin
+          mv armv7 SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-armv7/bin
           mv aarch64 SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-aarch64/bin
           # libwinpthread-1.dll is useless because we statically link
+          rm -f SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-armv7/bin/libwinpthread-1.dll
           rm -f SuperTuxKart-${{ env.release_tag }}-win/stk-code/build-aarch64/bin/libwinpthread-1.dll
       - name: Start packaging STK
         if: ${{ env.release_tag != '' }}

.gitignore

@@ -89,5 +89,6 @@ lib/openssl
 lib/harfbuzz
 lib/sdl2
 lib/mbedtls
+lib/astc-encoder
 
 .DS_Store

CMakeLists.txt

@@ -106,7 +106,8 @@ endif()
 
 if((UNIX AND NOT APPLE) AND NOT SERVER_ONLY)
     if((${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm") OR 
-       (${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64"))
+       (${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64") OR
+       (${CMAKE_SYSTEM_PROCESSOR} MATCHES "riscv64"))
         option(USE_GLES2 "Use OpenGL ES2 renderer" ON)
     else()
         option(USE_GLES2 "Use OpenGL ES2 renderer" OFF)
@@ -165,6 +166,8 @@ if (CMAKE_GENERATOR_PLATFORM)
 endif()
 if(arch_lower MATCHES "arm64" OR arch_lower MATCHES "aarch64" OR ${CMAKE_GENERATOR} MATCHES "(ARM64)" OR ${BUILD_ARCH} MATCHES "(ARM64)")
     set(DEPENDENCIES "dependencies-win-aarch64")
+elseif(arch_lower MATCHES "armv7" OR arch_lower MATCHES "armv7" OR ${CMAKE_GENERATOR} MATCHES "(ARM)" OR ${BUILD_ARCH} MATCHES "(ARM)")
+    set(DEPENDENCIES "dependencies-win-armv7")
 elseif(CMAKE_SIZEOF_VOID_P EQUAL 8)
     set(DEPENDENCIES "dependencies-win-x86_64")
 else()
@@ -259,9 +262,52 @@ else()
 endif()
 
 if(NOT SERVER_ONLY)
+    if(USE_SYSTEM_SQUISH)
+        find_library(SQUISH_LIBRARY NAMES squish libsquish)
+        find_path(SQUISH_INCLUDEDIR NAMES squish.h PATHS)
+    endif()
+    if (NOT SQUISH_LIBRARY OR NOT SQUISH_INCLUDEDIR)
+        add_subdirectory("${PROJECT_SOURCE_DIR}/lib/libsquish")
+        include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/libsquish")
+        SET(SQUISH_LIBRARY squish)
+    else()
+        include_directories("${SQUISH_INCLUDEDIR}")
+        MESSAGE(STATUS "Use system libsquish: ${SQUISH_LIBRARY}")
+    endif()
+endif()
+
+if(NOT SERVER_ONLY)
+    find_library(SHADERC_LIBRARY NAMES shaderc_shared libshaderc_shared)
+    find_path(SHADERC_INCLUDEDIR NAMES shaderc/shaderc.hpp PATHS)
+    if (NOT SHADERC_LIBRARY OR NOT SHADERC_INCLUDEDIR)
+        set(SHADERC_SKIP_INSTALL ON CACHE INTERNAL "Skip installation" FORCE)
+        set(SHADERC_SKIP_TESTS ON CACHE INTERNAL "Skip building tests" FORCE)
+        set(SHADERC_SKIP_EXAMPLES ON CACHE INTERNAL "Skip building examples" FORCE)
+        set(SHADERC_SKIP_COPYRIGHT_CHECK ON CACHE INTERNAL "Skip copyright check" FORCE)
+
+        set(SPIRV_HEADERS_SKIP_INSTALL ON CACHE INTERNAL "Skip install" FORCE)
+        set(SPIRV_HEADERS_SKIP_EXAMPLES ON CACHE INTERNAL "Skip building examples" FORCE)
+
+        set(SKIP_SPIRV_TOOLS_INSTALL ON CACHE INTERNAL "Skip installation" FORCE)
+        set(SPIRV_SKIP_TESTS ON CACHE INTERNAL "Skip tests" FORCE)
+        set(SPIRV_SKIP_EXECUTABLES ON CACHE INTERNAL "Skip executables" FORCE)
+
+        set(ENABLE_GLSLANG_BINARIES OFF CACHE INTERNAL "Builds glslangValidator and spirv-remap" FORCE)
+        set(ENABLE_CTEST OFF CACHE INTERNAL "Enable ctest" FORCE)
+
+        add_subdirectory("${PROJECT_SOURCE_DIR}/lib/shaderc")
+        include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/shaderc/libshaderc/include")
+        SET(SHADERC_LIBRARY shaderc)
+        message(STATUS "System shaderc not found, use the bundled one.")
+    else()
+        include_directories("${SHADERC_INCLUDEDIR}")
+        MESSAGE(STATUS "Use system shaderc: ${SHADERC_LIBRARY}")
+    endif()
+
     add_subdirectory("${PROJECT_SOURCE_DIR}/lib/graphics_engine")
-    include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/graphics_engine/include")
 endif()
+# MiniGLM is there
+include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/graphics_engine/include")
 
 if (NOT SERVER_ONLY)
     # Add jpeg library
@@ -310,21 +356,6 @@ else()
     MESSAGE(STATUS "Use system libmcpp: ${MCPP_LIBRARY}")
 endif()
 
-if(NOT SERVER_ONLY)
-    if(USE_SYSTEM_SQUISH)
-        find_library(SQUISH_LIBRARY NAMES squish libsquish)
-        find_path(SQUISH_INCLUDEDIR NAMES squish.h PATHS)
-    endif()
-    if (NOT SQUISH_LIBRARY OR NOT SQUISH_INCLUDEDIR)
-        add_subdirectory("${PROJECT_SOURCE_DIR}/lib/libsquish")
-        include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/libsquish")
-        SET(SQUISH_LIBRARY squish)
-    else()
-        include_directories("${SQUISH_INCLUDEDIR}")
-        MESSAGE(STATUS "Use system libsquish: ${SQUISH_LIBRARY}")
-    endif()
-endif()
-
 if (NOT SERVER_ONLY)
     # SDL2
     find_library(SDL2_LIBRARY NAMES SDL2 libSDL2)
@@ -365,7 +396,7 @@ if(USE_WIIUSE)
         if(WIIUSE_BUILD)
             add_subdirectory("${PROJECT_SOURCE_DIR}/lib/wiiuse")
         endif()
-        include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/wiiuse/src")
+        include_directories(BEFORE "${PROJECT_SOURCE_DIR}/lib/wiiuse/src/include")
         set(WIIUSE_LIBRARIES "wiiuse" "bluetooth")
     endif()
 endif()
@@ -574,7 +605,7 @@ if(APPLE AND NOT IOS)
 
     if(CMAKE_GENERATOR MATCHES "Xcode")
         add_custom_command(TARGET supertuxkart POST_BUILD
-            COMMAND ln -f -s ${PROJECT_SOURCE_DIR}/data ${CMAKE_BINARY_DIR}/bin/\${CONFIGURATION}/supertuxkart.app/Contents/Resources)
+            COMMAND ln -f -s ${PROJECT_SOURCE_DIR}/data ${CMAKE_BINARY_DIR}/\${CONFIGURATION}/supertuxkart.app/Contents/Resources)
     else()
         add_custom_command(TARGET supertuxkart POST_BUILD
             COMMAND ln -f -s ${PROJECT_SOURCE_DIR}/data ${CMAKE_BINARY_DIR}/bin/supertuxkart.app/Contents/Resources)
@@ -725,6 +756,10 @@ if (${CMAKE_SYSTEM_NAME} MATCHES "SunOS")
 	target_link_libraries(supertuxkart nsl socket vorbisfile)
 endif()
 
+if (${CMAKE_SYSTEM_NAME} MATCHES "Haiku")
+	target_link_libraries(supertuxkart be network vorbisfile)
+endif()
+
 if (USE_DNS_C)
     target_link_libraries(supertuxkart dnsc)
 else()
@@ -769,7 +804,8 @@ if(NOT SERVER_ONLY)
         graphics_utils
         graphics_engine
         ${SDL2_LIBRARY}
-        tinygettext)
+        tinygettext
+        ${SHADERC_LIBRARY})
 endif()
 
 if(UNIX AND NOT APPLE)

INSTALL.md

@@ -137,7 +137,7 @@ location, specify `CMAKE_INSTALL_PREFIX` when running cmake, e.g.:
 
 ## Building SuperTuxKart on Windows
 
-To Build SuperTuxKart on Windows, follow these instructions:
+To Build SuperTuxKart on Windows, first you need to install [Python](https://www.python.org/downloads/windows/) for [shaderc](https://github.com/google/shaderc) used by SuperTuxKart, after installing Python (if needed) follow these instructions:
 
 1. Download and install Visual Studio from here: [Visual Studio - Download](https://www.visualstudio.com/downloads/). The free Visual Studio Community edition works fine. Remember to select "Desktop development with C++" in the installer.
 
@@ -150,7 +150,7 @@ Open your file browser and find somewhere you want to put the development versio
 4. If you got the stable version, download the Windows dependencies package from [SuperTuxKart on GitHub - Dependencies Releases](https://github.com/supertuxkart/dependencies/releases), find the stk-code version there and download the `dependencies(arch).zip` as needed and unpack the archive into the `stk-code` directory.
 
 5. If you got the development version go to SuperTuxKart-dev in your file browser, then visit [SuperTuxKart on GitHub - Dependencies latest preview release](https://github.com/supertuxkart/dependencies/releases/tag/preview)
-and unpack the archive into the `stk-code` directory. Download `i686` if you use Win32 generator of MSVC, `x86_64` for x64 and `aarch64` for ARM64.
+and unpack the archive into the `stk-code` directory. Download `i686` if you use Win32 generator of MSVC, `x86_64` for x64, `armv7` for ARM and `aarch64` for ARM64.
 
 6. Download CMake from here: [CMake - download page](https://cmake.org/download/), install it; once CMake is installed, double click on the CMake icon on your desktop, and point it towards your `stk-code` directory in the 'Where is the source code' field, and point 'Where to build the binaries' to a new directory called `build` or `bld` inside the stk-code directory.
 
@@ -180,7 +180,7 @@ Visual Studio 2013| 13
 2. Download a source package from either [SuperTuxKart on GitHub](https://github.com/supertuxkart/stk-code/releases) or [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control)
 NOTE: the `stk-code` and `stk-assets` directories **must** be in the same directory, `stk-assets` is not needed if you download the full source tarball `(SuperTuxKart-version-src.tar.xz)`.
 3. Download the Windows dependencies package from [SuperTuxKart on GitHub - Dependencies latest preview release](https://github.com/supertuxkart/dependencies/releases/tag/preview)
-and unpack the archive into the `stk-code` directory. Download `i686` if you use Win32 generator of MSVC, `x86_64` for x64 and `aarch64` for ARM64.
+and unpack the archive into the `stk-code` directory. Download `i686` if you use Win32 generator of MSVC, `x86_64` for x64, `armv7` for ARM and `aarch64` for ARM64.
 4. Download CMake from here: [CMake - download page](https://cmake.org/download/); and install it. Navigate to the `stk-code` directory; and create an directory called "build":
 
     ```cmd
@@ -196,12 +196,34 @@ and unpack the archive into the `stk-code` directory. Download `i686` if you use
 
 6. Now that CMake finished configuring and creating the necessary files for the build, run the build command in the same directory:
 
-```cmd
-msbuild.exe SuperTuxKart.sln
-```
+    ```cmd
+    msbuild.exe SuperTuxKart.sln
+    ```
 
 SuperTuxKart can now be run as `bin\Debug\supertuxkart.exe` or `bin\Release\supertuxkart.exe`
 
+## Building SuperTuxKart on Windows using LLVM MinGW
+
+1. Get the LLVM Mingw archive [here](https://github.com/mstorsjo/llvm-mingw/releases/latest), get the `*-msvcrt-i686.zip or` `*-msvcrt-x86_64.zip` depending on whether you have an Intel / AMD 32 or 64-bit Windows. If you are using ARM64 Windows get the `*-msvcrt-i686.zip` should be fine (untested). After downloading extract it as `C:\llvm-mingw` so `C:\llvm-mingw` contains `bin`, `include`, `lib`, etc.
+2. Get Ninja [here](https://github.com/ninja-build/ninja/releases/latest), download the `ninja-win.zip` and extract the `ninja.exe` from the archive to `C:\llvm-mingw`. If you are not using Intel / AMD 64-bit Windows use [this link](https://packages.msys2.org/package/mingw-w64-i686-ninja) and extract `mingw32\bin\ninja.exe` inside the `tar.zst`.
+3. Download a source package from either [SuperTuxKart on GitHub](https://github.com/supertuxkart/stk-code/releases) or [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control)
+NOTE: the `stk-code` and `stk-assets` directories **must** be in the same directory, `stk-assets` is not needed if you download the full source tarball `(SuperTuxKart-version-src.tar.xz)`. Also make sure they lie within the C drive.
+4. Download the Windows dependencies package from [SuperTuxKart on GitHub - Dependencies latest preview release](https://github.com/supertuxkart/dependencies/releases/tag/preview)
+and unpack the archive into the `stk-code` directory. Download `i686` if you compile for Intel / AMD 32-bit, `x86_64` for Intel / AMD 64-bit, `armv7` for ARM 32-bit and `aarch64` for ARM 64-bit version of Windows.
+6. Download CMake from here: [CMake - download page](https://cmake.org/download/), install it; once CMake is installed, double click on the CMake icon on your desktop, and point it towards your `stk-code` directory in the 'Where is the source code' field, and point 'Where to build the binaries' to a new directory called `build` inside the stk-code directory.
+7. Press the `Add Entry` button and add the values below:
+* Name: `LLVM_ARCH` Type: `STRING`  Value: `i686`, `x86_64`, `armv7` or `aarch64`
+* Name: `LLVM_PREFIX` Type: `STRING`  Value: `C:/llvm-mingw`
+* Name: `CMAKE_MAKE_PROGRAM` Type: `STRING` Value: `C:/llvm-mingw/ninja.exe`
+* Name: `USE_WIIUSE` Type: `BOOL`  Value: `Empty (unchecked)`
+8. Press 'Configure'; CMake will ask you if it is OK to create the aforementioned directory, press `Yes`. Choose `Ninja` from `Specify the generator for this project`, choose `Specify toolchain file for cross-compiling` then press `Next`. Specify the toolchain file which is located in `stk-code\cmake\Toolchain-llvm-mingw.cmake` and press `Finish`. If no error appears then press 'Generate'
+9. Once inside the build directory using command line `cmd.exe` or PowerShell:
+    ```cmd
+    C:\llvm-mingw\ninja.exe
+    ```
+
+SuperTuxKart can now be run as `bin\supertuxkart.exe`.
+
 ## Building SuperTuxKart on macOS
 
 ### Getting Started

android/Android.mk

@@ -93,6 +93,27 @@ include $(PREBUILT_STATIC_LIBRARY)
 include $(CLEAR_VARS)
 
 
+# shaderc
+LOCAL_MODULE       := shaderc
+LOCAL_SRC_FILES    := deps-$(TARGET_ARCH_ABI)/shaderc/libshaderc/libshaderc_combined.a
+include $(PREBUILT_STATIC_LIBRARY)
+include $(CLEAR_VARS)
+
+
+# libsquish
+LOCAL_MODULE       := libsquish
+LOCAL_SRC_FILES    := deps-$(TARGET_ARCH_ABI)/libsquish/libsquish.a
+include $(PREBUILT_STATIC_LIBRARY)
+include $(CLEAR_VARS)
+
+
+# astc-encoder
+LOCAL_MODULE       := libastcenc
+LOCAL_SRC_FILES    := deps-$(TARGET_ARCH_ABI)/astc-encoder/Source/libastcenc.a
+include $(PREBUILT_STATIC_LIBRARY)
+include $(CLEAR_VARS)
+
+
 # ifaddrs
 LOCAL_MODULE    := ifaddrs
 LOCAL_PATH      := .
@@ -153,7 +174,8 @@ LOCAL_MODULE       := graphics_utils
 LOCAL_PATH         := .
 LOCAL_CPP_FEATURES += rtti
 LOCAL_SRC_FILES    := $(wildcard ../lib/graphics_utils/mipmap/*.c)
-LOCAL_CFLAGS       := -I../lib/graphics_utils/mipmap
+LOCAL_CFLAGS       := -I../lib/graphics_utils/mipmap \
+                      -I../lib/simd_wrapper
 ifeq ($(TARGET_ARCH_ABI), armeabi-v7a)
 LOCAL_ARM_NEON     := false
 endif
@@ -167,12 +189,19 @@ LOCAL_PATH         := .
 LOCAL_CPP_FEATURES += rtti exceptions
 LOCAL_SRC_FILES    := $(wildcard ../lib/graphics_engine/src/*.c) \
                       $(wildcard ../lib/graphics_engine/src/*.cpp)
-LOCAL_CFLAGS       := -I../lib/graphics_engine/include \
-                      -I../lib/sdl2/include/           \
-                      -I../lib/irrlicht/include/
+LOCAL_CFLAGS       := -DENABLE_LIBASTCENC                 \
+                      -I../lib/graphics_engine/include    \
+                      -I../lib/graphics_utils             \
+                      -I../lib/sdl2/include/              \
+                      -I../lib/bullet/src/                \
+                      -I../lib/irrlicht/include/          \
+                      -I../lib/shaderc/libshaderc/include \
+                      -I../lib/libsquish                  \
+                      -Ideps-$(TARGET_ARCH_ABI)/astc-encoder/Source
 ifeq ($(TARGET_ARCH_ABI), armeabi-v7a)
 LOCAL_ARM_NEON     := false
 endif
+LOCAL_STATIC_LIBRARIES := shaderc libsquish libastcenc
 include $(BUILD_STATIC_LIBRARY)
 include $(CLEAR_VARS)
 

android/build.gradle

@@ -98,6 +98,17 @@ android
                     cppFlags '-O0'
                 }
             }
+            ndk
+            {
+                if (project.getProperty('compile_arch') == 'all')
+                {
+                    abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
+                }
+                else
+                {
+                    abiFilters project.getProperty('compile_arch')
+                }
+            }
         }
 
         release
@@ -111,6 +122,17 @@ android
                 }
             }
             signingConfig signingConfigs.release
+            ndk
+            {
+                if (project.getProperty('compile_arch') == 'all')
+                {
+                    abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
+                }
+                else
+                {
+                    abiFilters project.getProperty('compile_arch')
+                }
+            }
         }
     }
 
@@ -119,7 +141,6 @@ android
         main
         {
             manifest.srcFile 'AndroidManifest.xml'
-            jniLibs.srcDirs = ['libs']
             res.srcDirs = ['res']
             assets.srcDirs = ['assets']
         }