Merge pull request #47 from apple1417/master

apple1417 · web-flow · commit e6f6509d5164 · 2025-03-23T17:05:41.000+13:00
various minor misc improvements, linting fixes, containerize linux builds
diff --git a/.clang-tidy b/.clang-tidy
@@ -51,4 +51,6 @@ CheckOptions:
     readability-identifier-naming.NamespaceCase:        lower_case
     readability-identifier-naming.ParameterCase:        lower_case
     readability-identifier-naming.VariableCase:         lower_case
+
+    readability-identifier-length.IgnoredVariableNames: _
 ---
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "git@github.com:bl-sdk/common_dotfiles.git",
-  "commit": "d03eee713ad436d20033d0598eb88f1529c56ca8",
+  "commit": "cee5c9dbf5b95f57bb636e5138171aa6a4964cf1",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -15,7 +15,8 @@
       "__project_slug": "willow_mod_manager",
       "include_cpp": true,
       "include_py": true,
-      "_template": "git@github.com:bl-sdk/common_dotfiles.git"
+      "_template": "git@github.com:bl-sdk/common_dotfiles.git",
+      "_commit": "cee5c9dbf5b95f57bb636e5138171aa6a4964cf1"
     }
   },
   "directory": null
diff --git a/.devcontainer/.gitignore b/.devcontainer/.gitignore
@@ -0,0 +1,6 @@
+# Ignore any custom folders outside of our predefined ones, to let you create your own
+# One use might be using your own container mapping the install path onto your actual game folder
+*/
+!clang-cross
+!llvm-mingw
+!mingw
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -0,0 +1,65 @@
+FROM alpine:latest AS clang-cross
+CMD ["/bin/bash"]
+RUN <<EOF
+    apk add --no-cache      \
+        bash                \
+        clang               \
+        clang-extra-tools   \
+        cmake               \
+        git                 \
+        lld                 \
+        llvm                \
+        msitools            \
+        ninja               \
+        openssh             \
+        perl                \
+        python3             \
+        py3-requests
+    git clone https://github.com/mstorsjo/msvc-wine.git
+    msvc-wine/vsdownload.py \
+        --accept-license \
+        --dest /win-sdk \
+        Microsoft.VisualStudio.Workload.VCTools \
+        --arch x86 x64
+    msvc-wine/install.sh /win-sdk
+    rm -r msvc-wine
+EOF
+
+# llvm-mingw comes with pre-built ubuntu binaries, so using that
+FROM ubuntu:latest AS llvm-mingw
+CMD ["/bin/bash"]
+RUN <<EOF
+    apt-get update
+    DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC \
+        apt-get install -y      \
+            cmake               \
+            git                 \
+            msitools            \
+            ninja-build         \
+            python-is-python3   \
+            python3             \
+            python3-requests    \
+            wget                \
+            xz-utils
+    wget -nv https://github.com/mstorsjo/llvm-mingw/releases/download/20250114/llvm-mingw-20250114-msvcrt-ubuntu-20.04-x86_64.tar.xz
+    tar -xf llvm-mingw-20250114-msvcrt-ubuntu-20.04-x86_64.tar.xz
+    rm llvm-mingw-20250114-msvcrt-ubuntu-20.04-x86_64.tar.xz
+    mv llvm-mingw-20250114-msvcrt-ubuntu-20.04-x86_64 /llvm-mingw
+EOF
+ENV PATH="/llvm-mingw/bin:$PATH"
+
+FROM alpine:latest AS mingw
+CMD ["/bin/bash"]
+RUN <<EOF
+    apk add --no-cache      \
+        bash                \
+        cmake               \
+        git                 \
+        i686-mingw-w64-gcc  \
+        mingw-w64-gcc       \
+        msitools            \
+        ninja               \
+        openssh             \
+        py3-requests        \
+        python3
+EOF
diff --git a/.devcontainer/clang-cross/devcontainer.json b/.devcontainer/clang-cross/devcontainer.json
@@ -0,0 +1,7 @@
+{
+	"name": "clang-cross",
+	"build": {
+		"dockerfile": "../Dockerfile",
+		"target": "clang-cross"
+	}
+}
diff --git a/.devcontainer/llvm-mingw/devcontainer.json b/.devcontainer/llvm-mingw/devcontainer.json
@@ -0,0 +1,7 @@
+{
+	"name": "llvm-mingw",
+	"build": {
+		"dockerfile": "../Dockerfile",
+		"target": "llvm-mingw"
+	}
+}
diff --git a/.devcontainer/mingw/devcontainer.json b/.devcontainer/mingw/devcontainer.json
@@ -0,0 +1,7 @@
+{
+	"name": "mingw",
+	"build": {
+		"dockerfile": "../Dockerfile",
+		"target": "mingw"
+	}
+}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -54,14 +54,12 @@ jobs:
         submodules: recursive
 
     - name: Configure build
-      working-directory: ${{ env.GITHUB_WORKSPACE }}
       run: |
         pip install requests
 
         cmake . --preset ${{ matrix.preset }} -G Ninja
 
     - name: Build
-      working-directory: ${{ env.GITHUB_WORKSPACE }}
       run: cmake --build out/build/${{ matrix.preset }} --target install
 
     - name: Prepare Release Zip (dev ci)
@@ -82,87 +80,50 @@ jobs:
         path: "*.zip"
 
   build-ubuntu:
-    # Require at least 24 for the mingw build
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        preset:
-        - clang-cross-release
-        - llvm-mingw-release
-        - mingw-release
+        toolchain:
+          - preset: clang-cross-release
+            container: clang-cross
+          - preset: llvm-mingw-release
+            container: llvm-mingw
+          - preset: mingw-release
+            container: mingw
 
     steps:
-    - name: Setup CMake and Ninja
-      uses: lukka/get-cmake@latest
-
-    - name: Setup apt packages
-      uses: awalsh128/cache-apt-pkgs-action@latest
-      with:
-        packages: msitools python3-requests
-        version: ${{ runner.os }}-apt
-
-    - name: Setup LLVM MinGW
-      if: startswith(matrix.preset, 'llvm-mingw')
-      run: |
-        wget -nv ${{ env.LLVM_MINGW_DOWNLOAD }}
-        tar -xf ${{ env.LLVM_MINGW_VERSION }}.tar.xz -C ~/
-        echo $(readlink -f ~/${{ env.LLVM_MINGW_VERSION }}/bin) >> $GITHUB_PATH
-
-    - name: Setup MinGW
-      if: startswith(matrix.preset, 'mingw')
-      uses: egor-tensin/setup-mingw@v2
-      with:
-        platform: ${{ fromJSON('["x86", "x64"]')[contains(matrix.preset, 'x64')] }}
-
-    - name: Setup Clang
-      if: startswith(matrix.preset, 'clang-cross')
-      uses: egor-tensin/setup-clang@v1
-
-    - name: Restore win sdk cache
-      if: startswith(matrix.preset, 'clang-cross')
-      uses: actions/cache@v4
-      id: cache-win-sdk
-      with:
-        path: ~/win-sdk
-        key: ${{ runner.os }}-win-sdk
-
-    - name: Setup win sdk
-      if: startswith(matrix.preset, 'clang-cross') && steps.cache-win-sdk.outputs.cache-hit != 'true'
-      run: |
-        git clone https://github.com/mstorsjo/msvc-wine.git
-        msvc-wine/vsdownload.py --accept-license --dest ~/win-sdk Microsoft.VisualStudio.Workload.VCTools
-        msvc-wine/install.sh ~/win-sdk
-        rm -r msvc-wine
-
     - name: Checkout repository and submodules
       uses: actions/checkout@v4
       with:
         submodules: recursive
 
-    - name: Configure CMake
-      working-directory: ${{ env.GITHUB_WORKSPACE }}
-      # The extra msvc wine arg won't do anything if we're not cross compiling
-      run: >
-        cmake .
-        --preset ${{ matrix.preset }}
-        -G Ninja
-        -DMSVC_WINE_ENV_SCRIPT=$(readlink -f ~)/win-sdk/bin/${{ fromJSON('["x86", "x64"]')[contains(matrix.preset, 'x64')] }}/msvcenv.sh
-
     - name: Build
-      working-directory: ${{ env.GITHUB_WORKSPACE }}
-      run: cmake --build out/build/${{ matrix.preset }} --target install
-
-    - name: Prepare Release Zip (dev ci)
-      if: inputs.new-release-tag == ''
-      run: python prepare_release.py ${{ matrix.preset }} --skip-install
+      uses: devcontainers/ci@v0.3
+      with:
+        cacheFrom: ghcr.io/bl-sdk/${{ matrix.toolchain.container }}:latest
+        configFile: .devcontainer/${{ matrix.toolchain.container }}/devcontainer.json
+        push: never
+        # The git watcher cmake thinks something's unsafe? Doesn't happen to me locally.
+        # Only run the prepare release script if doing a dev ci build
+        runCmd: |
+          git config --global --add safe.directory `pwd`
+          git config --global --add safe.directory `pwd`/libs/pluginloader
+          git config --global --add safe.directory `pwd`/libs/pyunrealsdk
+          git config --global --add safe.directory `pwd`/libs/pyunrealsdk/libs/unrealsdk
+
+          cmake . --preset ${{ matrix.toolchain.preset }} -G Ninja
+          cmake --build out/build/${{ matrix.toolchain.preset }}  --target install
+
+          [ ${{ inputs.new-release-tag == '' && 1 || 0 }} -ne 0 ] && \
+            python prepare_release.py ${{ matrix.toolchain.preset }} --skip-install
 
     - name: Upload Artifact
       if: inputs.new-release-tag == ''
       uses: actions/upload-artifact@v4
       with:
-        name: ${{ matrix.preset }}
+        name: ${{ matrix.toolchain.preset }}
         path: "*.zip"
 
 # ==============================================================================
@@ -200,7 +161,6 @@ jobs:
         submodules: recursive
 
     - name: Configure CMake
-      working-directory: ${{ env.GITHUB_WORKSPACE }}
       run: cmake . --preset ${{ matrix.preset }} -DCMAKE_DISABLE_PRECOMPILE_HEADERS=On
 
     - name: Remove `.modmap`s from compile commands
@@ -211,7 +171,6 @@ jobs:
           -Path "out\build\${{ matrix.preset }}\compile_commands.json"
 
     - name: Run clang-tidy
-      working-directory: ${{ env.GITHUB_WORKSPACE }}
       run: |
         python (Get-Command run-clang-tidy).Source                              `
           -p "out\build\${{ matrix.preset }}"                                   `
@@ -228,7 +187,6 @@ jobs:
 
     steps:
     - name: Setup Clang
-      if: startswith(matrix.preset, 'clang')
       uses: egor-tensin/setup-clang@v1
 
     - name: Checkout repository
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 .vs
 .vscode
+.idea
 
 # C/C++ excludes
 .cache/clangd
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -30,6 +30,9 @@
         "lhs": "${hostSystemName}",
         "rhs": "Windows"
       },
+      "environment": {
+        "MSVC_WINE_ENV_SCRIPT": "/win-sdk/bin/x86/msvcenv.sh"
+      },
       "toolchainFile": "libs/pyunrealsdk/common_cmake/clang-cross-x86.cmake"
     },
     {
diff --git a/Readme.md b/Readme.md
@@ -35,7 +35,18 @@ Once you've done this, you can modify the python files in place.
 
 ## Native code
 The mod manager currently doesn't rely on any native modules. You may however still want to
-edit/debug the base pyunrealsdk code while working on this project. To do this:
+edit/debug the base pyunrealsdk code while working on this project. The sdk supports five different
+toolchains:
+
+- MSVC
+- Clang (Windows)
+- Clang (Cross Compile) <sup>*</sup>
+- MinGW <sup>*</sup>
+- LLVM MinGW <sup>*</sup>
+
+The toolchains with an asterix are all cross compiling toolchains. These all also have an associated
+dev container, which is the recommended way of building them. The `clang-cross-*` presets in
+particular hardcode a path assuming they're running in the container.
 
 1. Initialize the git submodules.
    ```sh
@@ -53,16 +64,13 @@ edit/debug the base pyunrealsdk code while working on this project. To do this:
    python -c 'import requests'
    ```
 
-   If not running on Windows, make sure `msiextract` is also on your PATH. This is typically part
-   of an `msitools` package.
+   If cross compiling, and not using one of the dev containers, make sure `msiextract` is also on
+   your PATH. This is typically part of an `msitools` package.
    ```sh
    apt install msitools # Or equivalent
    msiextract --version 
    ```
 
-   See the explicit python [readme](https://github.com/bl-sdk/common_cmake/blob/master/explicit_python/Readme.md)
-   for a few extra details.
-
 3. Choose a preset, and run CMake. Most IDEs will be able to do this for you,
    ```
    cmake . --preset msvc-debug
diff --git a/changelog.md b/changelog.md
@@ -1,6 +1,8 @@
 # Changelog
 
 ## v3.5 (Upcoming)
+- `.sdkmod`s are now migrated from the legacy mod folder, in case someone tried installing them
+  before upgrading.
 
 ### Legacy Compat v1.4
 - Added more fixups for previously unreported issues in Gear Randomizer, Loot Randomizer, Player
@@ -10,6 +12,12 @@
 - Fixed that some keybinds would not be displayed properly if there were two separate grouped/nested
   options at the same level.
 
+- Added support for the "Host Only" coop support value.
+
+- Now prints a (dev) warning when trying to use a SliderOption with non-integer values, or with a
+  step that doesn't evenly divide it's values. Neither of these cases are properly supported by the
+  engine, both may have weird, unexpected, behaviour.
+
 ## v3.4: Luck Cannon
 
 ### Legacy Compat v1.3
diff --git a/libs/pyunrealsdk b/libs/pyunrealsdk
@@ -1 +1 @@
-Subproject commit a0d8fdb4e1e17a58eb311987ed589b21d9ff0ab1
+Subproject commit 17e5780f12584aba943270af205a3ac07f525bb9
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/src/__main__.py b/src/__main__.py
diff --git a/src/console_mod_menu b/src/console_mod_menu
diff --git a/src/mods_base b/src/mods_base
diff --git a/src/willow2_mod_menu/data_providers/options.py b/src/willow2_mod_menu/data_providers/options.py
diff --git a/src/willow2_mod_menu/description.py b/src/willow2_mod_menu/description.py

-Original file line number
+Diff line change
@@ @@ -1,5 +1,6 @@ @@
 .vs
 .vscode
 +.idea
 # C/C++ excludes
 .cache/clangd