Switch from osu-framework submodule to winnerspiros NuGet packages (v2026.420.3)

Replace ProjectReference to submodule with PackageReference to
ppy.osu.Framework/Android/iOS v2026.420.3 from GitHub Packages.

- Add winnerspiros GitHub Packages NuGet source to NuGet.Config
- Add GitHub Packages authentication to all CI/release/deploy workflows
- Remove git submodule, .gitmodules, local-packages/
- Remove submodule projects from osu.sln and all .slnf filters
- Remove SuppressSubmoduleWarnings.targets and Veldrid.SPIRV override
- Clean up submodule-specific items in Android/iOS props
- Add packages:read permission to workflows

Agent-Logs-Url: https://github.com/winnerspiros/osu/sessions/bcb0923f-4d2a-490f-926c-cc48ab950edd

Co-authored-by: winnerspiros <1675249+winnerspiros@users.noreply.github.com>

Author: Copilot

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ concurrency:
 
 permissions:
   contents: read # to fetch code (actions/checkout)
+  packages: read # to restore NuGet packages from GitHub Packages
   security-events: write # for reporting InspectCode issues
 
 jobs:
@@ -16,7 +17,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Install .NET 10.0.x
@@ -31,6 +31,9 @@ jobs:
           key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/*.props') }}
           restore-keys: ${{ runner.os }}-nuget-
 
+      - name: Authenticate to GitHub Packages
+        run: dotnet nuget update source winnerspiros-github --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text
+
       - name: Restore Tools
         run: dotnet tool restore
 
@@ -53,10 +56,6 @@ jobs:
           exit_code=0
           while read -r line; do
             if [[ ! -z "$line" ]]; then
-              # Skip submodule files — third-party code doesn't use our license header
-              if [[ "$line" == *"./submodules/"* ]]; then
-                continue
-              fi
               echo "::error::$line"
               exit_code=1
             fi
@@ -93,7 +92,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Install .NET 10.0.x
@@ -108,6 +106,9 @@ jobs:
           key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/*.props') }}
           restore-keys: ${{ runner.os }}-nuget-
 
+      - name: Authenticate to GitHub Packages
+        run: dotnet nuget update source winnerspiros-github --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text
+
       - name: Compile
         run: dotnet build -c Debug -warnaserror osu.Desktop.slnf
 
@@ -171,7 +172,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Setup JDK 11
@@ -192,6 +192,9 @@ jobs:
           key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/*.props') }}
           restore-keys: ${{ runner.os }}-nuget-
 
+      - name: Authenticate to GitHub Packages
+        run: dotnet nuget update source winnerspiros-github --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text
+
       - name: Install .NET workloads
         run: dotnet workload install android
 
@@ -206,7 +209,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Install .NET 10.0.x
@@ -221,6 +223,9 @@ jobs:
           key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/*.props') }}
           restore-keys: ${{ runner.os }}-nuget-
 
+      - name: Authenticate to GitHub Packages
+        run: dotnet nuget update source winnerspiros-github --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text
+
       - name: Set Xcode version
         run: sudo xcode-select -s /Applications/Xcode_26.3.app
 

.github/workflows/deploy.yml

@@ -42,6 +42,9 @@ jobs:
     name: Pack
     runs-on: ubuntu-latest
     environment: production
+    permissions:
+      contents: read
+      packages: read
     steps:
       - name: Checkout
         uses: actions/checkout@v6
@@ -55,6 +58,9 @@ jobs:
         with:
           dotnet-version: "10.0.x"
 
+      - name: Authenticate to GitHub Packages
+        run: dotnet nuget update source winnerspiros-github --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text
+
       - name: Pack
         run: |
           # Replace project references in templates with package reference, because they're included as source files.

.github/workflows/release.yml

@@ -40,11 +40,11 @@ jobs:
     timeout-minutes: 60
     permissions:
       contents: write
+      packages: read
     steps:
       - name: Checkout
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Setup JDK 17
@@ -61,6 +61,9 @@ jobs:
       - name: Install .NET Android workload
         run: dotnet workload install android
 
+      - name: Authenticate to GitHub Packages
+        run: dotnet nuget update source winnerspiros-github --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text
+
       - name: Ensure Android NDK and CMake are available
         run: |
           # The ubuntu-latest runner has $ANDROID_HOME pre-installed.
@@ -215,7 +218,6 @@ jobs:
           -p:AndroidSigningKeyAlias="${{ steps.keystore.outputs.key_alias }}"
           -p:AndroidSigningKeyPass="${{ steps.keystore.outputs.key_pass }}"
           -p:AndroidSigningStorePass="${{ steps.keystore.outputs.store_pass }}"
-          -p:CustomBeforeMicrosoftCommonTargets="${{ github.workspace }}/build/SuppressSubmoduleWarnings.targets"
 
       - name: Find and rename APK
         id: find_apk
@@ -256,7 +258,6 @@ jobs:
       - name: Verify native libraries in APK
         run: |
           APK="${{ steps.find_apk.outputs.apk_path }}"
-          SUBMOD="submodules/osu-framework/osu.Framework.Android/arm64-v8a"
           echo "Checking APK for required native libraries..."
 
           NATIVE_LIBS=$(unzip -l "$APK" | grep "lib/arm64-v8a/.*\.so" || true)
@@ -275,31 +276,13 @@ jobs:
 
           if [ "$MISSING" -ne 0 ]; then
             echo ""
-            echo "::error::One or more required native libraries are missing. Check that the osu-framework submodule is initialised and the AndroidNativeLibrary glob in osu.Android.props resolves correctly."
+            echo "::error::One or more required native libraries are missing."
             exit 1
           fi
 
           echo ""
           echo "All required native libraries present ✓"
 
-          # Verify the BASS libraries are the Android-built versions, not the Linux desktop
-          # ones from the NativeLibs NuGet package.  The Android libbass.so links against
-          # libOpenSLES.so (Android audio API); the Linux one links against libc.so.6.
-          echo ""
-          echo "Verifying native library ABI compatibility..."
-          TMPDIR=$(mktemp -d)
-          unzip -q -o "$APK" "lib/arm64-v8a/libbass.so" -d "$TMPDIR"
-          if readelf -d "$TMPDIR/lib/arm64-v8a/libbass.so" | grep -q "libOpenSLES.so"; then
-            echo "✅ libbass.so is the correct Android build (links libOpenSLES.so)"
-          else
-            echo "::error::libbass.so in APK is NOT the Android build — it appears to be the Linux desktop version from ppy.osu.Framework.NativeLibs NuGet. The app will crash with DllNotFoundException."
-            echo "::error::Ensure ppy.osu.Framework.NativeLibs has ExcludeAssets=native in osu.Android.props."
-            readelf -d "$TMPDIR/lib/arm64-v8a/libbass.so" | grep NEEDED || true
-            rm -rf "$TMPDIR"
-            exit 1
-          fi
-          rm -rf "$TMPDIR"
-
       - name: Upload APK artifact
         uses: actions/upload-artifact@v7
         with:

.gitmodules

@@ -7,11 +7,6 @@
     <GenerateAssemblyInfo Condition="'$(Configuration)'=='Debug'">false</GenerateAssemblyInfo>
     <!-- Required due to the above  -->
     <NoWarn Condition="'$(Configuration)'=='Debug'">$(NoWarn);CA1416</NoWarn>
-    <!-- NU1605: Suppress package downgrade error for ppy.Veldrid.SPIRV.
-         We intentionally override the framework's 1.0.15-gfbb03d21c2 with the fork's
-         1.0.15-gb268bf39ea. NuGet considers this a "downgrade" because 'b' < 'f' in
-         prerelease suffix comparison, but it's actually a newer fork build. -->
-    <NoWarn>$(NoWarn);NU1605</NoWarn>
   </PropertyGroup>
   <PropertyGroup>
     <ApplicationManifest>$(MSBuildThisFileDirectory)app.manifest</ApplicationManifest>
@@ -24,16 +19,6 @@
   <ItemGroup Label="Resources">
     <EmbeddedResource Include="Resources\**\*.*" />
   </ItemGroup>
-  <!-- Override ppy.Veldrid.SPIRV with winnerspiros/veldrid-spirv fork for ALL projects.
-       The fork (1.0.15-gb268bf39ea) is API-compatible and includes:
-       - 16KB ELF-aligned Android .so (no PatchElfPageSize workaround needed)
-       - Modern runtimes/android-arm64/native/ NuGet layout (no MonoAndroid10 workarounds)
-       - CompileCompute interop bug fix, debug flag passthrough, error diagnostics
-       The .nupkg is in local-packages/ (see NuGet.Config).
-       This overrides the framework's transitive reference to 1.0.15-gfbb03d21c2. -->
-  <ItemGroup Label="Veldrid.SPIRV Override">
-    <PackageReference Include="ppy.Veldrid.SPIRV" Version="1.0.15-gb268bf39ea" />
-  </ItemGroup>
   <ItemGroup Label="Code Analysis">
     <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4" PrivateAssets="All" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)CodeAnalysis\BannedSymbols.txt" />

Directory.Build.props

@@ -2,9 +2,8 @@
 <configuration>
   <packageSources>
     <clear />
-    <!-- winnerspiros/veldrid-spirv fork NuGet package (included in local-packages/).
-         Source: https://github.com/winnerspiros/veldrid-spirv/releases -->
-    <add key="local-packages" value="local-packages" />
+    <!-- winnerspiros/osu-framework fork NuGet packages (published to GitHub Packages) -->
+    <add key="winnerspiros-github" value="https://nuget.pkg.github.com/winnerspiros/index.json" />
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
   </packageSources>
 </configuration>

NuGet.Config

@@ -69,41 +69,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <!-- Use winnerspiros/osu-framework fork (net10.0-android, optimized) via submodule instead of ppy NuGet package -->
-    <ProjectReference Include="$(MSBuildThisFileDirectory)submodules/osu-framework/osu.Framework.Android/osu.Framework.Android.csproj" />
-
-    <!-- Suppress native assets from the desktop NativeLibs NuGet package.
-         ppy.osu.Framework.NativeLibs (transitive via osu.Framework.csproj) ships
-         runtimes/linux-arm64/native/libbass.so and friends built for GNU/Linux (they link
-         libc.so.6, libpthread.so.0, etc.).  The .NET RID fallback chain for android-arm64
-         (android-arm64 → android → unix → any) causes the Linux ARM64 .so files to leak
-         into the APK even though the NuGet has an android/native/_._  placeholder.
-         The result: the APK ends up with a Linux libbass.so that cannot load on Android
-         (DllNotFoundException at startup).
-         ExcludeAssets="native" prevents NuGet from contributing any .so files;
-         the correct Android-built libraries are supplied by AndroidNativeLibrary below. -->
-    <PackageReference Include="ppy.osu.Framework.NativeLibs" Version="2025.806.0-nativelibs" ExcludeAssets="native" PrivateAssets="all" />
-  </ItemGroup>
-
-  <!-- Include framework native libraries (BASS audio, FFmpeg, etc.) from the submodule.
-       When using a NuGet package these are bundled automatically; with a ProjectReference
-       they must be declared explicitly or the app crashes at startup with
-       System.DllNotFoundException: bass (or similar).
-       Use forward slashes — backslash globs silently match zero files on Linux CI runners,
-       which produces an APK without libbass.so (and the other native libs). -->
-  <ItemGroup>
-    <AndroidNativeLibrary Include="$(MSBuildThisFileDirectory)submodules/osu-framework/osu.Framework.Android/arm64-v8a/*.so" Abi="arm64-v8a" />
+    <PackageReference Include="ppy.osu.Framework.Android" Version="2026.420.3" />
   </ItemGroup>
 
-  <!-- Fail the build early if critical native libraries are missing.
-       A missing .so means the app will crash on startup with DllNotFoundException.
-       This catches silent glob failures (e.g. uninitialised submodule, wrong path)
-       and NuGet restore failures for Veldrid.SPIRV. -->
-  <Target Name="ValidateFrameworkNativeLibraries" BeforeTargets="Build">
-    <Error Condition="!Exists('$(MSBuildThisFileDirectory)submodules/osu-framework/osu.Framework.Android/arm64-v8a/libbass.so')"
-           Text="libbass.so not found in submodules/osu-framework/osu.Framework.Android/arm64-v8a/. Ensure the osu-framework submodule is initialised: git submodule update --init --recursive" />
-  </Target>
-
   <PropertyGroup>
     <!-- Fody does not handle Android build well, and warns when unchanged.
          Since Realm objects are not declared directly in Android projects, simply disable Fody. -->